create-typescript-app 2.64.0 → 2.65.0

package/dist/blocks/blockESLint.mjs

@@ -0,0 +1,196 @@
+import { intakeFile } from "./intake/intakeFile.mjs";
+import { getPackageDependencies } from "../data/packageData.mjs";
+import { base } from "../base.mjs";
+import { CommandPhase } from "./phases.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.mjs";
+import { blockRemoveWorkflows } from "./blockRemoveWorkflows.mjs";
+import { blockVSCode } from "./blockVSCode.mjs";
+import { blockRemoveDependencies } from "./blockRemoveDependencies.mjs";
+import { getScriptFileExtension } from "./eslint/getScriptFileExtension.mjs";
+import { zExtension, zPackageImport } from "./eslint/schemas.mjs";
+import { blockESLintIntake } from "./eslint/blockESLintIntake.mjs";
+import { mergeAllExtensions } from "./eslint/mergeAllExtensions.mjs";
+import { z } from "zod";
+import sortKeys from "sort-keys";
+import { parse } from "parse-package-name";
+//#region src/blocks/blockESLint.ts
+const blockESLint = base.createBlock({
+	about: { name: "ESLint" },
+	addons: {
+		beforeLint: z.string().optional(),
+		explanations: z.array(z.string()).default([]),
+		extensions: z.array(zExtension).default([]),
+		ignores: z.array(z.string()).default([]),
+		imports: z.array(zPackageImport).default([])
+	},
+	intake({ files }) {
+		const eslintConfigRaw = intakeFile(files, [[
+			"eslint.config.ts",
+			"eslint.config.mts",
+			"eslint.config.js",
+			"eslint.config.mjs"
+		]]);
+		return eslintConfigRaw ? blockESLintIntake(eslintConfigRaw[0]) : void 0;
+	},
+	produce({ addons, options }) {
+		const { explanations, extensions, ignores, imports } = addons;
+		const configFileName = options.type === "commonjs" ? "eslint.config.mts" : "eslint.config.ts";
+		const explanation = explanations.length > 0 ? `${explanations.map((explanation) => `/*\n${explanation}\n*/\n`).join("")}\n` : "";
+		const importLines = [
+			"import eslint from \"@eslint/js\";",
+			"import { defineConfig, globalIgnores } from \"eslint/config\";",
+			"import tseslint from \"typescript-eslint\";",
+			...imports.map((packageImport) => `import ${packageImport.specifier} from "${typeof packageImport.source === "string" ? packageImport.source : packageImport.source.packageName}"`)
+		].sort((a, b) => a.replace(/.+from/, "").localeCompare(b.replace(/.+from/, "")));
+		const ignoreLines = Array.from(new Set([
+			"dist",
+			"node_modules",
+			"pnpm-lock.yaml",
+			...ignores
+		].map((ignore) => JSON.stringify(ignore)))).sort();
+		const extensionLines = mergeAllExtensions({
+			extends: [
+				"eslint.configs.recommended",
+				"tseslint.configs.strictTypeChecked",
+				"tseslint.configs.stylisticTypeChecked"
+			],
+			files: [getScriptFileExtension(options)],
+			languageOptions: { parserOptions: { projectService: { allowDefaultProject: Array.from(new Set(["*.config.*s", ...typeof options.bin === "object" ? Object.values(options.bin) : [options.bin]].filter(Boolean).sort())) } } }
+		}, ...extensions, ...options.type === "commonjs" ? [{
+			files: ["*.mjs"],
+			languageOptions: { sourceType: "module" }
+		}] : []).sort((a, b) => processForSort(a.files).localeCompare(processForSort(b.files))).map(printExtension);
+		return {
+			addons: [
+				blockDevelopmentDocs({ sections: { Linting: { contents: {
+					after: [`
+For example, ESLint can be run with \`--fix\` to auto-fix some lint rule complaints:
+
+\`\`\`shell
+pnpm run lint --fix
+\`\`\`
+`, ...addons.beforeLint ? [addons.beforeLint] : []],
+					before: `
+This package includes several forms of linting to enforce consistent code quality and styling.
+Each should be shown in VS Code, and can be run manually on the command-line:
+`,
+					items: [`- \`pnpm lint\` ([ESLint](https://eslint.org) with [typescript-eslint](https://typescript-eslint.io)): Lints source files, including JavaScript, Markdown, and TypeScript`],
+					plural: `Read the individual documentation for each linter to understand how it can be configured and used best.`
+				} } } }),
+				blockGitHubActionsCI({ jobs: [{
+					name: "Lint",
+					steps: [...options.bin ? [{ run: "pnpm build" }] : [], { run: "pnpm lint" }]
+				}] }),
+				blockPackageJson({ properties: {
+					devDependencies: {
+						...getPackageDependencies("@eslint/js", "@types/node", "eslint", "typescript-eslint", ...imports.filter((imported) => typeof imported.source === "string").flatMap(({ source, types }) => {
+							const { name } = parse(source);
+							return types ? [name, `@types/${name}`] : [name];
+						})),
+						...Object.fromEntries(imports.filter((imported) => typeof imported.source === "object").map((imported) => [imported.source.packageName, imported.source.version]))
+					},
+					scripts: { lint: "eslint . --max-warnings 0" }
+				} }),
+				blockVSCode({
+					extensions: ["dbaeumer.vscode-eslint"],
+					settings: {
+						"editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit" },
+						"eslint.probe": [
+							"javascript",
+							"javascriptreact",
+							"json",
+							"jsonc",
+							"markdown",
+							"typescript",
+							"typescriptreact",
+							"yaml"
+						],
+						"eslint.rules.customizations": [{
+							rule: "*",
+							severity: "warn"
+						}]
+					}
+				})
+			],
+			files: { [configFileName]: `${explanation}${importLines.join("\n")}
+
+export default defineConfig(
+	globalIgnores( [${ignoreLines.join(", ")}], "Global Ignores" ),
+	{ linterOptions: { reportUnusedDisableDirectives: "error" } },
+	${extensionLines.join(",")}
+);` },
+			scripts: [{
+				commands: ["pnpm lint --fix"],
+				phase: CommandPhase.Process
+			}]
+		};
+	},
+	transition({ options }) {
+		return { addons: [
+			blockRemoveDependencies({ dependencies: [
+				"@types/eslint",
+				"@typescript-eslint/eslint-plugin",
+				"@typescript-eslint/parser",
+				"eslint-plugin-deprecation",
+				"eslint-plugin-eslint-comments",
+				"eslint-plugin-no-only-tests",
+				"yaml-eslint-parser"
+			] }),
+			blockRemoveFiles({ files: [
+				".eslintrc*",
+				".eslintignore",
+				options.type === "commonjs" ? "eslint.config.{cjs,js}" : "eslint.config.{cjs,mjs}"
+			] }),
+			blockRemoveWorkflows({ workflows: ["eslint", "lint"] })
+		] };
+	}
+});
+function groupByComment(rulesGroups) {
+	const byComment = /* @__PURE__ */ new Map();
+	const grouped = [];
+	for (const group of rulesGroups) {
+		const existing = byComment.get(group.comment);
+		if (existing) {
+			existing.entries = {
+				...existing.entries,
+				...group.entries
+			};
+			continue;
+		} else {
+			byComment.set(group.comment, group);
+			grouped.push(group);
+		}
+	}
+	return grouped;
+}
+function printExtension(extension) {
+	return [
+		"{",
+		extension.extends && `extends: [${extension.extends.join(", ")}],`,
+		`files: [${extension.files.map((glob) => JSON.stringify(glob)).join(", ")}],`,
+		extension.languageOptions && `languageOptions: ${JSON.stringify(extension.languageOptions).replace("\"import.meta.dirname\"", "import.meta.dirname")},`,
+		extension.linterOptions && `linterOptions: ${JSON.stringify(extension.linterOptions)}`,
+		extension.rules && `rules: ${printExtensionRules(extension.rules)},`,
+		extension.settings && `settings: ${JSON.stringify(sortKeys(extension.settings))},`,
+		"}"
+	].filter(Boolean).join(" ");
+}
+function printExtensionRules(rules) {
+	if (!Array.isArray(rules)) return JSON.stringify(rules);
+	return [
+		"{",
+		...groupByComment(rules).flatMap((group) => [printGroupComment(group.comment), ...Object.entries(group.entries).map(([ruleName, options]) => `"${ruleName}": ${JSON.stringify(options)},`)]),
+		"}"
+	].join("");
+}
+function printGroupComment(comment) {
+	return comment ? `\n\n// ${comment.replaceAll("\n", "\n// ")}\n` : "";
+}
+function processForSort(files) {
+	return files.join("").replaceAll("{", "");
+}
+//#endregion
+export { blockESLint };

package/dist/blocks/blockESLintComments.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintComments.d.ts
+declare const blockESLintComments: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockESLintComments };

package/dist/blocks/blockESLintComments.mjs

@@ -0,0 +1,21 @@
+import { base } from "../base.mjs";
+import { getScriptFileExtension } from "./eslint/getScriptFileExtension.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+//#region src/blocks/blockESLintComments.ts
+const blockESLintComments = base.createBlock({
+	about: { name: "ESLint Comments Plugin" },
+	produce({ options }) {
+		return { addons: [blockESLint({
+			extensions: [{
+				extends: ["comments.recommended"],
+				files: [getScriptFileExtension(options)]
+			}],
+			imports: [{
+				source: "@eslint-community/eslint-plugin-eslint-comments/configs",
+				specifier: "comments"
+			}]
+		})] };
+	}
+});
+//#endregion
+export { blockESLintComments };

package/dist/blocks/blockESLintJSDoc.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintJSDoc.d.ts
+declare const blockESLintJSDoc: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockESLintJSDoc };

package/dist/blocks/blockESLintJSDoc.mjs

@@ -0,0 +1,25 @@
+import { base } from "../base.mjs";
+import { getScriptFileExtension } from "./eslint/getScriptFileExtension.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+//#region src/blocks/blockESLintJSDoc.ts
+const blockESLintJSDoc = base.createBlock({
+	about: { name: "ESLint JSDoc Plugin" },
+	produce({ options }) {
+		return { addons: [blockESLint({
+			extensions: [{
+				extends: [
+					"jsdoc.configs[\"flat/contents-typescript-error\"]",
+					"jsdoc.configs[\"flat/logical-typescript-error\"]",
+					"jsdoc.configs[\"flat/stylistic-typescript-error\"]"
+				],
+				files: [getScriptFileExtension(options)]
+			}],
+			imports: [{
+				source: "eslint-plugin-jsdoc",
+				specifier: "jsdoc"
+			}]
+		})] };
+	}
+});
+//#endregion
+export { blockESLintJSDoc };

package/dist/blocks/blockESLintJSONC.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintJSONC.d.ts
+declare const blockESLintJSONC: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockESLintJSONC };

package/dist/blocks/blockESLintJSONC.mjs

@@ -0,0 +1,20 @@
+import { base } from "../base.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+//#region src/blocks/blockESLintJSONC.ts
+const blockESLintJSONC = base.createBlock({
+	about: { name: "ESLint JSONC Plugin" },
+	produce() {
+		return { addons: [blockESLint({
+			extensions: [{
+				extends: [`jsonc.configs["flat/recommended-with-json"]`],
+				files: ["**/*.json"]
+			}],
+			imports: [{
+				source: "eslint-plugin-jsonc",
+				specifier: "jsonc"
+			}]
+		})] };
+	}
+});
+//#endregion
+export { blockESLintJSONC };

package/dist/blocks/blockESLintMarkdown.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintMarkdown.d.ts
+declare const blockESLintMarkdown: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockESLintMarkdown };

package/dist/blocks/blockESLintMarkdown.mjs

@@ -0,0 +1,36 @@
+import { base } from "../base.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { blockRemoveWorkflows } from "./blockRemoveWorkflows.mjs";
+import { blockRemoveDependencies } from "./blockRemoveDependencies.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+//#region src/blocks/blockESLintMarkdown.ts
+const blockESLintMarkdown = base.createBlock({
+	about: { name: "ESLint Markdown Plugin" },
+	produce() {
+		return { addons: [
+			blockESLint({
+				extensions: [{
+					extends: ["markdown.configs.recommended"],
+					files: ["**/*.md"],
+					rules: [{
+						comment: "https://github.com/eslint/markdown/issues/294",
+						entries: { "markdown/no-missing-label-refs": "off" }
+					}]
+				}],
+				imports: [{
+					source: "@eslint/markdown",
+					specifier: "markdown"
+				}]
+			}),
+			blockRemoveDependencies({ dependencies: [
+				"eslint-plugin-markdown",
+				"markdownlint",
+				"markdownlint-cli"
+			] }),
+			blockRemoveFiles({ files: [".markdownlint*", ".markdownlintignore"] }),
+			blockRemoveWorkflows({ workflows: ["lint_markdown", "lint_md"] })
+		] };
+	}
+});
+//#endregion
+export { blockESLintMarkdown };

package/dist/blocks/blockESLintMarkdownLinks.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintMarkdownLinks.d.ts
+declare const blockESLintMarkdownLinks: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockESLintMarkdownLinks };

package/dist/blocks/blockESLintMarkdownLinks.mjs

@@ -0,0 +1,20 @@
+import { base } from "../base.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+//#region src/blocks/blockESLintMarkdownLinks.ts
+const blockESLintMarkdownLinks = base.createBlock({
+	about: { name: "ESLint Markdown Links Plugin" },
+	produce() {
+		return { addons: [blockESLint({
+			extensions: [{
+				extends: ["markdownLinks.configs.recommended"],
+				files: ["**/*.md"]
+			}],
+			imports: [{
+				source: "eslint-plugin-markdown-links",
+				specifier: "markdownLinks"
+			}]
+		})] };
+	}
+});
+//#endregion
+export { blockESLintMarkdownLinks };