feat: pre-fill cspell.json words

cspell.json

@@ -1,35 +1,28 @@
 {
-	"dictionaries": ["typescript"],
+	"dictionaries": ["npm", "node", "typescript"],
 	"ignorePaths": [
-		"./coverage*",
-		"./script/__snapshots__",
 		".all-contributorsrc",
 		".github",
 		"CHANGELOG.md",
+		"coverage*",
 		"lib",
 		"node_modules",
-		"pnpm-lock.yaml"
+		"pnpm-lock.yaml",
+		"script/__snapshots__"
 	],
 	"words": [
 		"allcontributors",
 		"apexskier",
 		"arethetypeswrong",
 		"automerge",
-		"codecov",
 		"codespace",
-		"contributorsrc",
 		"execa",
 		"infile",
-		"knip",
+		"joshuakgoldberg",
 		"markdownlintignore",
 		"mtfoley",
-		"npmignore",
-		"npmpackagejsonlintrc",
 		"outro",
-		"packagejson",
 		"tada",
-		"tseslint",
-		"tsup",
-		"vitest"
+		"tseslint"
 	]
 }

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

@@ -105,39 +105,33 @@ exports[`expected file changes > cspell.json 1`] = `
 "--- a/cspell.json
 +++ b/cspell.json
 @@ ... @@
- {
- 	"dictionaries": ["typescript"],
- 	"ignorePaths": [
--		"./coverage*",
--		"./script/__snapshots__",
  		".all-contributorsrc",
  		".github",
  		"CHANGELOG.md",
+-		"coverage*",
 +		"coverage",
  		"lib",
  		"node_modules",
- 		"pnpm-lock.yaml"
+-		"pnpm-lock.yaml",
+-		"script/__snapshots__"
++		"pnpm-lock.yaml"
+ 	],
+ 	"words": [
+ 		"allcontributors",
 @@ ... @@
- 		"apexskier",
  		"arethetypeswrong",
  		"automerge",
--		"codecov",
  		"codespace",
- 		"contributorsrc",
- 		"execa",
+-		"execa",
++		"contributorsrc",
  		"infile",
-+		"joshuakgoldberg",
- 		"knip",
-+		"markdownlint",
+ 		"joshuakgoldberg",
  		"markdownlintignore",
  		"mtfoley",
- 		"npmignore",
-@@ ... @@
+ 		"outro",
  		"tada",
- 		"tseslint",
- 		"tsup",
--		"vitest"
-+		"vitest",
+-		"tseslint"
++		"tseslint",
 +		"wontfix"
  	]
  }"

src/create/createWithOptions.test.ts

@@ -7,7 +7,6 @@ import { Options } from "../shared/types.js";
 import { addToolAllContributors } from "../steps/addToolAllContributors.js";
 import { finalizeDependencies } from "../steps/finalizeDependencies.js";
 import { initializeGitHubRepository } from "../steps/initializeGitHubRepository/index.js";
-import { populateCSpellDictionary } from "../steps/populateCSpellDictionary.js";
 import { runCleanup } from "../steps/runCleanup.js";
 import { createWithOptions } from "./createWithOptions.js";
 
@@ -61,8 +60,6 @@ vi.mock("../steps/writeReadme/index.js");
 
 vi.mock("../steps/finalizeDependencies.js");
 
-vi.mock("../steps/populateCSpellDictionary.js");
-
 vi.mock("../steps/clearLocalGitTags.js");
 
 vi.mock("../steps/runCleanup.js");
@@ -119,19 +116,18 @@ describe("createWithOptions", () => {
 		expect(addToolAllContributors).not.toHaveBeenCalled();
 	});
 
-	it("does not call finalizeDependencies, populateCSpellDictionary, or runCleanup when skipInstall is true", async () => {
+	it("does not call finalizeDependencies or runCleanup when skipInstall is true", async () => {
 		const options = {
 			...optionsBase,
 			skipInstall: true,
 		};
 
 		await createWithOptions({ github, options });
 		expect(finalizeDependencies).not.toHaveBeenCalled();
-		expect(populateCSpellDictionary).not.toHaveBeenCalled();
 		expect(runCleanup).not.toHaveBeenCalled();
 	});
 
-	it("calls finalizeDependencies, populateCSpellDictionary, and runCleanup when skipInstall is false", async () => {
+	it("calls finalizeDependencies and runCleanup when skipInstall is false", async () => {
 		const options = {
 			...optionsBase,
 			skipInstall: false,
@@ -140,7 +136,6 @@ describe("createWithOptions", () => {
 		await createWithOptions({ github, options });
 
 		expect(finalizeDependencies).toHaveBeenCalledWith(options);
-		expect(populateCSpellDictionary).toHaveBeenCalled();
 		expect(runCleanup).toHaveBeenCalled();
 	});
 

src/create/createWithOptions.ts

@@ -8,7 +8,6 @@ import { addToolAllContributors } from "../steps/addToolAllContributors.js";
 import { clearLocalGitTags } from "../steps/clearLocalGitTags.js";
 import { finalizeDependencies } from "../steps/finalizeDependencies.js";
 import { initializeGitHubRepository } from "../steps/initializeGitHubRepository/index.js";
-import { populateCSpellDictionary } from "../steps/populateCSpellDictionary.js";
 import { runCleanup } from "../steps/runCleanup.js";
 import { writeReadme } from "../steps/writeReadme/index.js";
 import { writeStructure } from "../steps/writing/writeStructure.js";
@@ -40,13 +39,6 @@ export async function createWithOptions({ github, options }: GitHubAndOptions) {
 			finalizeDependencies(options),
 		);
 
-		if (!options.excludeLintSpelling) {
-			await withSpinner(
-				"Populating CSpell dictionary",
-				populateCSpellDictionary,
-			);
-		}
-
 		await runCleanup(createCleanupCommands(options.bin), options.mode);
 	}
 

src/steps/clearUnnecessaryFiles.ts

@@ -17,7 +17,6 @@ const globPaths = [
 	".eslintrc",
 	"CODE_OF_CONDUCT.md",
 	"CONTRIBUTING.md",
-	".npmpackagejsonlintrc.json",
 	"codecov.yml",
 	"DEVELOPMENT.md",
 	"dist",

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

@@ -0,0 +1,58 @@
+import { describe, expect, it } from "vitest";
+
+import { createCSpellConfig } from "./createCSpellConfig.js";
+
+describe("createCSpellConfig", () => {
+	it("creates an ignore file with all words when exclusions are disabled", async () => {
+		const actual = await createCSpellConfig({});
+
+		expect(actual).toMatchInlineSnapshot(`
+			"{
+				"dictionaries": ["npm", "node", "typescript"],
+				"ignorePaths": [
+					".all-contributorsrc",
+					".github",
+					"CHANGELOG.md",
+					"coverage",
+					"lib",
+					"node_modules",
+					"pnpm-lock.yaml"
+				],
+				"words": [
+					"apexskier",
+					"automerge",
+					"joshuakgoldberg",
+					"markdownlintignore",
+					"tseslint"
+				]
+			}
+			"
+		`);
+	});
+
+	it("creates an ignore file with minimal words when exclusions are enabled", async () => {
+		const actual = await createCSpellConfig({
+			excludeAllContributors: true,
+			excludeLintMd: true,
+			excludeReleases: true,
+			excludeRenovate: true,
+			excludeTemplatedBy: true,
+			excludeTests: true,
+		});
+
+		expect(actual).toMatchInlineSnapshot(`
+			"{
+				"dictionaries": ["npm", "node", "typescript"],
+				"ignorePaths": [
+					".github",
+					"CHANGELOG.md",
+					"lib",
+					"node_modules",
+					"pnpm-lock.yaml"
+				],
+				"words": ["tseslint"]
+			}
+			"
+		`);
+	});
+});

src/steps/writing/creation/createCSpellConfig.ts

@@ -0,0 +1,38 @@
+import { Options } from "../../../shared/types.js";
+import { formatJson } from "./formatters/formatJson.js";
+
+export async function createCSpellConfig(
+	options: Pick<
+		Options,
+		| "excludeAllContributors"
+		| "excludeLintMd"
+		| "excludeReleases"
+		| "excludeRenovate"
+		| "excludeTemplatedBy"
+		| "excludeTests"
+	>,
+) {
+	const words = [
+		"tseslint",
+		!options.excludeReleases && "apexskier",
+		!options.excludeRenovate && "automerge",
+		!options.excludeLintMd && "markdownlintignore",
+		!options.excludeTemplatedBy && "joshuakgoldberg",
+	]
+		.filter(Boolean)
+		.sort();
+
+	return await formatJson({
+		dictionaries: ["npm", "node", "typescript"],
+		ignorePaths: [
+			...(options.excludeAllContributors ? [] : [".all-contributorsrc"]),
+			".github",
+			"CHANGELOG.md",
+			...(options.excludeTests ? [] : ["coverage"]),
+			"lib",
+			"node_modules",
+			"pnpm-lock.yaml",
+		],
+		words,
+	});
+}

src/steps/writing/creation/rootFiles.ts

@@ -1,4 +1,5 @@
 import { Options } from "../../../shared/types.js";
+import { createCSpellConfig } from "./createCSpellConfig.js";
 import { createDotGitignore } from "./createDotGitignore.js";
 import { createESLintConfig } from "./createESLintConfig.js";
 import { createTsupConfig } from "./createTsupConfig.js";
@@ -92,18 +93,7 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 `,
 		...(!options.excludeLintSpelling && {
-			"cspell.json": await formatJson({
-				dictionaries: ["typescript"],
-				ignorePaths: [
-					...(options.excludeAllContributors ? [] : [".all-contributorsrc"]),
-					".github",
-					"CHANGELOG.md",
-					...(options.excludeTests ? [] : ["coverage"]),
-					"lib",
-					"node_modules",
-					"pnpm-lock.yaml",
-				],
-			}),
+			"cspell.json": await createCSpellConfig(options),
 		}),
 		...(!options.excludeLintKnip && {
 			"knip.json": await formatJson({