create-typescript-app 1.76.0 → 1.77.1

package/lib/next/blocks/blockTemplatedBy.js

@@ -0,0 +1,30 @@
+import { base } from "../base.js";
+import { blockCSpell } from "./blockCSpell.js";
+import { blockREADME } from "./blockREADME.js";
+const blockTemplatedBy = base.createBlock({
+  about: {
+    name: "Templated By Notice"
+  },
+  produce() {
+    return {
+      addons: [
+        blockCSpell({
+          words: ["joshuakgoldberg"]
+        }),
+        blockREADME({
+          notices: [
+            `
+<!-- You can remove this notice if you don't want it \u{1F642} no worries! -->
+
+> \u{1F49D} This package was templated with [\`create-typescript-app\`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [\`create\` engine](https://github.com/JoshuaKGoldberg/create).
+`
+          ]
+        })
+      ]
+    };
+  }
+});
+export {
+  blockTemplatedBy
+};
+//# sourceMappingURL=blockTemplatedBy.js.map

package/lib/next/blocks/blockTemplatedBy.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/next/blocks/blockTemplatedBy.ts"],"sourcesContent":["import { base } from \"../base.js\";\nimport { blockCSpell } from \"./blockCSpell.js\";\nimport { blockREADME } from \"./blockREADME.js\";\n\nexport const blockTemplatedBy = base.createBlock({\n\tabout: {\n\t\tname: \"Templated By Notice\",\n\t},\n\tproduce() {\n\t\treturn {\n\t\t\taddons: [\n\t\t\t\tblockCSpell({\n\t\t\t\t\twords: [\"joshuakgoldberg\"],\n\t\t\t\t}),\n\t\t\t\tblockREADME({\n\t\t\t\t\tnotices: [\n\t\t\t\t\t\t`\n<!-- You can remove this notice if you don't want it 🙂 no worries! -->\n\n> 💝 This package was templated with [\\`create-typescript-app\\`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [\\`create\\` engine](https://github.com/JoshuaKGoldberg/create).\n`,\n\t\t\t\t\t],\n\t\t\t\t}),\n\t\t\t],\n\t\t};\n\t},\n});\n"],"mappings":"AAAA,SAAS,YAAY;AACrB,SAAS,mBAAmB;AAC5B,SAAS,mBAAmB;AAErB,MAAM,mBAAmB,KAAK,YAAY;AAAA,EAChD,OAAO;AAAA,IACN,MAAM;AAAA,EACP;AAAA,EACA,UAAU;AACT,WAAO;AAAA,MACN,QAAQ;AAAA,QACP,YAAY;AAAA,UACX,OAAO,CAAC,iBAAiB;AAAA,QAC1B,CAAC;AAAA,QACD,YAAY;AAAA,UACX,SAAS;AAAA,YACR;AAAA;AAAA;AAAA;AAAA;AAAA,UAKD;AAAA,QACD,CAAC;AAAA,MACF;AAAA,IACD;AAAA,EACD;AACD,CAAC;","names":[]}

package/lib/next/blocks/blockTypeScript.d.ts

@@ -0,0 +1,48 @@
+import * as create from 'create';
+
+declare const blockTypeScript: create.BlockWithoutAddons<{
+    description: string;
+    email: {
+        github: string;
+        npm: string;
+    };
+    title: string;
+    owner: string;
+    repository: string;
+    access?: "public" | "restricted" | undefined;
+    author?: string | undefined;
+    bin?: string | undefined;
+    login?: string | undefined;
+    contributors?: {
+        name: string;
+        avatar_url: string;
+        contributions: string[];
+        login: string;
+        profile: string;
+    }[] | undefined;
+    documentation?: string | undefined;
+    funding?: string | undefined;
+    guide?: {
+        href: string;
+        title: string;
+    } | undefined;
+    hideTemplatedBy?: boolean | undefined;
+    keywords?: string[] | undefined;
+    logo?: {
+        alt: string;
+        src: string;
+    } | undefined;
+    node?: {
+        minimum: string;
+        pinned?: string | undefined;
+    } | undefined;
+    packageData?: {
+        dependencies?: Record<string, string> | undefined;
+        devDependencies?: Record<string, string> | undefined;
+        scripts?: Record<string, string> | undefined;
+    } | undefined;
+    preserveGeneratedFrom?: boolean | undefined;
+    version?: string | undefined;
+}>;
+
+export { blockTypeScript };

package/lib/next/blocks/blockTypeScript.js

@@ -0,0 +1,137 @@
+import { base } from "../base.js";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
+import { blockExampleFiles } from "./blockExampleFiles.js";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
+import { blockGitignore } from "./blockGitignore.js";
+import { blockMarkdownlint } from "./blockMarkdownlint.js";
+import { blockPackageJson } from "./blockPackageJson.js";
+import { blockVitest } from "./blockVitest.js";
+import { blockVSCode } from "./blockVSCode.js";
+import { getPackageDependencies } from "./packageData.js";
+const blockTypeScript = base.createBlock({
+  about: {
+    name: "TypeScript"
+  },
+  produce({ options }) {
+    return {
+      addons: [
+        blockDevelopmentDocs({
+          sections: {
+            "Type Checking": {
+              contents: `
+You should be able to see suggestions from [TypeScript](https://typescriptlang.org) in your editor for all open files.
+
+However, it can be useful to run the TypeScript command-line (\`tsc\`) to type check all files in \`src/\`:
+
+\`\`\`shell
+pnpm tsc
+\`\`\`
+
+Add \`--watch\` to keep the type checker running in a watch mode that updates the display as you save files:
+
+\`\`\`shell
+pnpm tsc --watch
+\`\`\`
+`
+            }
+          }
+        }),
+        blockExampleFiles({
+          files: {
+            "greet.ts": `import { GreetOptions } from "./types.js";
+	
+	export function greet(options: GreetOptions | string) {
+		const {
+			logger = console.log.bind(console),
+			message,
+			times = 1,
+		} = typeof options === "string" ? { message: options } : options;
+	
+		for (let i = 0; i < times; i += 1) {
+			logger(message);
+		}
+	}
+	`,
+            "index.ts": `export * from "./greet.js";
+export * from "./types.js";
+`,
+            "types.ts": `export interface GreetOptions {
+		logger?: (message: string) => void;
+		message: string;
+		times?: number;
+	}
+	`
+          }
+        }),
+        blockGitignore({
+          ignores: ["/lib"]
+        }),
+        blockGitHubActionsCI({
+          jobs: [{ name: "Type Check", steps: [{ run: "pnpm tsc" }] }]
+        }),
+        blockMarkdownlint({
+          ignores: ["lib/"]
+        }),
+        blockPackageJson({
+          properties: {
+            devDependencies: getPackageDependencies("typescript"),
+            files: ["lib/"],
+            main: "./lib/index.js",
+            scripts: {
+              tsc: "tsc"
+            }
+          }
+        }),
+        blockVitest({
+          exclude: ["lib"],
+          include: ["src"]
+        }),
+        blockVSCode({
+          debuggers: options.bin ? [
+            {
+              name: "Debug Program",
+              preLaunchTask: "build",
+              program: options.bin,
+              request: "launch",
+              skipFiles: ["<node_internals>/**"],
+              type: "node"
+            }
+          ] : [],
+          settings: {
+            "typescript.tsdk": "node_modules/typescript/lib"
+          },
+          tasks: [
+            {
+              detail: "Build the project",
+              label: "build",
+              script: "build",
+              type: "npm"
+            }
+          ]
+        })
+      ],
+      files: {
+        "tsconfig.json": JSON.stringify({
+          compilerOptions: {
+            declaration: true,
+            declarationMap: true,
+            esModuleInterop: true,
+            module: "NodeNext",
+            moduleResolution: "NodeNext",
+            noEmit: true,
+            resolveJsonModule: true,
+            skipLibCheck: true,
+            sourceMap: true,
+            strict: true,
+            target: "ES2022"
+          },
+          include: ["src"]
+        })
+      }
+    };
+  }
+});
+export {
+  blockTypeScript
+};
+//# sourceMappingURL=blockTypeScript.js.map

package/lib/next/blocks/blockTypeScript.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/next/blocks/blockTypeScript.ts"],"sourcesContent":["import { base } from \"../base.js\";\nimport { blockDevelopmentDocs } from \"./blockDevelopmentDocs.js\";\nimport { blockExampleFiles } from \"./blockExampleFiles.js\";\nimport { blockGitHubActionsCI } from \"./blockGitHubActionsCI.js\";\nimport { blockGitignore } from \"./blockGitignore.js\";\nimport { blockMarkdownlint } from \"./blockMarkdownlint.js\";\nimport { blockPackageJson } from \"./blockPackageJson.js\";\nimport { blockVitest } from \"./blockVitest.js\";\nimport { blockVSCode } from \"./blockVSCode.js\";\nimport { getPackageDependencies } from \"./packageData.js\";\n\nexport const blockTypeScript = base.createBlock({\n\tabout: {\n\t\tname: \"TypeScript\",\n\t},\n\tproduce({ options }) {\n\t\treturn {\n\t\t\taddons: [\n\t\t\t\tblockDevelopmentDocs({\n\t\t\t\t\tsections: {\n\t\t\t\t\t\t\"Type Checking\": {\n\t\t\t\t\t\t\tcontents: `\nYou should be able to see suggestions from [TypeScript](https://typescriptlang.org) in your editor for all open files.\n\nHowever, it can be useful to run the TypeScript command-line (\\`tsc\\`) to type check all files in \\`src/\\`:\n\n\\`\\`\\`shell\npnpm tsc\n\\`\\`\\`\n\nAdd \\`--watch\\` to keep the type checker running in a watch mode that updates the display as you save files:\n\n\\`\\`\\`shell\npnpm tsc --watch\n\\`\\`\\`\n`,\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t\tblockExampleFiles({\n\t\t\t\t\tfiles: {\n\t\t\t\t\t\t\"greet.ts\": `import { GreetOptions } from \"./types.js\";\n\t\n\texport function greet(options: GreetOptions | string) {\n\t\tconst {\n\t\t\tlogger = console.log.bind(console),\n\t\t\tmessage,\n\t\t\ttimes = 1,\n\t\t} = typeof options === \"string\" ? { message: options } : options;\n\t\n\t\tfor (let i = 0; i < times; i += 1) {\n\t\t\tlogger(message);\n\t\t}\n\t}\n\t`,\n\t\t\t\t\t\t\"index.ts\": `export * from \"./greet.js\";\nexport * from \"./types.js\";\n`,\n\t\t\t\t\t\t\"types.ts\": `export interface GreetOptions {\n\t\tlogger?: (message: string) => void;\n\t\tmessage: string;\n\t\ttimes?: number;\n\t}\n\t`,\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t\tblockGitignore({\n\t\t\t\t\tignores: [\"/lib\"],\n\t\t\t\t}),\n\t\t\t\tblockGitHubActionsCI({\n\t\t\t\t\tjobs: [{ name: \"Type Check\", steps: [{ run: \"pnpm tsc\" }] }],\n\t\t\t\t}),\n\t\t\t\tblockMarkdownlint({\n\t\t\t\t\tignores: [\"lib/\"],\n\t\t\t\t}),\n\t\t\t\tblockPackageJson({\n\t\t\t\t\tproperties: {\n\t\t\t\t\t\tdevDependencies: getPackageDependencies(\"typescript\"),\n\t\t\t\t\t\tfiles: [\"lib/\"],\n\t\t\t\t\t\tmain: \"./lib/index.js\",\n\t\t\t\t\t\tscripts: {\n\t\t\t\t\t\t\ttsc: \"tsc\",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t\tblockVitest({\n\t\t\t\t\texclude: [\"lib\"],\n\t\t\t\t\tinclude: [\"src\"],\n\t\t\t\t}),\n\t\t\t\tblockVSCode({\n\t\t\t\t\tdebuggers: options.bin\n\t\t\t\t\t\t? [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tname: \"Debug Program\",\n\t\t\t\t\t\t\t\t\tpreLaunchTask: \"build\",\n\t\t\t\t\t\t\t\t\tprogram: options.bin,\n\t\t\t\t\t\t\t\t\trequest: \"launch\",\n\t\t\t\t\t\t\t\t\tskipFiles: [\"<node_internals>/**\"],\n\t\t\t\t\t\t\t\t\ttype: \"node\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t: [],\n\t\t\t\t\tsettings: {\n\t\t\t\t\t\t\"typescript.tsdk\": \"node_modules/typescript/lib\",\n\t\t\t\t\t},\n\t\t\t\t\ttasks: [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tdetail: \"Build the project\",\n\t\t\t\t\t\t\tlabel: \"build\",\n\t\t\t\t\t\t\tscript: \"build\",\n\t\t\t\t\t\t\ttype: \"npm\",\n\t\t\t\t\t\t},\n\t\t\t\t\t],\n\t\t\t\t}),\n\t\t\t],\n\t\t\tfiles: {\n\t\t\t\t\"tsconfig.json\": JSON.stringify({\n\t\t\t\t\tcompilerOptions: {\n\t\t\t\t\t\tdeclaration: true,\n\t\t\t\t\t\tdeclarationMap: true,\n\t\t\t\t\t\tesModuleInterop: true,\n\t\t\t\t\t\tmodule: \"NodeNext\",\n\t\t\t\t\t\tmoduleResolution: \"NodeNext\",\n\t\t\t\t\t\tnoEmit: true,\n\t\t\t\t\t\tresolveJsonModule: true,\n\t\t\t\t\t\tskipLibCheck: true,\n\t\t\t\t\t\tsourceMap: true,\n\t\t\t\t\t\tstrict: true,\n\t\t\t\t\t\ttarget: \"ES2022\",\n\t\t\t\t\t},\n\t\t\t\t\tinclude: [\"src\"],\n\t\t\t\t}),\n\t\t\t},\n\t\t};\n\t},\n});\n"],"mappings":"AAAA,SAAS,YAAY;AACrB,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAClC,SAAS,4BAA4B;AACrC,SAAS,sBAAsB;AAC/B,SAAS,yBAAyB;AAClC,SAAS,wBAAwB;AACjC,SAAS,mBAAmB;AAC5B,SAAS,mBAAmB;AAC5B,SAAS,8BAA8B;AAEhC,MAAM,kBAAkB,KAAK,YAAY;AAAA,EAC/C,OAAO;AAAA,IACN,MAAM;AAAA,EACP;AAAA,EACA,QAAQ,EAAE,QAAQ,GAAG;AACpB,WAAO;AAAA,MACN,QAAQ;AAAA,QACP,qBAAqB;AAAA,UACpB,UAAU;AAAA,YACT,iBAAiB;AAAA,cAChB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAeX;AAAA,UACD;AAAA,QACD,CAAC;AAAA,QACD,kBAAkB;AAAA,UACjB,OAAO;AAAA,YACN,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,YAcZ,YAAY;AAAA;AAAA;AAAA,YAGZ,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,UAMb;AAAA,QACD,CAAC;AAAA,QACD,eAAe;AAAA,UACd,SAAS,CAAC,MAAM;AAAA,QACjB,CAAC;AAAA,QACD,qBAAqB;AAAA,UACpB,MAAM,CAAC,EAAE,MAAM,cAAc,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAAC;AAAA,QAC5D,CAAC;AAAA,QACD,kBAAkB;AAAA,UACjB,SAAS,CAAC,MAAM;AAAA,QACjB,CAAC;AAAA,QACD,iBAAiB;AAAA,UAChB,YAAY;AAAA,YACX,iBAAiB,uBAAuB,YAAY;AAAA,YACpD,OAAO,CAAC,MAAM;AAAA,YACd,MAAM;AAAA,YACN,SAAS;AAAA,cACR,KAAK;AAAA,YACN;AAAA,UACD;AAAA,QACD,CAAC;AAAA,QACD,YAAY;AAAA,UACX,SAAS,CAAC,KAAK;AAAA,UACf,SAAS,CAAC,KAAK;AAAA,QAChB,CAAC;AAAA,QACD,YAAY;AAAA,UACX,WAAW,QAAQ,MAChB;AAAA,YACA;AAAA,cACC,MAAM;AAAA,cACN,eAAe;AAAA,cACf,SAAS,QAAQ;AAAA,cACjB,SAAS;AAAA,cACT,WAAW,CAAC,qBAAqB;AAAA,cACjC,MAAM;AAAA,YACP;AAAA,UACD,IACC,CAAC;AAAA,UACJ,UAAU;AAAA,YACT,mBAAmB;AAAA,UACpB;AAAA,UACA,OAAO;AAAA,YACN;AAAA,cACC,QAAQ;AAAA,cACR,OAAO;AAAA,cACP,QAAQ;AAAA,cACR,MAAM;AAAA,YACP;AAAA,UACD;AAAA,QACD,CAAC;AAAA,MACF;AAAA,MACA,OAAO;AAAA,QACN,iBAAiB,KAAK,UAAU;AAAA,UAC/B,iBAAiB;AAAA,YAChB,aAAa;AAAA,YACb,gBAAgB;AAAA,YAChB,iBAAiB;AAAA,YACjB,QAAQ;AAAA,YACR,kBAAkB;AAAA,YAClB,QAAQ;AAAA,YACR,mBAAmB;AAAA,YACnB,cAAc;AAAA,YACd,WAAW;AAAA,YACX,QAAQ;AAAA,YACR,QAAQ;AAAA,UACT;AAAA,UACA,SAAS,CAAC,KAAK;AAAA,QAChB,CAAC;AAAA,MACF;AAAA,IACD;AAAA,EACD;AACD,CAAC;","names":[]}

package/lib/next/blocks/blockVSCode.d.ts

@@ -0,0 +1,57 @@
+import * as create from 'create';
+
+declare const blockVSCode: create.BlockWithAddons<{
+    settings: Record<string, unknown>;
+    debuggers?: (Record<string, unknown> & {
+        name: string;
+    })[] | undefined;
+    extensions?: string[] | undefined;
+    tasks?: ({
+        detail: string;
+    } & Record<string, unknown>)[] | undefined;
+}, {
+    description: string;
+    email: {
+        github: string;
+        npm: string;
+    };
+    title: string;
+    owner: string;
+    repository: string;
+    access?: "public" | "restricted" | undefined;
+    author?: string | undefined;
+    bin?: string | undefined;
+    login?: string | undefined;
+    contributors?: {
+        name: string;
+        avatar_url: string;
+        contributions: string[];
+        login: string;
+        profile: string;
+    }[] | undefined;
+    documentation?: string | undefined;
+    funding?: string | undefined;
+    guide?: {
+        href: string;
+        title: string;
+    } | undefined;
+    hideTemplatedBy?: boolean | undefined;
+    keywords?: string[] | undefined;
+    logo?: {
+        alt: string;
+        src: string;
+    } | undefined;
+    node?: {
+        minimum: string;
+        pinned?: string | undefined;
+    } | undefined;
+    packageData?: {
+        dependencies?: Record<string, string> | undefined;
+        devDependencies?: Record<string, string> | undefined;
+        scripts?: Record<string, string> | undefined;
+    } | undefined;
+    preserveGeneratedFrom?: boolean | undefined;
+    version?: string | undefined;
+}>;
+
+export { blockVSCode };

package/lib/next/blocks/blockVSCode.js

@@ -0,0 +1,91 @@
+import { z } from "zod";
+import { base } from "../base.js";
+import { sortObject } from "../utils/sortObject.js";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
+const blockVSCode = base.createBlock({
+  about: {
+    name: "VS Code"
+  },
+  addons: {
+    debuggers: z.array(
+      z.intersection(
+        z.record(z.string(), z.unknown()),
+        z.object({ name: z.string() })
+      )
+    ).optional(),
+    extensions: z.array(z.string()).optional(),
+    settings: z.record(z.string(), z.unknown()).default({}),
+    tasks: z.array(
+      z.intersection(
+        z.object({ detail: z.string() }),
+        z.record(z.string(), z.unknown())
+      )
+    ).optional()
+  },
+  produce({ addons, options }) {
+    const { debuggers, extensions, settings, tasks } = addons;
+    return {
+      addons: [
+        blockDevelopmentDocs({
+          hints: [
+            `> This repository includes a list of suggested VS Code extensions.`,
+            `> It's a good idea to use [VS Code](https://code.visualstudio.com) and accept its suggestion to install them, as they'll help with development.`
+          ],
+          sections: {
+            Building: {
+              innerSections: options.bin ? [
+                {
+                  contents: `
+This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging.
+To debug a \`bin\` app, add a breakpoint to your code, then run _Debug Program_ from the VS Code Debug panel (or press F5).
+VS Code will automatically run the \`build\` task in the background before running \`${options.bin}\`.
+`,
+                  heading: "Built App Debugging"
+                }
+              ] : []
+            },
+            Testing: {
+              innerSections: [
+                {
+                  contents: `
+This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging unit tests.
+To launch it, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).
+`,
+                  heading: "Debugging Tests"
+                }
+              ]
+            }
+          }
+        })
+      ],
+      files: {
+        ".vscode": {
+          "extensions.json": extensions && JSON.stringify({
+            recommendations: [...extensions].sort()
+          }),
+          "launch.json": debuggers && JSON.stringify({
+            configurations: [...debuggers].sort(
+              (a, b) => a.name.localeCompare(b.name)
+            ),
+            version: "0.2.0"
+          }),
+          "settings.json": JSON.stringify(
+            sortObject({
+              "editor.formatOnSave": true,
+              "editor.rulers": [80],
+              ...settings
+            })
+          ),
+          "tasks.json": tasks && JSON.stringify({
+            tasks: tasks.sort((a, b) => a.detail.localeCompare(b.detail)),
+            version: "2.0.0"
+          })
+        }
+      }
+    };
+  }
+});
+export {
+  blockVSCode
+};
+//# sourceMappingURL=blockVSCode.js.map

package/lib/next/blocks/blockVSCode.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/next/blocks/blockVSCode.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { base } from \"../base.js\";\nimport { sortObject } from \"../utils/sortObject.js\";\nimport { blockDevelopmentDocs } from \"./blockDevelopmentDocs.js\";\n\nexport const blockVSCode = base.createBlock({\n\tabout: {\n\t\tname: \"VS Code\",\n\t},\n\taddons: {\n\t\tdebuggers: z\n\t\t\t.array(\n\t\t\t\tz.intersection(\n\t\t\t\t\tz.record(z.string(), z.unknown()),\n\t\t\t\t\tz.object({ name: z.string() }),\n\t\t\t\t),\n\t\t\t)\n\t\t\t.optional(),\n\t\textensions: z.array(z.string()).optional(),\n\t\tsettings: z.record(z.string(), z.unknown()).default({}),\n\t\ttasks: z\n\t\t\t.array(\n\t\t\t\tz.intersection(\n\t\t\t\t\tz.object({ detail: z.string() }),\n\t\t\t\t\tz.record(z.string(), z.unknown()),\n\t\t\t\t),\n\t\t\t)\n\t\t\t.optional(),\n\t},\n\tproduce({ addons, options }) {\n\t\tconst { debuggers, extensions, settings, tasks } = addons;\n\n\t\treturn {\n\t\t\taddons: [\n\t\t\t\tblockDevelopmentDocs({\n\t\t\t\t\thints: [\n\t\t\t\t\t\t`> This repository includes a list of suggested VS Code extensions.`,\n\t\t\t\t\t\t`> It's a good idea to use [VS Code](https://code.visualstudio.com) and accept its suggestion to install them, as they'll help with development.`,\n\t\t\t\t\t],\n\t\t\t\t\tsections: {\n\t\t\t\t\t\tBuilding: {\n\t\t\t\t\t\t\tinnerSections: options.bin\n\t\t\t\t\t\t\t\t? [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\tcontents: `\nThis repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging.\nTo debug a \\`bin\\` app, add a breakpoint to your code, then run _Debug Program_ from the VS Code Debug panel (or press F5).\nVS Code will automatically run the \\`build\\` task in the background before running \\`${options.bin}\\`.\n`,\n\t\t\t\t\t\t\t\t\t\t\theading: \"Built App Debugging\",\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t: [],\n\t\t\t\t\t\t},\n\t\t\t\t\t\tTesting: {\n\t\t\t\t\t\t\tinnerSections: [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\tcontents: `\nThis repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging unit tests.\nTo launch it, open a test file, then run _Debug Current Test File_ from the VS Code Debug panel (or press F5).\n`,\n\t\t\t\t\t\t\t\t\theading: \"Debugging Tests\",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}),\n\t\t\t],\n\t\t\tfiles: {\n\t\t\t\t\".vscode\": {\n\t\t\t\t\t\"extensions.json\":\n\t\t\t\t\t\textensions &&\n\t\t\t\t\t\tJSON.stringify({\n\t\t\t\t\t\t\trecommendations: [...extensions].sort(),\n\t\t\t\t\t\t}),\n\t\t\t\t\t\"launch.json\":\n\t\t\t\t\t\tdebuggers &&\n\t\t\t\t\t\tJSON.stringify({\n\t\t\t\t\t\t\tconfigurations: [...debuggers].sort((a, b) =>\n\t\t\t\t\t\t\t\ta.name.localeCompare(b.name),\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t\tversion: \"0.2.0\",\n\t\t\t\t\t\t}),\n\t\t\t\t\t\"settings.json\": JSON.stringify(\n\t\t\t\t\t\tsortObject({\n\t\t\t\t\t\t\t\"editor.formatOnSave\": true,\n\t\t\t\t\t\t\t\"editor.rulers\": [80],\n\t\t\t\t\t\t\t...settings,\n\t\t\t\t\t\t}),\n\t\t\t\t\t),\n\t\t\t\t\t\"tasks.json\":\n\t\t\t\t\t\ttasks &&\n\t\t\t\t\t\tJSON.stringify({\n\t\t\t\t\t\t\ttasks: tasks.sort((a, b) => a.detail.localeCompare(b.detail)),\n\t\t\t\t\t\t\tversion: \"2.0.0\",\n\t\t\t\t\t\t}),\n\t\t\t\t},\n\t\t\t},\n\t\t};\n\t},\n});\n"],"mappings":"AAAA,SAAS,SAAS;AAElB,SAAS,YAAY;AACrB,SAAS,kBAAkB;AAC3B,SAAS,4BAA4B;AAE9B,MAAM,cAAc,KAAK,YAAY;AAAA,EAC3C,OAAO;AAAA,IACN,MAAM;AAAA,EACP;AAAA,EACA,QAAQ;AAAA,IACP,WAAW,EACT;AAAA,MACA,EAAE;AAAA,QACD,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC;AAAA,QAChC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAAA,MAC9B;AAAA,IACD,EACC,SAAS;AAAA,IACX,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS;AAAA,IACzC,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;AAAA,IACtD,OAAO,EACL;AAAA,MACA,EAAE;AAAA,QACD,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAAA,QAC/B,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC;AAAA,MACjC;AAAA,IACD,EACC,SAAS;AAAA,EACZ;AAAA,EACA,QAAQ,EAAE,QAAQ,QAAQ,GAAG;AAC5B,UAAM,EAAE,WAAW,YAAY,UAAU,MAAM,IAAI;AAEnD,WAAO;AAAA,MACN,QAAQ;AAAA,QACP,qBAAqB;AAAA,UACpB,OAAO;AAAA,YACN;AAAA,YACA;AAAA,UACD;AAAA,UACA,UAAU;AAAA,YACT,UAAU;AAAA,cACT,eAAe,QAAQ,MACpB;AAAA,gBACA;AAAA,kBACC,UAAU;AAAA;AAAA;AAAA,uFAGkE,QAAQ,GAAG;AAAA;AAAA,kBAEvF,SAAS;AAAA,gBACV;AAAA,cACD,IACC,CAAC;AAAA,YACL;AAAA,YACA,SAAS;AAAA,cACR,eAAe;AAAA,gBACd;AAAA,kBACC,UAAU;AAAA;AAAA;AAAA;AAAA,kBAIV,SAAS;AAAA,gBACV;AAAA,cACD;AAAA,YACD;AAAA,UACD;AAAA,QACD,CAAC;AAAA,MACF;AAAA,MACA,OAAO;AAAA,QACN,WAAW;AAAA,UACV,mBACC,cACA,KAAK,UAAU;AAAA,YACd,iBAAiB,CAAC,GAAG,UAAU,EAAE,KAAK;AAAA,UACvC,CAAC;AAAA,UACF,eACC,aACA,KAAK,UAAU;AAAA,YACd,gBAAgB,CAAC,GAAG,SAAS,EAAE;AAAA,cAAK,CAAC,GAAG,MACvC,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,YAC5B;AAAA,YACA,SAAS;AAAA,UACV,CAAC;AAAA,UACF,iBAAiB,KAAK;AAAA,YACrB,WAAW;AAAA,cACV,uBAAuB;AAAA,cACvB,iBAAiB,CAAC,EAAE;AAAA,cACpB,GAAG;AAAA,YACJ,CAAC;AAAA,UACF;AAAA,UACA,cACC,SACA,KAAK,UAAU;AAAA,YACd,OAAO,MAAM,KAAK,CAAC,GAAG,MAAM,EAAE,OAAO,cAAc,EAAE,MAAM,CAAC;AAAA,YAC5D,SAAS;AAAA,UACV,CAAC;AAAA,QACH;AAAA,MACD;AAAA,IACD;AAAA,EACD;AACD,CAAC;","names":[]}

package/lib/next/blocks/blockVitest.d.ts

@@ -0,0 +1,55 @@
+import * as create from 'create';
+
+declare const blockVitest: create.BlockWithAddons<{
+    coverage: {
+        directory: string;
+        flags?: string | undefined;
+    };
+    exclude: string[];
+    include: string[];
+}, {
+    description: string;
+    email: {
+        github: string;
+        npm: string;
+    };
+    title: string;
+    owner: string;
+    repository: string;
+    access?: "public" | "restricted" | undefined;
+    author?: string | undefined;
+    bin?: string | undefined;
+    login?: string | undefined;
+    contributors?: {
+        name: string;
+        avatar_url: string;
+        contributions: string[];
+        login: string;
+        profile: string;
+    }[] | undefined;
+    documentation?: string | undefined;
+    funding?: string | undefined;
+    guide?: {
+        href: string;
+        title: string;
+    } | undefined;
+    hideTemplatedBy?: boolean | undefined;
+    keywords?: string[] | undefined;
+    logo?: {
+        alt: string;
+        src: string;
+    } | undefined;
+    node?: {
+        minimum: string;
+        pinned?: string | undefined;
+    } | undefined;
+    packageData?: {
+        dependencies?: Record<string, string> | undefined;
+        devDependencies?: Record<string, string> | undefined;
+        scripts?: Record<string, string> | undefined;
+    } | undefined;
+    preserveGeneratedFrom?: boolean | undefined;
+    version?: string | undefined;
+}>;
+
+export { blockVitest };

package/lib/next/blocks/blockVitest.js

@@ -0,0 +1,217 @@
+import { z } from "zod";
+import { base } from "../base.js";
+import { blockCSpell } from "./blockCSpell.js";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
+import { blockESLint } from "./blockESLint.js";
+import { blockExampleFiles } from "./blockExampleFiles.js";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
+import { blockGitignore } from "./blockGitignore.js";
+import { blockPackageJson } from "./blockPackageJson.js";
+import { blockPrettier } from "./blockPrettier.js";
+import { blockTSup } from "./blockTSup.js";
+import { blockVSCode } from "./blockVSCode.js";
+import { getPackageDependencies } from "./packageData.js";
+import { CommandPhase } from "./phases.js";
+const blockVitest = base.createBlock({
+  about: {
+    name: "Vitest"
+  },
+  addons: {
+    coverage: z.object({
+      directory: z.string(),
+      flags: z.string().optional()
+    }).default({ directory: "coverage" }),
+    exclude: z.array(z.string()).default([]),
+    include: z.array(z.string()).default([])
+  },
+  migrate() {
+    return {
+      scripts: [
+        {
+          commands: [
+            "rm .github/codecov.yml .mocha* codecov.yml jest.config.*"
+          ],
+          phase: CommandPhase.Migrations
+        }
+      ]
+    };
+  },
+  produce({ addons }) {
+    const { coverage, exclude = [], include = [] } = addons;
+    const excludeText = JSON.stringify(exclude);
+    const includeText = JSON.stringify(include);
+    return {
+      addons: [
+        blockCSpell({
+          ignores: [coverage.directory]
+        }),
+        blockESLint({
+          extensions: [
+            {
+              extends: ["vitest.configs.recommended"],
+              files: ["**/*.test.*"],
+              rules: [
+                {
+                  entries: {
+                    "@typescript-eslint/no-unsafe-assignment": "off"
+                  }
+                }
+              ]
+            }
+          ],
+          ignores: [coverage.directory, "**/*.snap"],
+          imports: [{ source: "@vitest/eslint-plugin", specifier: "vitest" }]
+        }),
+        blockDevelopmentDocs({
+          sections: {
+            Testing: {
+              contents: `
+[Vitest](https://vitest.dev) is used for tests.
+You can run it locally on the command-line:
+
+\`\`\`shell
+pnpm run test
+\`\`\`
+
+Add the \`--coverage\` flag to compute test coverage and place reports in the \`coverage/\` directory:
+
+\`\`\`shell
+pnpm run test --coverage
+\`\`\`
+
+Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
+Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.
+
+
+		`
+            }
+          }
+        }),
+        blockExampleFiles({
+          files: {
+            "greet.test.ts": `import { describe, expect, it, vi } from "vitest";
+
+import { greet } from "./greet.js";
+
+const message = "Yay, testing!";
+
+describe("greet", () => {
+	it("logs to the console once when message is provided as a string", () => {
+		const logger = vi.spyOn(console, "log").mockImplementation(() => undefined);
+
+		greet(message);
+
+		expect(logger).toHaveBeenCalledWith(message);
+		expect(logger).toHaveBeenCalledTimes(1);
+	});
+
+	it("logs to the console once when message is provided as an object", () => {
+		const logger = vi.spyOn(console, "log").mockImplementation(() => undefined);
+
+		greet({ message });
+
+		expect(logger).toHaveBeenCalledWith(message);
+		expect(logger).toHaveBeenCalledTimes(1);
+	});
+
+	it("logs once when times is not provided in an object", () => {
+		const logger = vi.fn();
+
+		greet({ logger, message });
+
+		expect(logger).toHaveBeenCalledWith(message);
+		expect(logger).toHaveBeenCalledTimes(1);
+	});
+
+	it("logs a specified number of times when times is provided", () => {
+		const logger = vi.fn();
+		const times = 7;
+
+		greet({ logger, message, times });
+
+		expect(logger).toHaveBeenCalledWith(message);
+		expect(logger).toHaveBeenCalledTimes(7);
+	});
+});
+`
+          }
+        }),
+        blockGitignore({
+          ignores: [`/${coverage.directory}`]
+        }),
+        blockGitHubActionsCI({
+          jobs: [
+            {
+              name: "Test",
+              steps: [
+                { run: "pnpm run test --coverage" },
+                {
+                  if: "always()",
+                  uses: "codecov/codecov-action@v3",
+                  ...coverage.flags && { with: { flags: coverage.flags } }
+                }
+              ]
+            }
+          ]
+        }),
+        blockPackageJson({
+          properties: {
+            devDependencies: getPackageDependencies(
+              "@vitest/coverage-v8",
+              "@vitest/eslint-plugin",
+              "console-fail-test",
+              "vitest"
+            ),
+            scripts: {
+              test: "vitest"
+            }
+          }
+        }),
+        blockPrettier({
+          ignores: [`/${coverage.directory}`]
+        }),
+        blockTSup({
+          entry: ["!src/**/*.test.*"]
+        }),
+        blockVSCode({
+          debuggers: [
+            {
+              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"
+            }
+          ],
+          extensions: ["vitest.explorer"]
+        })
+      ],
+      files: {
+        "vitest.config.ts": `import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+	test: {
+		clearMocks: true,
+		coverage: {
+			all: true,
+			exclude: ${excludeText},
+			include: ${includeText},
+			reporter: ["html", "lcov"],
+		},
+		exclude: [${excludeText.slice(1, excludeText.length - 1)}, "node_modules"],
+		setupFiles: ["console-fail-test/setup"],
+	},
+});
+	`
+      }
+    };
+  }
+});
+export {
+  blockVitest
+};
+//# sourceMappingURL=blockVitest.js.map