create-typescript-app 2.39.0 → 2.40.1

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;
     };

package/lib/blocks/blockPrettier.d.ts

@@ -16,10 +16,10 @@ declare const blockPrettier: 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/blockPrettierPluginCurly.d.ts

@@ -6,10 +6,10 @@ declare const blockPrettierPluginCurly: 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/blockPrettierPluginPackageJson.d.ts

@@ -6,10 +6,10 @@ declare const blockPrettierPluginPackageJson: 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/blockPrettierPluginSh.d.ts

@@ -6,10 +6,10 @@ declare const blockPrettierPluginSh: 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/blockREADME.d.ts

@@ -11,6 +11,7 @@ declare const blockREADME: bingo_stratum.BlockWithAddons<{
             after: string;
         } | undefined;
     }[];
+    defaultUsage: string[];
     notices: string[];
 }, {
     access: "public" | "restricted";
@@ -18,10 +19,10 @@ declare const blockREADME: 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/blockREADME.js

@@ -18,11 +18,12 @@ const blockREADME = base.createBlock({
   },
   addons: {
     badges: z.array(zBadge).default([]),
+    defaultUsage: z.array(z.string()).default([]),
     notices: z.array(z.string()).default([]),
     sections: z.array(z.string()).default([])
   },
   produce({ addons, options }) {
-    const { badges, notices, sections } = addons;
+    const { badges, defaultUsage, notices, sections } = addons;
     const explainer = options.documentation.readme.explainer && `
 ${options.documentation.readme.explainer}
 `;
@@ -45,7 +46,7 @@ ${formatBadges(badges)}
 ${[logo, explainer].filter(Boolean).join("")}
 ## Usage
 
-${options.documentation.readme.usage}
+${options.documentation.readme.usage ?? defaultUsage.join("\n\n")}
 
 ## Development
 

package/lib/blocks/blockReleaseIt.d.ts

@@ -11,10 +11,10 @@ declare const blockReleaseIt: 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/blockRemoveDependencies.d.ts

@@ -8,10 +8,10 @@ declare const blockRemoveDependencies: 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/blockRemoveFiles.d.ts

@@ -8,10 +8,10 @@ declare const blockRemoveFiles: 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/blockRemoveWorkflows.d.ts

@@ -8,10 +8,10 @@ declare const blockRemoveWorkflows: 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/blockRenovate.d.ts

@@ -8,10 +8,10 @@ declare const blockRenovate: 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/blockRepositoryBranchRuleset.d.ts

@@ -8,10 +8,10 @@ declare const blockRepositoryBranchRuleset: 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/blockRepositoryLabels.d.ts

@@ -6,10 +6,10 @@ declare const blockRepositoryLabels: 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/blockRepositorySecrets.d.ts

@@ -11,10 +11,10 @@ declare const blockRepositorySecrets: 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/blockRepositorySettings.d.ts

@@ -6,10 +6,10 @@ declare const blockRepositorySettings: 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/blockSecurityDocs.d.ts

@@ -6,10 +6,10 @@ declare const blockSecurityDocs: 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/blockTSup.d.ts

@@ -10,10 +10,10 @@ declare const blockTSup: 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/blockTemplatedWith.d.ts

@@ -6,10 +6,10 @@ declare const blockTemplatedWith: 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/blockTypeScript.d.ts

@@ -118,10 +118,10 @@ declare const blockTypeScript: 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/blockTypeScript.js

@@ -82,7 +82,17 @@ export * from "./types.js";
 		times?: number;
 	}
 	`
-          }
+          },
+          usage: [
+            `\`\`\`shell
+npm i ${options.repository}
+\`\`\`
+\`\`\`ts
+import { greet } from "${options.repository}";
+
+greet("Hello, world! ${options.emoji}");
+\`\`\``
+          ]
         }),
         blockGitignore({
           ignores: ["/lib"]

package/lib/blocks/blockVSCode.d.ts

@@ -15,10 +15,10 @@ declare const blockVSCode: 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/blockVitest.d.ts

@@ -23,10 +23,10 @@ declare const blockVitest: 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/blockWebExt.d.ts

@@ -6,10 +6,10 @@ declare const blockWebExt: 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/eslint/blockESLintPluginIntake.d.ts

@@ -0,0 +1,5 @@
+declare function blockESLintPluginIntake(sourceText: string): {
+    configEmoji: [string, string][];
+} | undefined;
+
+export { blockESLintPluginIntake };

package/lib/blocks/eslint/blockESLintPluginIntake.js

@@ -0,0 +1,48 @@
+import {
+  AST_NODE_TYPES,
+  parse as parseAST
+} from "@typescript-eslint/typescript-estree";
+import JSON5 from "json5";
+import { tryCatch } from "../../utils/tryCatch.js";
+import { zConfigEmoji } from "./schemas.js";
+function blockESLintPluginIntake(sourceText) {
+  const ast = tryCatch(
+    () => parseAST(sourceText, {
+      comment: true,
+      loc: true,
+      range: true
+    })
+  );
+  if (!ast) {
+    return void 0;
+  }
+  const config = findConfig(ast.body);
+  if (!config) {
+    return void 0;
+  }
+  const configEmoji = findConfigEmoji(config.properties);
+  if (!configEmoji) {
+    return void 0;
+  }
+  const { data } = zConfigEmoji.safeParse(
+    JSON5.parse(sourceText.slice(...configEmoji.range))
+  );
+  return data && { configEmoji: data };
+  function findConfig(body) {
+    for (const node of body) {
+      if (node.type === AST_NODE_TYPES.VariableDeclaration && node.declarations[0].id.type === AST_NODE_TYPES.Identifier && node.declarations[0].id.name === "config" && node.declarations[0].init?.type === AST_NODE_TYPES.ObjectExpression) {
+        return node.declarations[0].init;
+      }
+    }
+  }
+  function findConfigEmoji(properties) {
+    for (const node of properties) {
+      if (node.type === AST_NODE_TYPES.Property && node.key.type === AST_NODE_TYPES.Identifier && node.key.name === "configEmoji" && node.value.type === AST_NODE_TYPES.ArrayExpression) {
+        return node.value;
+      }
+    }
+  }
+}
+export {
+  blockESLintPluginIntake
+};

package/lib/blocks/eslint/schemas.d.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 
+declare const zConfigEmoji: z.ZodOptional<z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodString], null>, "many">>;
 declare const zRuleOptions: z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"off">, z.ZodLiteral<"warn">, z.ZodTuple<[z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">]>, z.ZodUnknown], null>, z.ZodTuple<[z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">]>, z.ZodUnknown, z.ZodUnknown], null>]>;
 type RuleOptions = z.infer<typeof zRuleOptions>;
 declare const zExtensionRuleGroup: z.ZodObject<{
@@ -94,4 +95,4 @@ declare const zPackageImport: z.ZodObject<{
     types?: boolean | undefined;
 }>;
 
-export { type Extension, type ExtensionRuleGroup, type ExtensionRules, type RuleOptions, zExtension, zExtensionRuleGroup, zExtensionRules, zPackageImport, zRuleOptions };
+export { type Extension, type ExtensionRuleGroup, type ExtensionRules, type RuleOptions, zConfigEmoji, zExtension, zExtensionRuleGroup, zExtensionRules, zPackageImport, zRuleOptions };

package/lib/blocks/eslint/schemas.js

@@ -1,4 +1,5 @@
 import { z } from "zod";
+const zConfigEmoji = z.array(z.tuple([z.string(), z.string()])).optional();
 const zRuleOptions = z.union([
   z.literal("error"),
   z.literal("off"),
@@ -36,6 +37,7 @@ const zPackageImport = z.object({
   types: z.boolean().optional()
 });
 export {
+  zConfigEmoji,
   zExtension,
   zExtensionRuleGroup,
   zExtensionRules,