Skip to content

Commit 8bcd8f6

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
feat: pre-fill cspell.json words (#1734)
## PR Checklist - [x] Addresses an existing open issue: fixes #1716; fixes #1737 - [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 Removes the `populateCSpellDictionary` call from _creation_. It was already not in _initialization_. 💖
1 parent 9f14f47 commit 8bcd8f6

8 files changed

+119
-60
lines changed

‎cspell.json

+6-13
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,28 @@
11
{
2-
"dictionaries": ["typescript"],
2+
"dictionaries": ["npm", "node", "typescript"],
33
"ignorePaths": [
4-
"./coverage*",
5-
"./script/__snapshots__",
64
".all-contributorsrc",
75
".github",
86
"CHANGELOG.md",
7+
"coverage*",
98
"lib",
109
"node_modules",
11-
"pnpm-lock.yaml"
10+
"pnpm-lock.yaml",
11+
"script/__snapshots__"
1212
],
1313
"words": [
1414
"allcontributors",
1515
"apexskier",
1616
"arethetypeswrong",
1717
"automerge",
18-
"codecov",
1918
"codespace",
20-
"contributorsrc",
2119
"execa",
2220
"infile",
23-
"knip",
21+
"joshuakgoldberg",
2422
"markdownlintignore",
2523
"mtfoley",
26-
"npmignore",
27-
"npmpackagejsonlintrc",
2824
"outro",
29-
"packagejson",
3025
"tada",
31-
"tseslint",
32-
"tsup",
33-
"vitest"
26+
"tseslint"
3427
]
3528
}

‎script/__snapshots__/migrate-test-e2e.ts.snap

+13-19
Original file line numberDiff line numberDiff line change
@@ -105,39 +105,33 @@ exports[`expected file changes > cspell.json 1`] = `
105105
"--- a/cspell.json
106106
+++ b/cspell.json
107107
@@ ... @@
108-
{
109-
"dictionaries": ["typescript"],
110-
"ignorePaths": [
111-
- "./coverage*",
112-
- "./script/__snapshots__",
113108
".all-contributorsrc",
114109
".github",
115110
"CHANGELOG.md",
111+
- "coverage*",
116112
+ "coverage",
117113
"lib",
118114
"node_modules",
119-
"pnpm-lock.yaml"
115+
- "pnpm-lock.yaml",
116+
- "script/__snapshots__"
117+
+ "pnpm-lock.yaml"
118+
],
119+
"words": [
120+
"allcontributors",
120121
@@ ... @@
121-
"apexskier",
122122
"arethetypeswrong",
123123
"automerge",
124-
- "codecov",
125124
"codespace",
126-
"contributorsrc",
127-
"execa",
125+
- "execa",
126+
+ "contributorsrc",
128127
"infile",
129-
+ "joshuakgoldberg",
130-
"knip",
131-
+ "markdownlint",
128+
"joshuakgoldberg",
132129
"markdownlintignore",
133130
"mtfoley",
134-
"npmignore",
135-
@@ ... @@
131+
"outro",
136132
"tada",
137-
"tseslint",
138-
"tsup",
139-
- "vitest"
140-
+ "vitest",
133+
- "tseslint"
134+
+ "tseslint",
141135
+ "wontfix"
142136
]
143137
}"

‎src/create/createWithOptions.test.ts

+2-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import { Options } from "../shared/types.js";
77
import { addToolAllContributors } from "../steps/addToolAllContributors.js";
88
import { finalizeDependencies } from "../steps/finalizeDependencies.js";
99
import { initializeGitHubRepository } from "../steps/initializeGitHubRepository/index.js";
10-
import { populateCSpellDictionary } from "../steps/populateCSpellDictionary.js";
1110
import { runCleanup } from "../steps/runCleanup.js";
1211
import { createWithOptions } from "./createWithOptions.js";
1312

@@ -61,8 +60,6 @@ vi.mock("../steps/writeReadme/index.js");
6160

6261
vi.mock("../steps/finalizeDependencies.js");
6362

64-
vi.mock("../steps/populateCSpellDictionary.js");
65-
6663
vi.mock("../steps/clearLocalGitTags.js");
6764

6865
vi.mock("../steps/runCleanup.js");
@@ -119,19 +116,18 @@ describe("createWithOptions", () => {
119116
expect(addToolAllContributors).not.toHaveBeenCalled();
120117
});
121118

122-
it("does not call finalizeDependencies, populateCSpellDictionary, or runCleanup when skipInstall is true", async () => {
119+
it("does not call finalizeDependencies or runCleanup when skipInstall is true", async () => {
123120
const options = {
124121
...optionsBase,
125122
skipInstall: true,
126123
};
127124

128125
await createWithOptions({ github, options });
129126
expect(finalizeDependencies).not.toHaveBeenCalled();
130-
expect(populateCSpellDictionary).not.toHaveBeenCalled();
131127
expect(runCleanup).not.toHaveBeenCalled();
132128
});
133129

134-
it("calls finalizeDependencies, populateCSpellDictionary, and runCleanup when skipInstall is false", async () => {
130+
it("calls finalizeDependencies and runCleanup when skipInstall is false", async () => {
135131
const options = {
136132
...optionsBase,
137133
skipInstall: false,
@@ -140,7 +136,6 @@ describe("createWithOptions", () => {
140136
await createWithOptions({ github, options });
141137

142138
expect(finalizeDependencies).toHaveBeenCalledWith(options);
143-
expect(populateCSpellDictionary).toHaveBeenCalled();
144139
expect(runCleanup).toHaveBeenCalled();
145140
});
146141

‎src/create/createWithOptions.ts

-8
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import { addToolAllContributors } from "../steps/addToolAllContributors.js";
88
import { clearLocalGitTags } from "../steps/clearLocalGitTags.js";
99
import { finalizeDependencies } from "../steps/finalizeDependencies.js";
1010
import { initializeGitHubRepository } from "../steps/initializeGitHubRepository/index.js";
11-
import { populateCSpellDictionary } from "../steps/populateCSpellDictionary.js";
1211
import { runCleanup } from "../steps/runCleanup.js";
1312
import { writeReadme } from "../steps/writeReadme/index.js";
1413
import { writeStructure } from "../steps/writing/writeStructure.js";
@@ -40,13 +39,6 @@ export async function createWithOptions({ github, options }: GitHubAndOptions) {
4039
finalizeDependencies(options),
4140
);
4241

43-
if (!options.excludeLintSpelling) {
44-
await withSpinner(
45-
"Populating CSpell dictionary",
46-
populateCSpellDictionary,
47-
);
48-
}
49-
5042
await runCleanup(createCleanupCommands(options.bin), options.mode);
5143
}
5244

‎src/steps/clearUnnecessaryFiles.ts

-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ const globPaths = [
1717
".eslintrc",
1818
"CODE_OF_CONDUCT.md",
1919
"CONTRIBUTING.md",
20-
".npmpackagejsonlintrc.json",
2120
"codecov.yml",
2221
"DEVELOPMENT.md",
2322
"dist",

‎src/steps/writing/creation/createCSpellConfig.test.ts

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
import { describe, expect, it } from "vitest";
2+
3+
import { createCSpellConfig } from "./createCSpellConfig.js";
4+
5+
describe("createCSpellConfig", () => {
6+
it("creates an ignore file with all words when exclusions are disabled", async () => {
7+
const actual = await createCSpellConfig({});
8+
9+
expect(actual).toMatchInlineSnapshot(`
10+
"{
11+
"dictionaries": ["npm", "node", "typescript"],
12+
"ignorePaths": [
13+
".all-contributorsrc",
14+
".github",
15+
"CHANGELOG.md",
16+
"coverage",
17+
"lib",
18+
"node_modules",
19+
"pnpm-lock.yaml"
20+
],
21+
"words": [
22+
"apexskier",
23+
"automerge",
24+
"joshuakgoldberg",
25+
"markdownlintignore",
26+
"tseslint"
27+
]
28+
}
29+
"
30+
`);
31+
});
32+
33+
it("creates an ignore file with minimal words when exclusions are enabled", async () => {
34+
const actual = await createCSpellConfig({
35+
excludeAllContributors: true,
36+
excludeLintMd: true,
37+
excludeReleases: true,
38+
excludeRenovate: true,
39+
excludeTemplatedBy: true,
40+
excludeTests: true,
41+
});
42+
43+
expect(actual).toMatchInlineSnapshot(`
44+
"{
45+
"dictionaries": ["npm", "node", "typescript"],
46+
"ignorePaths": [
47+
".github",
48+
"CHANGELOG.md",
49+
"lib",
50+
"node_modules",
51+
"pnpm-lock.yaml"
52+
],
53+
"words": ["tseslint"]
54+
}
55+
"
56+
`);
57+
});
58+
});

‎src/steps/writing/creation/createCSpellConfig.ts

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { Options } from "../../../shared/types.js";
2+
import { formatJson } from "./formatters/formatJson.js";
3+
4+
export async function createCSpellConfig(
5+
options: Pick<
6+
Options,
7+
| "excludeAllContributors"
8+
| "excludeLintMd"
9+
| "excludeReleases"
10+
| "excludeRenovate"
11+
| "excludeTemplatedBy"
12+
| "excludeTests"
13+
>,
14+
) {
15+
const words = [
16+
"tseslint",
17+
!options.excludeReleases && "apexskier",
18+
!options.excludeRenovate && "automerge",
19+
!options.excludeLintMd && "markdownlintignore",
20+
!options.excludeTemplatedBy && "joshuakgoldberg",
21+
]
22+
.filter(Boolean)
23+
.sort();
24+
25+
return await formatJson({
26+
dictionaries: ["npm", "node", "typescript"],
27+
ignorePaths: [
28+
...(options.excludeAllContributors ? [] : [".all-contributorsrc"]),
29+
".github",
30+
"CHANGELOG.md",
31+
...(options.excludeTests ? [] : ["coverage"]),
32+
"lib",
33+
"node_modules",
34+
"pnpm-lock.yaml",
35+
],
36+
words,
37+
});
38+
}

‎src/steps/writing/creation/rootFiles.ts

+2-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { Options } from "../../../shared/types.js";
2+
import { createCSpellConfig } from "./createCSpellConfig.js";
23
import { createDotGitignore } from "./createDotGitignore.js";
34
import { createESLintConfig } from "./createESLintConfig.js";
45
import { createTsupConfig } from "./createTsupConfig.js";
@@ -92,18 +93,7 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
9293
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9394
`,
9495
...(!options.excludeLintSpelling && {
95-
"cspell.json": await formatJson({
96-
dictionaries: ["typescript"],
97-
ignorePaths: [
98-
...(options.excludeAllContributors ? [] : [".all-contributorsrc"]),
99-
".github",
100-
"CHANGELOG.md",
101-
...(options.excludeTests ? [] : ["coverage"]),
102-
"lib",
103-
"node_modules",
104-
"pnpm-lock.yaml",
105-
],
106-
}),
96+
"cspell.json": await createCSpellConfig(options),
10797
}),
10898
...(!options.excludeLintKnip && {
10999
"knip.json": await formatJson({

0 commit comments

Comments
 (0)