feat: populate existing cspell.json words during migration (#1208)

## PR Checklist

- [x] Addresses an existing open issue: fixes #702
- [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

Runs `pnpm lint:spelling` and matches `Unknown word (...)` complaints.

Also standardizes two things in code that were bugging me:

* `node:fs/promises` imports as `import * as fs`
* Using `formatJson` instead of manually `prettier.format` calls

This finally means that the file creator for `cspell.json` no longer
needs to prepopulate with a static list of words. So unnecessary ignored
words will no longer be potentially introduced by that. Yay.

Author: JoshuaKGoldberg

cspell.json

@@ -2,39 +2,31 @@
 	"dictionaries": ["typescript"],
 	"ignorePaths": [
 		"./coverage*",
+		"./script/__snapshots__",
 		".github",
 		"CHANGELOG.md",
 		"lib",
 		"node_modules",
-		"pnpm-lock.yaml",
-		"./script/__snapshots__"
+		"pnpm-lock.yaml"
 	],
 	"words": [
 		"allcontributors",
 		"apexskier",
 		"arethetypeswrong",
-		"Codecov",
 		"codespace",
-		"commitlint",
 		"contributorsrc",
-		"conventionalcommits",
 		"execa",
 		"infile",
-		"joshuakgoldberg",
 		"knip",
-		"lcov",
 		"markdownlintignore",
 		"mtfoley",
 		"npmignore",
-		"npmjs",
 		"npmpackagejsonlintrc",
 		"outro",
 		"packagejson",
 		"quickstart",
 		"tada",
 		"tsup",
-		"Unstaged",
-		"vitest",
-		"wontfix"
+		"vitest"
 	]
 }

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

@@ -156,42 +156,30 @@ exports[`expected file changes > cspell.json 1`] = `
  	"dictionaries": ["typescript"],
  	"ignorePaths": [
 -		"./coverage*",
+-		"./script/__snapshots__",
  		".github",
  		"CHANGELOG.md",
 +		"coverage",
  		"lib",
  		"node_modules",
--		"pnpm-lock.yaml",
--		"./script/__snapshots__"
-+		"pnpm-lock.yaml"
- 	],
- 	"words": [
--		"allcontributors",
--		"apexskier",
--		"arethetypeswrong",
- 		"Codecov",
- 		"codespace",
- 		"commitlint",
+ 		"pnpm-lock.yaml"
+@@ ... @@
  		"contributorsrc",
- 		"conventionalcommits",
--		"execa",
--		"infile",
--		"joshuakgoldberg",
+ 		"execa",
+ 		"infile",
++		"joshuakgoldberg",
  		"knip",
- 		"lcov",
++		"markdownlint",
  		"markdownlintignore",
--		"mtfoley",
--		"npmignore",
--		"npmjs",
- 		"npmpackagejsonlintrc",
- 		"outro",
- 		"packagejson",
+ 		"mtfoley",
+ 		"npmignore",
+@@ ... @@
  		"quickstart",
--		"tada",
+ 		"tada",
  		"tsup",
--		"Unstaged",
--		"vitest",
- 		"wontfix"
+-		"vitest"
++		"vitest",
++		"wontfix"
  	]
  }"
 `;

script/initialize-test-e2e.js

@@ -1,7 +1,7 @@
 import { $ } from "execa";
 import { globby } from "globby";
 import { strict as assert } from "node:assert";
-import fs from "node:fs/promises";
+import * as fs from "node:fs/promises";
 
 const description = "New Description Test";
 const owner = "RNR1";

script/migrate-test-e2e.js

@@ -1,6 +1,6 @@
 import chalk from "chalk";
 import { $, execaCommand } from "execa";
-import fs from "node:fs/promises";
+import * as fs from "node:fs/promises";
 import { assert, describe, expect, test } from "vitest";
 
 import packageData from "../package.json" assert { type: "json" };

src/create/createWithOptions.test.ts

@@ -7,6 +7,7 @@ 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 { runCommands } from "../steps/runCommands.js";
 import { createWithOptions } from "./createWithOptions.js";
 
@@ -60,6 +61,8 @@ vi.mock("../steps/writeReadme/index.js");
 
 vi.mock("../steps/finalizeDependencies.js");
 
+vi.mock("../steps/populateCSpellDictionary.js");
+
 vi.mock("../steps/runCommands.js");
 
 vi.mock("../shared/doesRepositoryExist.js", () => ({
@@ -111,18 +114,19 @@ describe("createWithOptions", () => {
 		expect(addToolAllContributors).not.toHaveBeenCalled();
 	});
 
-	it("does not call finalizeDependencies or runCommands when skipInstall is true", async () => {
+	it("does not call finalizeDependencies, populateCSpellDictionary, or runCommands when skipInstall is true", async () => {
 		const options = {
 			...optionsBase,
 			skipInstall: true,
 		};
 
 		await createWithOptions({ github, options });
 		expect(finalizeDependencies).not.toHaveBeenCalled();
+		expect(populateCSpellDictionary).not.toHaveBeenCalled();
 		expect(runCommands).not.toHaveBeenCalled();
 	});
 
-	it("calls finalizeDependencies and runCommands when skipInstall is false", async () => {
+	it("calls finalizeDependencies, populateCSpellDictionary, and runCommands when skipInstall is false", async () => {
 		const options = {
 			...optionsBase,
 			skipInstall: false,
@@ -131,6 +135,7 @@ describe("createWithOptions", () => {
 		await createWithOptions({ github, options });
 
 		expect(finalizeDependencies).toHaveBeenCalledWith(options);
+		expect(populateCSpellDictionary).toHaveBeenCalled();
 		expect(runCommands).toHaveBeenCalled();
 	});
 

src/create/createWithOptions.ts

@@ -7,6 +7,7 @@ import { GitHubAndOptions } from "../shared/options/readOptions.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 { runCommands } from "../steps/runCommands.js";
 import { writeReadme } from "../steps/writeReadme/index.js";
 import { writeStructure } from "../steps/writing/writeStructure.js";
@@ -38,6 +39,13 @@ export async function createWithOptions({ github, options }: GitHubAndOptions) {
 			finalizeDependencies(options),
 		);
 
+		if (!options.excludeLintSpelling) {
+			await withSpinner(
+				"Populating CSpell dictionary",
+				populateCSpellDictionary,
+			);
+		}
+
 		await runCommands(
 			"Cleaning up files",
 			createCleanUpFilesCommands({

src/migrate/migrateWithOptions.ts

@@ -5,6 +5,7 @@ import { clearUnnecessaryFiles } from "../steps/clearUnnecessaryFiles.js";
 import { detectExistingContributors } from "../steps/detectExistingContributors.js";
 import { finalizeDependencies } from "../steps/finalizeDependencies.js";
 import { initializeGitHubRepository } from "../steps/initializeGitHubRepository/index.js";
+import { populateCSpellDictionary } from "../steps/populateCSpellDictionary.js";
 import { runCommands } from "../steps/runCommands.js";
 import { updateAllContributorsTable } from "../steps/updateAllContributorsTable.js";
 import { updateLocalFiles } from "../steps/updateLocalFiles.js";
@@ -61,6 +62,10 @@ export async function migrateWithOptions({
 		);
 	}
 
+	if (!options.excludeLintSpelling) {
+		await withSpinner("Populating CSpell dictionary", populateCSpellDictionary);
+	}
+
 	await runCommands(
 		"Cleaning up files",
 		createCleanUpFilesCommands({

src/shared/options/createOptionDefaults/index.ts

@@ -2,7 +2,7 @@ import { $ } from "execa";
 import gitRemoteOriginUrl from "git-remote-origin-url";
 import gitUrlParse from "git-url-parse";
 import lazyValue from "lazy-value";
-import fs from "node:fs/promises";
+import * as fs from "node:fs/promises";
 import npmUser from "npm-user";
 
 import { readPackageData } from "../../packages.js";

src/shared/readFileSafe.test.ts

@@ -5,12 +5,8 @@ import { readFileSafe } from "./readFileSafe.js";
 const mockReadFile = vi.fn();
 
 vi.mock("node:fs/promises", () => ({
-	get default() {
-		return {
-			get readFile() {
-				return mockReadFile;
-			},
-		};
+	get readFile() {
+		return mockReadFile;
 	},
 }));
 

src/shared/readFileSafe.ts

@@ -1,4 +1,4 @@
-import fs from "node:fs/promises";
+import * as fs from "node:fs/promises";
 
 export async function readFileSafe(filePath: URL | string, fallback: string) {
 	try {