create-typescript-app 2.24.5 → 2.25.0

package/lib/base.d.ts

@@ -13,16 +13,16 @@ declare const base: bingo_stratum.Base<{
         name: z.ZodString;
         profile: z.ZodString;
     }, "strip", z.ZodTypeAny, {
+        name: string;
         avatar_url: string;
         contributions: string[];
         login: string;
-        name: string;
         profile: string;
     }, {
+        name: string;
         avatar_url: string;
         contributions: string[];
         login: string;
-        name: string;
         profile: string;
     }>, "many">>;
     description: z.ZodDefault<z.ZodString>;
@@ -97,11 +97,11 @@ declare const base: bingo_stratum.Base<{
         href: z.ZodString;
         title: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        href: string;
         title: string;
-    }, {
         href: string;
+    }, {
         title: string;
+        href: string;
     }>>;
     keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     logo: z.ZodOptional<z.ZodObject<{
@@ -140,15 +140,15 @@ declare const base: bingo_stratum.Base<{
     }, "strip", z.ZodTypeAny, {
         dependencies?: Record<string, string> | undefined;
         devDependencies?: Record<string, string> | undefined;
+        scripts?: Record<string, string> | undefined;
         peerDependencies?: Record<string, string> | undefined;
         peerDependenciesMeta?: Record<string, unknown> | undefined;
-        scripts?: Record<string, string> | undefined;
     }, {
         dependencies?: Record<string, string> | undefined;
         devDependencies?: Record<string, string> | undefined;
+        scripts?: Record<string, string> | undefined;
         peerDependencies?: Record<string, string> | undefined;
         peerDependenciesMeta?: Record<string, unknown> | undefined;
-        scripts?: Record<string, string> | undefined;
     }>>;
     pnpm: z.ZodOptional<z.ZodString>;
     repository: z.ZodString;

package/lib/blocks/blockESLint.d.ts

@@ -2,7 +2,10 @@ import * as bingo_stratum from 'bingo-stratum';
 
 declare const blockESLint: bingo_stratum.BlockWithAddons<{
     imports: {
-        source: string;
+        source: string | {
+            version: string;
+            packageName: string;
+        };
         specifier: string;
         types?: boolean | undefined;
     }[];

package/lib/blocks/blockESLint.js

@@ -43,7 +43,10 @@ const zExtension = z.object({
   settings: z.record(z.string(), z.unknown()).optional()
 });
 const zPackageImport = z.object({
-  source: z.string(),
+  source: z.union([
+    z.string(),
+    z.object({ packageName: z.string(), version: z.string() })
+  ]),
   specifier: z.string(),
   types: z.boolean().optional()
 });
@@ -72,7 +75,7 @@ ${explanation2}
       'import eslint from "@eslint/js";',
       'import tseslint from "typescript-eslint";',
       ...imports.map(
-        (packageImport) => `import ${packageImport.specifier} from "${packageImport.source}"`
+        (packageImport) => `import ${packageImport.specifier} from "${typeof packageImport.source === "string" ? packageImport.source : packageImport.source.packageName}"`
       )
     ].sort(
       (a, b) => a.replace(/.+from/, "").localeCompare(b.replace(/.+from/, ""))
@@ -154,16 +157,26 @@ Each should be shown in VS Code, and can be run manually on the command-line:
         }),
         blockPackageJson({
           properties: {
-            devDependencies: getPackageDependencies(
-              "@eslint/js",
-              "@types/node",
-              "eslint",
-              "typescript-eslint",
-              ...imports.flatMap(({ source, types }) => {
-                const { name } = parsePackageName(source);
-                return types ? [name, `@types/${name}`] : [name];
-              })
-            ),
+            devDependencies: {
+              ...getPackageDependencies(
+                "@eslint/js",
+                "@types/node",
+                "eslint",
+                "typescript-eslint",
+                ...imports.filter((imported) => typeof imported.source === "string").flatMap(({ source, types }) => {
+                  const { name } = parsePackageName(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"
             }

package/lib/blocks/blockESLintPlugin.d.ts

@@ -0,0 +1,72 @@
+import * as bingo_stratum from 'bingo-stratum';
+
+declare const blockESLintPlugin: bingo_stratum.BlockWithoutAddons<{
+    access: "public" | "restricted";
+    description: string;
+    directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+            explainer?: string | undefined;
+            footnotes?: string | undefined;
+        };
+        development?: string | undefined;
+    };
+    email: {
+        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;
+    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;
+    pnpm?: string | undefined;
+    rulesetId?: string | undefined;
+    version?: string | undefined;
+    words?: string[] | undefined;
+    workflowsVersions?: Record<string, Record<string, {
+        pinned?: boolean | undefined;
+        hash?: string | undefined;
+    }>> | undefined;
+}>;
+
+export { blockESLintPlugin };

package/lib/blocks/blockESLintPlugin.js

@@ -0,0 +1,226 @@
+import { base } from "../base.js";
+import { blockCSpell } from "./blockCSpell.js";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
+import { blockESLint } from "./blockESLint.js";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
+import { blockPackageJson } from "./blockPackageJson.js";
+import { blockVitest } from "./blockVitest.js";
+const blockESLintPlugin = base.createBlock({
+  about: {
+    name: "ESLint Plugin"
+  },
+  produce() {
+    return {
+      addons: [
+        blockCSpell({
+          words: ["eslint-doc-generatorrc.js"]
+        }),
+        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: ['eslintPlugin.configs["flat/recommended"]'],
+          ignores: [".eslint-doc-generatorrc.js", "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" }
+              ]
+            }
+          ]
+        }),
+        blockPackageJson({
+          properties: {
+            devDependencies: {
+              "eslint-doc-generator": "2.1.0",
+              "eslint-plugin-eslint-plugin": "6.4.0"
+            },
+            peerDependencies: {
+              "@typescript-eslint/parser": ">=8",
+              eslint: ">=9",
+              typescript: ">=5"
+            },
+            scripts: {
+              "build:docs": "eslint-doc-generator",
+              "lint:docs": "eslint-doc-generator --check"
+            }
+          }
+        }),
+        blockVitest({
+          coverage: {
+            exclude: ["src/index.ts", "src/rules/index.ts"]
+          }
+        })
+      ],
+      files: {
+        ".eslint-doc-generatorrc.js": `import prettier from "prettier";
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+	postprocess: async (content, path) =>
+		prettier.format(content, {
+			...(await prettier.resolveConfig(path)),
+			parser: "markdown",
+		}),
+	ruleDocTitleFormat: "prefix-name",
+};
+
+export default config;
+`
+      }
+    };
+  },
+  setup({ options }) {
+    const pluginName = options.repository.replace("eslint-plugin-", "");
+    return {
+      files: {
+        src: {
+          "index.ts": `import Module from "node:module";
+
+import { rules } from "./rules/index.js";
+
+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: {
+            "example.test.ts": `import { rule } from "./enums.js";
+import { ruleTester } from "./ruleTester.js";
+
+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;\`],
+});
+`,
+            "example.ts": `import { createRule } from "../utils.js";
+
+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 example } from "./example.js";
+
+export const rules = {
+	example,
+};
+`,
+            "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\`,
+);
+`
+        }
+      }
+    };
+  }
+});
+export {
+  blockESLintPlugin
+};

package/lib/blocks/index.d.ts

@@ -16,6 +16,7 @@ export { blockESLintMoreStyling } from './blockESLintMoreStyling.js';
 export { blockESLintNode } from './blockESLintNode.js';
 export { blockESLintPackageJson } from './blockESLintPackageJson.js';
 export { blockESLintPerfectionist } from './blockESLintPerfectionist.js';
+export { blockESLintPlugin } from './blockESLintPlugin.js';
 export { blockESLintRegexp } from './blockESLintRegexp.js';
 export { blockESLintYML } from './blockESLintYML.js';
 export { blockFunding } from './blockFunding.js';
@@ -545,7 +546,10 @@ declare const blocks: {
     }>;
     blockESLint: bingo_stratum.BlockWithAddons<{
         imports: {
-            source: string;
+            source: string | {
+                version: string;
+                packageName: string;
+            };
             specifier: string;
             types?: boolean | undefined;
         }[];
@@ -1181,6 +1185,74 @@ declare const blocks: {
             hash?: string | undefined;
         }>> | undefined;
     }>;
+    blockESLintPlugin: bingo_stratum.BlockWithoutAddons<{
+        access: "public" | "restricted";
+        description: string;
+        directory: string;
+        documentation: {
+            readme: {
+                usage: string;
+                additional?: string | undefined;
+                explainer?: string | undefined;
+                footnotes?: string | undefined;
+            };
+            development?: string | undefined;
+        };
+        email: {
+            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;
+        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;
+        pnpm?: string | undefined;
+        rulesetId?: string | undefined;
+        version?: string | undefined;
+        words?: string[] | undefined;
+        workflowsVersions?: Record<string, Record<string, {
+            pinned?: boolean | undefined;
+            hash?: string | undefined;
+        }>> | undefined;
+    }>;
     blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
         access: "public" | "restricted";
         description: string;

package/lib/blocks/index.js

@@ -14,6 +14,7 @@ import { blockESLintMoreStyling } from "./blockESLintMoreStyling.js";
 import { blockESLintNode } from "./blockESLintNode.js";
 import { blockESLintPackageJson } from "./blockESLintPackageJson.js";
 import { blockESLintPerfectionist } from "./blockESLintPerfectionist.js";
+import { blockESLintPlugin } from "./blockESLintPlugin.js";
 import { blockESLintRegexp } from "./blockESLintRegexp.js";
 import { blockESLintYML } from "./blockESLintYML.js";
 import { blockFunding } from "./blockFunding.js";
@@ -60,6 +61,7 @@ const blocks = {
   blockESLintNode,
   blockESLintPackageJson,
   blockESLintPerfectionist,
+  blockESLintPlugin,
   blockESLintRegexp,
   blockESLintYML,
   blockFunding,
@@ -107,6 +109,7 @@ import { blockESLintMoreStyling as blockESLintMoreStyling2 } from "./blockESLint
 import { blockESLintNode as blockESLintNode2 } from "./blockESLintNode.js";
 import { blockESLintPackageJson as blockESLintPackageJson2 } from "./blockESLintPackageJson.js";
 import { blockESLintPerfectionist as blockESLintPerfectionist2 } from "./blockESLintPerfectionist.js";
+import { blockESLintPlugin as blockESLintPlugin2 } from "./blockESLintPlugin.js";
 import { blockESLintRegexp as blockESLintRegexp2 } from "./blockESLintRegexp.js";
 import { blockESLintYML as blockESLintYML2 } from "./blockESLintYML.js";
 import { blockFunding as blockFunding2 } from "./blockFunding.js";
@@ -154,6 +157,7 @@ export {
   blockESLintNode2 as blockESLintNode,
   blockESLintPackageJson2 as blockESLintPackageJson,
   blockESLintPerfectionist2 as blockESLintPerfectionist,
+  blockESLintPlugin2 as blockESLintPlugin,
   blockESLintRegexp2 as blockESLintRegexp,
   blockESLintYML2 as blockESLintYML,
   blockFunding2 as blockFunding,

package/lib/data/packageData.d.ts

@@ -1,5 +1,5 @@
 var name = "create-typescript-app";
-var version = "2.24.4";
+var version = "2.24.5";
 var description = "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁";
 var repository = {
 	type: "git",

package/lib/index.d.ts

@@ -23,6 +23,7 @@ export { blockESLintMoreStyling } from './blocks/blockESLintMoreStyling.js';
 export { blockESLintNode } from './blocks/blockESLintNode.js';
 export { blockESLintPackageJson } from './blocks/blockESLintPackageJson.js';
 export { blockESLintPerfectionist } from './blocks/blockESLintPerfectionist.js';
+export { blockESLintPlugin } from './blocks/blockESLintPlugin.js';
 export { blockESLintRegexp } from './blocks/blockESLintRegexp.js';
 export { blockESLintYML } from './blocks/blockESLintYML.js';
 export { blockFunding } from './blocks/blockFunding.js';

package/lib/schemas.d.ts

@@ -7,16 +7,16 @@ declare const zContributor: z.ZodObject<{
     name: z.ZodString;
     profile: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    name: string;
     avatar_url: string;
     contributions: string[];
     login: string;
-    name: string;
     profile: string;
 }, {
+    name: string;
     avatar_url: string;
     contributions: string[];
     login: string;
-    name: string;
     profile: string;
 }>;
 type Contributor = z.infer<typeof zContributor>;

package/lib/template.js

@@ -1,6 +1,7 @@
 import { base } from "./base.js";
 import { blockAreTheTypesWrong } from "./blocks/blockAreTheTypesWrong.js";
 import { blockCTATransitions } from "./blocks/blockCTATransitions.js";
+import { blockESLintPlugin } from "./blocks/blockESLintPlugin.js";
 import { blockNcc } from "./blocks/blockNcc.js";
 import { blockRemoveDependencies } from "./blocks/blockRemoveDependencies.js";
 import { blockRemoveFiles } from "./blocks/blockRemoveFiles.js";
@@ -18,6 +19,7 @@ const template = base.createStratumTemplate({
   blocks: [
     blockAreTheTypesWrong,
     blockCTATransitions,
+    blockESLintPlugin,
     blockNcc,
     blockRemoveDependencies,
     blockRemoveFiles

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-typescript-app",
-	"version": "2.24.5",
+	"version": "2.25.0",
 	"description": "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁",
 	"repository": {
 		"type": "git",