create-typescript-app 2.39.0 → 2.40.1

package/lib/blocks/index.d.ts

@@ -56,10 +56,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -124,10 +124,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -194,10 +194,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -262,10 +262,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -330,10 +330,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -401,10 +401,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -483,10 +483,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -580,10 +580,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -648,10 +648,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -716,10 +716,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -784,10 +784,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -852,10 +852,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -920,10 +920,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -988,10 +988,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1056,10 +1056,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1124,10 +1124,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1186,16 +1186,18 @@ declare const blocks: {
             hash?: string | undefined;
         }>> | undefined;
     }>;
-    blockESLintPlugin: bingo_stratum.BlockWithoutAddons<{
+    blockESLintPlugin: bingo_stratum.BlockWithAddons<{
+        configEmoji?: [string, string][] | undefined;
+    }, {
         access: "public" | "restricted";
         description: string;
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1260,10 +1262,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1328,10 +1330,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1396,10 +1398,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1480,10 +1482,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1548,10 +1550,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1616,10 +1618,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1686,10 +1688,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1758,10 +1760,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1829,10 +1831,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1899,10 +1901,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -1967,10 +1969,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2037,10 +2039,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2105,10 +2107,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2250,10 +2252,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2318,10 +2320,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2386,10 +2388,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2464,10 +2466,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2532,10 +2534,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2600,10 +2602,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2668,10 +2670,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2741,6 +2743,7 @@ declare const blocks: {
                 after: string;
             } | undefined;
         }[];
+        defaultUsage: string[];
         notices: string[];
     }, {
         access: "public" | "restricted";
@@ -2748,10 +2751,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2821,10 +2824,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2891,10 +2894,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -2959,10 +2962,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -3027,10 +3030,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -3099,10 +3102,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -3279,10 +3282,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -3364,10 +3367,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -3441,10 +3444,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };
@@ -3509,10 +3512,10 @@ declare const blocks: {
         directory: string;
         documentation: {
             readme: {
-                usage: string;
                 additional?: string | undefined;
                 explainer?: string | undefined;
                 footnotes?: string | undefined;
+                usage?: string | undefined;
             };
             development?: string | undefined;
         };

package/lib/data/packageData.d.ts

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

package/lib/index.d.ts

@@ -89,32 +89,32 @@ declare const createConfig: bingo.CreateTemplateConfig<{
             additional: zod.ZodOptional<zod.ZodString>;
             explainer: zod.ZodOptional<zod.ZodString>;
             footnotes: zod.ZodOptional<zod.ZodString>;
-            usage: zod.ZodString;
+            usage: zod.ZodOptional<zod.ZodString>;
         }, "strip", zod.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", zod.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;
     }>;
@@ -229,10 +229,10 @@ declare const createConfig: bingo.CreateTemplateConfig<{
     directory: string;
     documentation: {
         readme: {
-            usage: string;
             additional?: string | undefined;
             explainer?: string | undefined;
             footnotes?: string | undefined;
+            usage?: string | undefined;
         };
         development?: string | undefined;
     };

package/lib/options/readDocumentation.d.ts

@@ -1,6 +1,6 @@
 import { Documentation } from '../schemas.js';
 import 'zod';
 
-declare function readDocumentation(getDevelopmentDocumentation: () => Promise<string | undefined>, getReadmeAdditional: () => Promise<string | undefined>, getReadmeExplainer: () => Promise<string | undefined>, getReadmeFootnotes: () => Promise<string | undefined>, getReadmeUsage: () => Promise<string>): Promise<Documentation>;
+declare function readDocumentation(getDevelopmentDocumentation: () => Promise<string | undefined>, getReadmeAdditional: () => Promise<string | undefined>, getReadmeExplainer: () => Promise<string | undefined>, getReadmeFootnotes: () => Promise<string | undefined>, getReadmeUsage: () => Promise<string | undefined>): Promise<Documentation>;
 
 export { readDocumentation };

package/lib/options/readReadmeUsage.d.ts

@@ -1,3 +1,3 @@
-declare function readReadmeUsage(getEmoji: () => Promise<string>, getReadme: () => Promise<string>, getRepository: () => Promise<string | undefined>): Promise<string>;
+declare function readReadmeUsage(getReadme: () => Promise<string>): Promise<string | undefined>;
 
 export { readReadmeUsage };

package/lib/options/readReadmeUsage.js

@@ -1,13 +1,17 @@
-import { readUsageFromReadme } from "./readUsageFromReadme.js";
-async function readReadmeUsage(getEmoji, getReadme, getRepository) {
-  return readUsageFromReadme(await getReadme()) ?? `\`\`\`shell
-npm i ${await getRepository()}
-\`\`\`
-\`\`\`ts
-import { greet } from "${await getRepository()}";
-
-greet("Hello, world! ${await getEmoji()}");
-\`\`\``;
+const startUsage = "## Usage";
+async function readReadmeUsage(getReadme) {
+  const readme = await getReadme();
+  const indexOfUsage = readme.indexOf(startUsage);
+  if (indexOfUsage === -1) {
+    return void 0;
+  }
+  const offset = indexOfUsage + startUsage.length;
+  const indexOfNextKnownHeading = readme.slice(offset).search(/## (?:Development|Contributing|Contributors)/);
+  if (indexOfNextKnownHeading === -1) {
+    return readme.slice(offset) || void 0;
+  }
+  const usage = readme.slice(offset, indexOfNextKnownHeading + offset).trim();
+  return usage || void 0;
 }
 export {
   readReadmeUsage