create-typescript-app 2.40.0 → 2.40.2

package/lib/base.d.ts

@@ -33,32 +33,32 @@ declare const base: bingo_stratum.Base<{
             additional: z.ZodOptional<z.ZodString>;
             explainer: z.ZodOptional<z.ZodString>;
             footnotes: z.ZodOptional<z.ZodString>;
-            usage: z.ZodString;
+            usage: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         }, {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     }, {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     }>;

package/lib/base.js

@@ -190,7 +190,7 @@ const base = createBase({
       async () => await readReadmeFootnotes(getReadme)
     );
     const getReadmeUsage = lazyValue(
-      async () => await readReadmeUsage(getEmoji, getReadme, getRepository)
+      async () => await readReadmeUsage(getReadme)
     );
     const getRepository = lazyValue(
       async () => await readRepository(getGitDefaults, getPackageData, options)

package/lib/blocks/blockAllContributors.d.ts

@@ -6,10 +6,10 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockAreTheTypesWrong.d.ts

@@ -6,10 +6,10 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockCSpell.d.ts

@@ -9,10 +9,10 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockCTATransitions.d.ts

@@ -6,10 +6,10 @@ declare const blockCTATransitions: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockCodecov.d.ts

@@ -8,10 +8,10 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockContributingDocs.d.ts

@@ -6,10 +6,10 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockContributorCovenant.d.ts

@@ -6,10 +6,10 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockDevelopmentDocs.d.ts

@@ -20,10 +20,10 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLint.d.ts

@@ -35,10 +35,10 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintComments.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintJSDoc.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintJSONC.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintMarkdown.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintMoreStyling.d.ts

@@ -7,10 +7,10 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintNode.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintPackageJson.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintPerfectionist.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintPlugin.d.ts

@@ -8,10 +8,10 @@ declare const blockESLintPlugin: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintPlugin.js

@@ -4,10 +4,12 @@ import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
 import { blockESLint } from "./blockESLint.js";
 import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
 import { blockPackageJson } from "./blockPackageJson.js";
+import { blockREADME } from "./blockREADME.js";
 import { blockVitest } from "./blockVitest.js";
 import { blockESLintPluginIntake } from "./eslint/blockESLintPluginIntake.js";
 import { zConfigEmoji } from "./eslint/schemas.js";
 import { intakeFile } from "./intake/intakeFile.js";
+import { CommandPhase } from "./phases.js";
 const blockESLintPlugin = base.createBlock({
   about: {
     name: "ESLint Plugin"
@@ -24,6 +26,7 @@ const blockESLintPlugin = base.createBlock({
   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({
@@ -78,9 +81,37 @@ pnpm build: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, // \u{1F448}
+];
+\`\`\`
+
+### 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"
             },
@@ -112,7 +143,17 @@ const config = {
 
 export default config;
 `
-      }
+      },
+      scripts: [
+        {
+          commands: ["pnpm build"],
+          phase: CommandPhase.Build
+        },
+        {
+          commands: ["pnpm eslint-doc-generator --init-rule-docs"],
+          phase: CommandPhase.Process
+        }
+      ]
     };
   },
   setup({ options }) {
@@ -154,7 +195,7 @@ export { rules };
 export default plugin;
 `,
           rules: {
-            "example.test.ts": `import { rule } from "./enums.js";
+            "enums.test.ts": `import { rule } from "./enums.js";
 import { ruleTester } from "./ruleTester.js";
 
 ruleTester.run("enums", rule, {
@@ -175,7 +216,7 @@ ruleTester.run("enums", rule, {
 	valid: [\`const Values = {};\`, \`const Values = {} as const;\`],
 });
 `,
-            "example.ts": `import { createRule } from "../utils.js";
+            "enums.ts": `import { createRule } from "../utils.js";
 
 export const rule = createRule({
 	create(context) {
@@ -202,10 +243,10 @@ export const rule = createRule({
 	name: "enums",
 });
 `,
-            "index.ts": `import { rule as example } from "./example.js";
+            "index.ts": `import { rule as enums } from "./enums.js";
 
 export const rules = {
-	example,
+	enums,
 };
 `,
             "ruleTester.ts": `import { RuleTester } from "@typescript-eslint/rule-tester";

package/lib/blocks/blockESLintRegexp.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockESLintYML.d.ts

@@ -6,10 +6,10 @@ declare const blockESLintYML: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockExampleFiles.d.ts

@@ -1,6 +1,7 @@
 import * as bingo_stratum from 'bingo-stratum';
 
 declare const blockExampleFiles: bingo_stratum.BlockWithAddons<{
+    usage: string[];
     files: Record<string, string>;
 }, {
     access: "public" | "restricted";
@@ -8,10 +9,10 @@ declare const blockExampleFiles: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockExampleFiles.js

@@ -1,14 +1,22 @@
 import { z } from "zod";
 import { base } from "../base.js";
+import { blockREADME } from "./blockREADME.js";
 const blockExampleFiles = base.createBlock({
   about: {
     name: "Example Files"
   },
   addons: {
-    files: z.record(z.string()).default({})
+    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
       }

package/lib/blocks/blockFunding.d.ts

@@ -6,10 +6,10 @@ declare const blockFunding: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockGitHubActionsCI.d.ts

@@ -48,10 +48,10 @@ declare const blockGitHubActionsCI: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockGitHubApps.d.ts

@@ -11,10 +11,10 @@ declare const blockGitHubApps: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockGitHubIssueTemplates.d.ts

@@ -6,10 +6,10 @@ declare const blockGitHubIssueTemplates: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockGitHubPRTemplate.d.ts

@@ -6,10 +6,10 @@ declare const blockGitHubPRTemplate: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockGitignore.d.ts

@@ -8,10 +8,10 @@ declare const blockGitignore: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockKnip.d.ts

@@ -10,10 +10,10 @@ declare const blockKnip: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockMITLicense.d.ts

@@ -6,10 +6,10 @@ declare const blockMITLicense: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockMain.d.ts

@@ -9,10 +9,10 @@ declare const blockMain: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockMarkdownlint.d.ts

@@ -8,10 +8,10 @@ declare const blockMarkdownlint: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockNcc.d.ts

@@ -8,10 +8,10 @@ declare const blockNcc: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockNvmrc.d.ts

@@ -6,10 +6,10 @@ declare const blockNvmrc: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockPRCompliance.d.ts

@@ -6,10 +6,10 @@ declare const blockPRCompliance: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockPackageJson.d.ts

@@ -83,10 +83,10 @@ declare const blockPackageJson: bingo_stratum.BlockWithAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/blocks/blockPnpmDedupe.d.ts

@@ -6,10 +6,10 @@ declare const blockPnpmDedupe: bingo_stratum.BlockWithoutAddons<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };