Skip to content

Commit ebde1d9

Browse files
docs: fill out missing commit of docs
1 parent dd69dd5 commit ebde1d9

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

docs/FAQs.md

+12
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,15 @@ This repository is meant to serve as a starter that includes all the general too
5151
Each of the included tools exists for a good reason and provides real value.
5252

5353
If you don't want to use any particular tool, you can always remove it manually.
54+
55+
### What tooling does this package use that isn't part of created repositories?
56+
57+
Glad you asked!
58+
These are the projects used across many parts of `create-typescript-app`:
59+
60+
- [Chalk](https://github.com/chalk/chalk): Makes it easier to print colored characters in the terminal.
61+
- [Clack](https://www.clack.cc): Provides interactive terminal prompts and loading spinners.
62+
- [execa](https://github.com/sindresorhus/execa): Makes it easier to run child processes.
63+
- [Octokit](https://github.com/octokit/octokit.js#octokitjs):
64+
- [tsx](https://github.com/esbuild-kit/tsx): Quickly runs TypeScript files with ESBuild.
65+
- [Zod](https://zod.dev): TypeScript-first schema validation with static type inference.

docs/Tooling.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ pnpm run build --watch
8383
### Formatting
8484

8585
[**Prettier**](https://prettier.io): Formats code for developers and enforces a consistent formatting style.
86-
It's run on file save per [VS Code](TODO) settings and as a Git commit hook via [husky](https://typicode.github.io/husky) and [lint-staged](https://github.com/okonet/lint-staged).
86+
It's run on file save per [VS Code](https://code.visualstudio.com/docs/getstarted/settings) settings and as a Git commit hook via [husky](https://typicode.github.io/husky) and [lint-staged](https://github.com/okonet/lint-staged).
87+
[prettier-plugin-curly](https://github.com/JoshuaKGoldberg/prettier-plugin-curly) and [prettier-plugin-packagejson](https://github.com/matzkoh/prettier-plugin-packagejson) add in more formatting as well.
8788

8889
Auto-formatting all files:
8990

@@ -123,18 +124,17 @@ pnpm run install
123124

124125
In code, assorted repository documentation files for GitHub are created:
125126

126-
- [Code of conduct](TODO)
127-
- [Contributing guide](TODO)
128-
- [Issue templates](TODO)
129-
- [PR template](TODO)
130-
- [Security policy](TODO)
127+
- [Code of conduct](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
128+
- [Contributing guide](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
129+
- [Issue and PR templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)
130+
- [Security policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)
131131

132-
[GitHub Actions workflows](TODO) are added for each of the enabled tooling pieces to run them in CI.
132+
[GitHub Actions workflows](https://github.com/features/actions) are added for each of the enabled tooling pieces to run them in CI.
133133

134134
On the GitHub repository, metadata will be populated:
135135

136-
- [Issue labels](TODO) for issue areas, statuses, and types.
137-
- [Repository settings](TODO) such as [branch protections](TODO) and [squash merging PRs](TODO)
136+
- [Issue labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) for issue areas, statuses, and types.
137+
- [Repository settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features) such as [branch protections](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) and [squash merging PRs](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges)
138138

139139
### Type Checking
140140

@@ -194,16 +194,16 @@ pnpm run lint:knip
194194
Additionally:
195195

196196
- [`console-fail-test`](https://github.com/JoshuaKGoldberg/console-fail-test) will also be added to ensure tests don't accidentally log to the console.
197-
- [`eslint-plugin-no-only-tests`](TODO) will be added to the ESLint config to ensure calls to `it.only` or similar are not checked in
198-
- [`eslint-plugin-vitest`](TODO) will be added to the ESLint config to lint for Vitest-specific issues
197+
- [`eslint-plugin-no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests) will be added to the ESLint config to ensure calls to `it.only` or similar are not checked in
198+
- [`eslint-plugin-vitest`](https://github.com/veritem/eslint-plugin-vitest) will be added to the ESLint config to lint for Vitest-specific issues
199199

200200
Running tests in watch mode:
201201

202202
```shell
203203
pnpm run test
204204
```
205205

206-
Running tests in watch mode and auto-updating [Vitest snapshots](TODO):
206+
Running tests in watch mode and auto-updating [Vitest snapshots](https://vitest.dev/guide/snapshot.html):
207207

208208
```shell
209209
pnpm run test -u

0 commit comments

Comments
 (0)