feat: debugging in vs code

.vscode/launch.json

@@ -10,6 +10,14 @@
 			"skipFiles": ["<node_internals>/**", "**/node_modules/**"],
 			"smartStep": true,
 			"type": "node"
+		},
+		{
+			"name": "Debug Program",
+			"preLaunchTask": "build",
+			"program": "./bin/index.js",
+			"request": "launch",
+			"skipFiles": ["<node_internals>/**"],
+			"type": "node"
 		}
 	],
 	"version": "0.2.0"

.vscode/tasks.json

@@ -0,0 +1,11 @@
+{
+	"tasks": [
+		{
+			"detail": "Build the project",
+			"label": "build",
+			"script": "build",
+			"type": "npm"
+		}
+	],
+	"version": "2.0.0"
+}

script/migrate-test-e2e.js

@@ -163,8 +163,16 @@ test("unexpected file changes", async () => {
 				"That likely indicates changes made to the repository without",
 				"corresponding updates to templates in src/.",
 				"",
-				"Please search for those file(s)' name(s) under src/migrate for",
-				"the corresponding template and update those as well.",
+				"Following the steps below should fix the issue:",
+				"",
+				"1. Commit any changes",
+				"2. `pnpm i; pnpm build; pnpm test:migrate -u`",
+				"3. At this point there will be some files changed:",
+				"   - `script/__snapshots__/migrate-test-e2e.js.snap` will have updates if any files mismatched templates",
+				"   - The actual updated files on disk will be there too",
+				`4. Commit ${unstagedModifiedFiles.join(
+					", ",
+				)} and/or \`script/__snapshots__/migrate-test-e2e.js.snap\` and revert the rest`,
 			]
 				.map((line) => chalk.red(line))
 				.join("\n"),

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

@@ -0,0 +1,301 @@
+import { describe, expect, it } from "vitest";
+
+import { Options } from "../../../shared/types.js";
+import { createDotVSCode } from "./dotVSCode.js";
+
+/* spellchecker: disable */
+function fakeOptions(
+	getExcludeValue: (exclusionName: string) => boolean,
+	bin?: string | undefined,
+) {
+	return {
+		access: "public",
+		author: "TestAuthor",
+		base: "everything",
+		...(bin ? { bin } : {}),
+		description: "Test description.",
+		directory: ".",
+		email: {
+			github: "[email protected]",
+			npm: "[email protected]",
+		},
+		...Object.fromEntries(
+			[
+				"excludeCompliance",
+				"excludeAllContributors",
+				"excludeLintDeprecation",
+				"excludeLintESLint",
+				"excludeLintJSDoc",
+				"excludeLintJson",
+				"excludeLintKnip",
+				"excludeLintMd",
+				"excludeLintPackageJson",
+				"excludeLintPackages",
+				"excludeLintPerfectionist",
+				"excludeLintRegex",
+				"excludeLintSpelling",
+				"excludeLintStrict",
+				"excludeLintStylistic",
+				"excludeLintYml",
+				"excludeReleases",
+				"excludeRenovate",
+				"excludeTests",
+			].map((key) => [key, getExcludeValue(key)]),
+		),
+		mode: "create",
+		owner: "TestOwner",
+		repository: "test-repository",
+		skipGitHubApi: true,
+		skipInstall: true,
+		skipRemoval: true,
+		title: "Test Title",
+	} satisfies Options;
+}
+
+describe("createDotVSCode", () => {
+	it("creates a minimal config when all exclusions are enabled", async () => {
+		expect(await createDotVSCode(fakeOptions(() => true)))
+			.toMatchInlineSnapshot(`
+				{
+				  "extensions.json": "{
+				  "recommendations": [
+				    "DavidAnson.vscode-markdownlint",
+				    "dbaeumer.vscode-eslint",
+				    "esbenp.prettier-vscode"
+				  ]
+				}
+				",
+				  "settings.json": "{
+				  "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" },
+				  "editor.defaultFormatter": "esbenp.prettier-vscode",
+				  "editor.formatOnSave": true,
+				  "editor.rulers": [80],
+				  "eslint.probe": [
+				    "javascript",
+				    "javascriptreact",
+				    "json",
+				    "jsonc",
+				    "markdown",
+				    "typescript",
+				    "typescriptreact",
+				    "yaml"
+				  ],
+				  "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
+				  "typescript.tsdk": "node_modules/typescript/lib"
+				}
+				",
+				  "tasks.json": "{
+				  "tasks": [
+				    {
+				      "detail": "Build the project",
+				      "label": "build",
+				      "script": "build",
+				      "type": "npm"
+				    }
+				  ],
+				  "version": "2.0.0"
+				}
+				",
+				}
+			`);
+	});
+
+	it("creates a full config when all exclusions are disabled and bin is provided", async () => {
+		expect(await createDotVSCode(fakeOptions(() => false, "bin/index.js")))
+			.toMatchInlineSnapshot(`
+				{
+				  "extensions.json": "{
+				  "recommendations": [
+				    "DavidAnson.vscode-markdownlint",
+				    "dbaeumer.vscode-eslint",
+				    "esbenp.prettier-vscode",
+				    "streetsidesoftware.code-spell-checker"
+				  ]
+				}
+				",
+				  "launch.json": "{
+				  "configurations": [
+				    {
+				      "args": ["run", "\${relativeFile}"],
+				      "autoAttachChildProcesses": true,
+				      "console": "integratedTerminal",
+				      "name": "Debug Current Test File",
+				      "program": "\${workspaceRoot}/node_modules/vitest/vitest.mjs",
+				      "request": "launch",
+				      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+				      "smartStep": true,
+				      "type": "node"
+				    },
+				    {
+				      "name": "Debug Program",
+				      "preLaunchTask": "build",
+				      "program": "bin/index.js",
+				      "request": "launch",
+				      "skipFiles": ["<node_internals>/**"],
+				      "type": "node"
+				    }
+				  ],
+				  "version": "0.2.0"
+				}
+				",
+				  "settings.json": "{
+				  "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" },
+				  "editor.defaultFormatter": "esbenp.prettier-vscode",
+				  "editor.formatOnSave": true,
+				  "editor.rulers": [80],
+				  "eslint.probe": [
+				    "javascript",
+				    "javascriptreact",
+				    "json",
+				    "jsonc",
+				    "markdown",
+				    "typescript",
+				    "typescriptreact",
+				    "yaml"
+				  ],
+				  "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
+				  "typescript.tsdk": "node_modules/typescript/lib"
+				}
+				",
+				  "tasks.json": "{
+				  "tasks": [
+				    {
+				      "detail": "Build the project",
+				      "label": "build",
+				      "script": "build",
+				      "type": "npm"
+				    }
+				  ],
+				  "version": "2.0.0"
+				}
+				",
+				}
+			`);
+	});
+
+	it("creates a full config when all exclusions are disabled and bin is not provided", async () => {
+		expect(await createDotVSCode(fakeOptions(() => false)))
+			.toMatchInlineSnapshot(`
+				{
+				  "extensions.json": "{
+				  "recommendations": [
+				    "DavidAnson.vscode-markdownlint",
+				    "dbaeumer.vscode-eslint",
+				    "esbenp.prettier-vscode",
+				    "streetsidesoftware.code-spell-checker"
+				  ]
+				}
+				",
+				  "launch.json": "{
+				  "configurations": [
+				    {
+				      "args": ["run", "\${relativeFile}"],
+				      "autoAttachChildProcesses": true,
+				      "console": "integratedTerminal",
+				      "name": "Debug Current Test File",
+				      "program": "\${workspaceRoot}/node_modules/vitest/vitest.mjs",
+				      "request": "launch",
+				      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+				      "smartStep": true,
+				      "type": "node"
+				    }
+				  ],
+				  "version": "0.2.0"
+				}
+				",
+				  "settings.json": "{
+				  "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" },
+				  "editor.defaultFormatter": "esbenp.prettier-vscode",
+				  "editor.formatOnSave": true,
+				  "editor.rulers": [80],
+				  "eslint.probe": [
+				    "javascript",
+				    "javascriptreact",
+				    "json",
+				    "jsonc",
+				    "markdown",
+				    "typescript",
+				    "typescriptreact",
+				    "yaml"
+				  ],
+				  "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
+				  "typescript.tsdk": "node_modules/typescript/lib"
+				}
+				",
+				  "tasks.json": "{
+				  "tasks": [
+				    {
+				      "detail": "Build the project",
+				      "label": "build",
+				      "script": "build",
+				      "type": "npm"
+				    }
+				  ],
+				  "version": "2.0.0"
+				}
+				",
+				}
+			`);
+	});
+
+	it("creates a minimal config including launch.json when all exclusions are enabled and bin is provided", async () => {
+		expect(await createDotVSCode(fakeOptions(() => true, "bin/index.js")))
+			.toMatchInlineSnapshot(`
+				{
+				  "extensions.json": "{
+				  "recommendations": [
+				    "DavidAnson.vscode-markdownlint",
+				    "dbaeumer.vscode-eslint",
+				    "esbenp.prettier-vscode"
+				  ]
+				}
+				",
+				  "launch.json": "{
+				  "configurations": [
+				    {
+				      "name": "Debug Program",
+				      "preLaunchTask": "build",
+				      "program": "bin/index.js",
+				      "request": "launch",
+				      "skipFiles": ["<node_internals>/**"],
+				      "type": "node"
+				    }
+				  ],
+				  "version": "0.2.0"
+				}
+				",
+				  "settings.json": "{
+				  "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" },
+				  "editor.defaultFormatter": "esbenp.prettier-vscode",
+				  "editor.formatOnSave": true,
+				  "editor.rulers": [80],
+				  "eslint.probe": [
+				    "javascript",
+				    "javascriptreact",
+				    "json",
+				    "jsonc",
+				    "markdown",
+				    "typescript",
+				    "typescriptreact",
+				    "yaml"
+				  ],
+				  "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
+				  "typescript.tsdk": "node_modules/typescript/lib"
+				}
+				",
+				  "tasks.json": "{
+				  "tasks": [
+				    {
+				      "detail": "Build the project",
+				      "label": "build",
+				      "script": "build",
+				      "type": "npm"
+				    }
+				  ],
+				  "version": "2.0.0"
+				}
+				",
+				}
+			`);
+	});
+});