create-typescript-app 2.64.0 → 2.65.0

package/dist/blocks/blockESLintPlugin.mjs

@@ -0,0 +1,230 @@
+import { intakeFile } from "./intake/intakeFile.mjs";
+import { base } from "../base.mjs";
+import { CommandPhase } from "./phases.mjs";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.mjs";
+import { blockCSpell } from "./blockCSpell.mjs";
+import { getScriptFileExtension } from "./eslint/getScriptFileExtension.mjs";
+import { zConfigEmoji } from "./eslint/schemas.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+import { blockREADME } from "./blockREADME.mjs";
+import { blockVitest } from "./blockVitest.mjs";
+import { blockESLintPluginIntake } from "./eslint/blockESLintPluginIntake.mjs";
+//#region src/blocks/blockESLintPlugin.ts
+const blockESLintPlugin = base.createBlock({
+	about: { name: "ESLint Plugin" },
+	addons: { configEmoji: zConfigEmoji },
+	intake({ files }) {
+		const docGeneratorConfigRaw = intakeFile(files, [[".eslint-doc-generatorrc.js", ".eslint-doc-generatorrc.mjs"]]);
+		return docGeneratorConfigRaw ? blockESLintPluginIntake(docGeneratorConfigRaw[0]) : void 0;
+	},
+	produce({ addons, options }) {
+		const { configEmoji } = addons;
+		const configFileName = `.eslint-doc-generatorrc.${options.type === "commonjs" ? "mjs" : "js"}`;
+		const pluginName = options.repository.replace(/^eslint-plugin-/, "").replaceAll(/-\w/g, (matched) => matched[1].toUpperCase());
+		return {
+			addons: [
+				blockCSpell({ words: ["eslint-doc-generatorrc"] }),
+				blockDevelopmentDocs({ sections: {
+					Building: { innerSections: [{
+						contents: `
+Run [\`eslint-doc-generator\`](https://github.com/bmish/eslint-doc-generator) to generate Markdown files documenting rules.
+
+\`\`\`shell
+pnpm build:docs
+\`\`\`
+		`,
+						heading: "Building Docs"
+					}] },
+					Linting: { contents: { items: [`- \`pnpm lint:docs\` ([eslint-doc-generator](https://github.com/bmish/eslint-doc-generator)): Generates and validates documentation for ESLint rules`] } }
+				} }),
+				blockESLint({
+					extensions: [{
+						extends: ["eslintPlugin.configs[\"flat/recommended\"]"],
+						files: [getScriptFileExtension(options)]
+					}],
+					ignores: [configFileName, "docs/rules/*/*.ts"],
+					imports: [{
+						source: {
+							packageName: "eslint-plugin-eslint-plugin",
+							version: "6.4.0"
+						},
+						specifier: "eslintPlugin"
+					}]
+				}),
+				blockGitHubActionsCI({ jobs: [{
+					name: "Lint Docs",
+					steps: [{ run: "pnpm build || exit 0" }, { run: "pnpm lint:docs" }]
+				}] }),
+				blockREADME({ defaultUsage: [`Add this plugin to the list of plugins in your [ESLint configuration file](https://eslint.org/docs/latest/use/configure/configuration-files):
+
+\`\`\`shell
+npm i ${options.repository} -D
+\`\`\`
+
+\`\`\`ts
+import ${pluginName} from "${options.repository}";
+
+export default [
+	// (other plugins)
+	${pluginName}.configs.recommended, // 👈
+];
+\`\`\`
+
+### Rules
+
+These are all set to \`"error"\` in the recommended config:
+
+<!-- begin auto-generated rules list --><!-- end auto-generated rules list -->`] }),
+				blockPackageJson({ properties: {
+					dependencies: { "@typescript-eslint/utils": "^8.29.0" },
+					devDependencies: {
+						"@typescript-eslint/rule-tester": "8.29.1",
+						"eslint-doc-generator": "2.1.0",
+						"eslint-plugin-eslint-plugin": "6.4.0"
+					},
+					scripts: {
+						"build:docs": "pnpm build --no-dts && eslint-doc-generator",
+						"lint:docs": "eslint-doc-generator --check"
+					}
+				} }),
+				blockVitest({ coverage: { exclude: ["src/index.ts", "src/rules/index.ts"] } })
+			],
+			files: { [configFileName]: `import prettier from "prettier";
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+	${configEmoji ? `configEmoji: ${JSON.stringify(configEmoji)},\n\t` : ""}postprocess: async (content, path) =>
+		prettier.format(content, {
+			...(await prettier.resolveConfig(path)),
+			parser: "markdown",
+		}),
+	ruleDocTitleFormat: "name",
+};
+
+export default config;
+` },
+			scripts: [{
+				commands: ["pnpm build"],
+				phase: CommandPhase.Build
+			}, {
+				commands: ["pnpm eslint-doc-generator --init-rule-docs"],
+				phase: CommandPhase.Process
+			}]
+		};
+	},
+	setup({ options }) {
+		const pluginName = options.repository.replace("eslint-plugin-", "");
+		return { files: { src: {
+			"index.ts": `import Module from "node:module";
+
+import { rules } from "./rules/index.ts";
+
+const require = Module.createRequire(import.meta.url);
+
+const { name, version } =
+	// \`import\`ing here would bypass the TSConfig's \`"rootDir": "src"\`
+	require("../package.json") as typeof import("../package.json");
+
+export const plugin = {
+	configs: {
+		get recommended() {
+			return recommended;
+		},
+	},
+	meta: { name, version },
+	rules,
+};
+
+const recommended = {
+	plugins: {
+		"${pluginName}": plugin,
+	},
+	rules: Object.fromEntries(
+		Object.keys(rules).map((rule) => [\`${pluginName}/\${rule}\`, "error"]),
+	),
+};
+
+export { rules };
+
+export default plugin;
+`,
+			rules: {
+				"enums.test.ts": `import { rule } from "./enums.ts";
+import { ruleTester } from "./ruleTester.ts";
+
+ruleTester.run("enums", rule, {
+	invalid: [
+		{
+			code: \`enum Values {}\`,
+			errors: [
+				{
+					column: 1,
+					endColumn: 15,
+					endLine: 1,
+					line: 1,
+					messageId: "enum",
+				},
+			],
+		},
+	],
+	valid: [\`const Values = {};\`, \`const Values = {} as const;\`],
+});
+`,
+				"enums.ts": `import { createRule } from "../utils.ts";
+
+export const rule = createRule({
+	create(context) {
+		return {
+			TSEnumDeclaration(node) {
+				context.report({
+					messageId: "enum",
+					node,
+				});
+			},
+		};
+	},
+	defaultOptions: [],
+	meta: {
+		docs: {
+			description: "Avoid using TypeScript's enums.",
+		},
+		messages: {
+			enum: "This enum will not be allowed under TypeScript's --erasableSyntaxOnly.",
+		},
+		schema: [],
+		type: "problem",
+	},
+	name: "enums",
+});
+`,
+				"index.ts": `import { rule as enums } from "./enums.ts";
+
+export const rules = {
+	enums,
+};
+`,
+				"ruleTester.ts": `import { RuleTester } from "@typescript-eslint/rule-tester";
+import * as vitest from "vitest";
+
+RuleTester.afterAll = vitest.afterAll;
+RuleTester.it = vitest.it;
+RuleTester.itOnly = vitest.it.only;
+RuleTester.describe = vitest.describe;
+
+export const ruleTester = new RuleTester();
+`
+			},
+			"utils.ts": `import { ESLintUtils } from "@typescript-eslint/utils";
+
+export const createRule = ESLintUtils.RuleCreator(
+	(name) =>
+		\`https://github.com/${options.owner}/${options.repository}/blob/main/docs/rules/\${name}.md\`,
+);
+`
+		} } };
+	}
+});
+//#endregion
+export { blockESLintPlugin };

package/dist/blocks/blockESLintRegexp.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintRegexp.d.ts
+declare const blockESLintRegexp: 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 { blockESLintRegexp };

package/dist/blocks/blockESLintRegexp.mjs

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

package/dist/blocks/blockESLintYML.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockESLintYML.d.ts
+declare const blockESLintYML: 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 { blockESLintYML };

package/dist/blocks/blockESLintYML.mjs

@@ -0,0 +1,31 @@
+import { base } from "../base.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+//#region src/blocks/blockESLintYML.ts
+const blockESLintYML = base.createBlock({
+	about: { name: "ESLint YML Plugin" },
+	produce() {
+		return { addons: [blockESLint({
+			extensions: [{
+				extends: ["yml.configs[\"flat/standard\"]", "yml.configs[\"flat/prettier\"]"],
+				files: ["**/*.{yml,yaml}"],
+				rules: {
+					"yml/file-extension": "error",
+					"yml/sort-keys": ["error", {
+						order: { type: "asc" },
+						pathPattern: "^.*$"
+					}],
+					"yml/sort-sequence-values": ["error", {
+						order: { type: "asc" },
+						pathPattern: "^.*$"
+					}]
+				}
+			}],
+			imports: [{
+				source: "eslint-plugin-yml",
+				specifier: "yml"
+			}]
+		})] };
+	}
+});
+//#endregion
+export { blockESLintYML };

package/dist/blocks/blockExampleFiles.d.mts

@@ -0,0 +1,76 @@
+//#region src/blocks/blockExampleFiles.d.ts
+declare const blockExampleFiles: import("bingo-stratum").BlockWithAddons<{
+  usage: string[];
+  files: Record<string, string>;
+}, {
+  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 { blockExampleFiles };

package/dist/blocks/blockExampleFiles.mjs

@@ -0,0 +1,23 @@
+import { base } from "../base.mjs";
+import { blockREADME } from "./blockREADME.mjs";
+import { z } from "zod";
+//#region src/blocks/blockExampleFiles.ts
+const blockExampleFiles = base.createBlock({
+	about: { name: "Example Files" },
+	addons: {
+		files: z.record(z.string()).default({}),
+		usage: z.array(z.string()).default([])
+	},
+	setup({ addons }) {
+		const { usage } = addons;
+		return {
+			addons: [blockREADME({ defaultUsage: usage })],
+			files: { src: addons.files }
+		};
+	},
+	produce() {
+		return {};
+	}
+});
+//#endregion
+export { blockExampleFiles };

package/dist/blocks/blockExports.d.mts

@@ -0,0 +1,76 @@
+//#region src/blocks/blockExports.d.ts
+declare const blockExports: import("bingo-stratum").BlockWithAddons<{
+  runArgs: string[];
+  filePath?: string | undefined;
+}, {
+  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 { blockExports };

package/dist/blocks/blockExports.mjs

@@ -0,0 +1,27 @@
+import { base } from "../base.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { intakeFileAsJson } from "./intake/intakeFileAsJson.mjs";
+import { blockTSDown } from "./blockTSDown.mjs";
+import { z } from "zod";
+//#region src/blocks/blockExports.ts
+const zFilePath = z.string();
+const zExports = z.union([zFilePath, z.object({ ".": zFilePath })]);
+const blockExports = base.createBlock({
+	about: { name: "Exports" },
+	addons: {
+		filePath: zFilePath.optional(),
+		runArgs: z.array(z.string()).default([])
+	},
+	intake({ files }) {
+		const packageData = intakeFileAsJson(files, ["package.json"]);
+		const exports = zExports.safeParse(packageData?.exports).data;
+		const filePath = packageData?.exports === void 0 ? zFilePath.safeParse(packageData?.main).data : typeof exports === "string" ? exports : exports?.["."];
+		return filePath ? { filePath: filePath.replace(/^(?:\.\/)?lib\//u, "./dist/") } : void 0;
+	},
+	produce({ addons }) {
+		const { filePath = "./dist/index.mjs", runArgs } = addons;
+		return { addons: [blockPackageJson({ properties: { exports: { ".": filePath.startsWith(".") ? filePath : `./${filePath}` } } }), blockTSDown({ runInCI: [`node ${filePath}${runArgs.map((arg) => ` ${arg}`).join("")}`] })] };
+	}
+});
+//#endregion
+export { blockExports };