Skip to content

Commit a350a93

Browse files
fix: generalize DEVELOPMENT.md lint files description (#2367)
## PR Checklist - [x] Addresses an existing open issue: fixes #2366 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview 🎁
1 parent 3700be9 commit a350a93

3 files changed

Lines changed: 14 additions & 14 deletions

File tree

.github/DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pnpm format --write
5050
This package includes several forms of linting to enforce consistent code quality and styling.
5151
Each should be shown in VS Code, and can be run manually on the command-line:
5252

53-
- `pnpm lint` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files
53+
- `pnpm lint` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript
5454
- `pnpm lint:knip` ([knip](https://github.com/webpro/knip)): Detects unused files, dependencies, and code exports
5555
- `pnpm lint:packages` ([pnpm dedupe --check](https://pnpm.io/cli/dedupe)): Checks for unnecessarily duplicated packages in the `pnpm-lock.yaml` file
5656
- `pnpm lint:spelling` ([cspell](https://cspell.org)): Spell checks across all source files

src/blocks/blockESLint.test.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ describe("blockESLint", () => {
4242
Each should be shown in VS Code, and can be run manually on the command-line:
4343
",
4444
"items": [
45-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
45+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
4646
],
4747
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
4848
},
@@ -163,7 +163,7 @@ describe("blockESLint", () => {
163163
Each should be shown in VS Code, and can be run manually on the command-line:
164164
",
165165
"items": [
166-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
166+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
167167
],
168168
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
169169
},
@@ -320,7 +320,7 @@ describe("blockESLint", () => {
320320
Each should be shown in VS Code, and can be run manually on the command-line:
321321
",
322322
"items": [
323-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
323+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
324324
],
325325
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
326326
},
@@ -510,7 +510,7 @@ describe("blockESLint", () => {
510510
Each should be shown in VS Code, and can be run manually on the command-line:
511511
",
512512
"items": [
513-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
513+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
514514
],
515515
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
516516
},
@@ -681,7 +681,7 @@ describe("blockESLint", () => {
681681
Each should be shown in VS Code, and can be run manually on the command-line:
682682
",
683683
"items": [
684-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
684+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
685685
],
686686
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
687687
},
@@ -828,7 +828,7 @@ describe("blockESLint", () => {
828828
Each should be shown in VS Code, and can be run manually on the command-line:
829829
",
830830
"items": [
831-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
831+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
832832
],
833833
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
834834
},
@@ -988,7 +988,7 @@ describe("blockESLint", () => {
988988
Each should be shown in VS Code, and can be run manually on the command-line:
989989
",
990990
"items": [
991-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
991+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
992992
],
993993
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
994994
},
@@ -1136,7 +1136,7 @@ describe("blockESLint", () => {
11361136
Each should be shown in VS Code, and can be run manually on the command-line:
11371137
",
11381138
"items": [
1139-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
1139+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
11401140
],
11411141
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
11421142
},
@@ -1259,7 +1259,7 @@ describe("blockESLint", () => {
12591259
Each should be shown in VS Code, and can be run manually on the command-line:
12601260
",
12611261
"items": [
1262-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
1262+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
12631263
],
12641264
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
12651265
},
@@ -1385,7 +1385,7 @@ describe("blockESLint", () => {
13851385
Each should be shown in VS Code, and can be run manually on the command-line:
13861386
",
13871387
"items": [
1388-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
1388+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
13891389
],
13901390
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
13911391
},
@@ -1511,7 +1511,7 @@ describe("blockESLint", () => {
15111511
Each should be shown in VS Code, and can be run manually on the command-line:
15121512
",
15131513
"items": [
1514-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
1514+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
15151515
],
15161516
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
15171517
},
@@ -1634,7 +1634,7 @@ describe("blockESLint", () => {
16341634
Each should be shown in VS Code, and can be run manually on the command-line:
16351635
",
16361636
"items": [
1637-
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files",
1637+
"- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript",
16381638
],
16391639
"plural": "Read the individual documentation for each linter to understand how it can be configured and used best.",
16401640
},

src/blocks/blockESLint.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ This package includes several forms of linting to enforce consistent code qualit
146146
Each should be shown in VS Code, and can be run manually on the command-line:
147147
`,
148148
items: [
149-
`- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints JavaScript and TypeScript source files`,
149+
`- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript`,
150150
],
151151
plural: `Read the individual documentation for each linter to understand how it can be configured and used best.`,
152152
},

0 commit comments

Comments
 (0)