You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/Tooling.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,8 @@ pnpm run build --watch
83
83
### Formatting
84
84
85
85
[**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.
87
88
88
89
Auto-formatting all files:
89
90
@@ -123,18 +124,17 @@ pnpm run install
123
124
124
125
In code, assorted repository documentation files for GitHub are created:
125
126
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)
-[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)
[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.
133
133
134
134
On the GitHub repository, metadata will be populated:
135
135
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)
138
138
139
139
### Type Checking
140
140
@@ -194,16 +194,16 @@ pnpm run lint:knip
194
194
Additionally:
195
195
196
196
-[`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
199
199
200
200
Running tests in watch mode:
201
201
202
202
```shell
203
203
pnpm run test
204
204
```
205
205
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):
0 commit comments