create-typescript-app 2.24.1 → 2.24.3

package/lib/base.d.ts

@@ -31,24 +31,29 @@ declare const base: bingo_stratum.Base<{
         development: z.ZodOptional<z.ZodString>;
         readme: z.ZodObject<{
             additional: z.ZodOptional<z.ZodString>;
+            explainer: z.ZodOptional<z.ZodString>;
             usage: z.ZodString;
         }, "strip", z.ZodTypeAny, {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         }, {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     }, {
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     }>;
@@ -82,7 +87,6 @@ declare const base: bingo_stratum.Base<{
         description: string;
         color: string;
     }>, "many">>;
-    explainer: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     funding: z.ZodOptional<z.ZodString>;
     guide: z.ZodOptional<z.ZodObject<{
         href: z.ZodString;

package/lib/base.js

@@ -16,7 +16,6 @@ import { readEmailFromNpm } from "./options/readEmailFromNpm.js";
 import { readEmails } from "./options/readEmails.js";
 import { readEmoji } from "./options/readEmoji.js";
 import { readExistingLabels } from "./options/readExistingLabels.js";
-import { readExplainer } from "./options/readExplainer.js";
 import { readFileSafe } from "./options/readFileSafe.js";
 import { readFunding } from "./options/readFunding.js";
 import { readGitDefaults } from "./options/readGitDefaults.js";
@@ -30,6 +29,7 @@ import { readPackageAuthor } from "./options/readPackageAuthor.js";
 import { readPackageData } from "./options/readPackageData.js";
 import { readPnpm } from "./options/readPnpm.js";
 import { readReadmeAdditional } from "./options/readReadmeAdditional.js";
+import { readReadmeExplainer } from "./options/readReadmeExplainer.js";
 import { readReadmeUsage } from "./options/readReadmeUsage.js";
 import { readRepository } from "./options/readRepository.js";
 import { readRulesetId } from "./options/readRulesetId.js";
@@ -67,7 +67,6 @@ const base = createBase({
         name: z.string()
       })
     ).optional().describe("existing labels from the GitHub repository"),
-    explainer: z.array(z.string()).optional().describe("additional README.md sentence(s) describing the package"),
     funding: z.string().optional().describe("GitHub organization or username to mention in `funding.yml`"),
     guide: z.object({
       href: z.string(),
@@ -125,6 +124,7 @@ const base = createBase({
       async () => await readDocumentation(
         getDevelopmentDocumentation,
         getReadmeAdditional,
+        getReadmeExplainer,
         getReadmeUsage
       )
     );
@@ -149,7 +149,6 @@ const base = createBase({
     const getExistingLabels = lazyValue(
       async () => await readExistingLabels(take, getOwner, getRepository)
     );
-    const getExplainer = lazyValue(async () => await readExplainer(getReadme));
     const getFunding = lazyValue(async () => await readFunding(take));
     const getGitDefaults = lazyValue(async () => await readGitDefaults(take));
     const getGuide = lazyValue(async () => await readGuide(take));
@@ -182,6 +181,9 @@ const base = createBase({
     const getReadmeAdditional = lazyValue(
       async () => await readReadmeAdditional(getReadme)
     );
+    const getReadmeExplainer = lazyValue(
+      async () => await readReadmeExplainer(getReadme)
+    );
     const getReadmeUsage = lazyValue(
       async () => await readReadmeUsage(getEmoji, getReadme, getRepository)
     );
@@ -210,7 +212,6 @@ const base = createBase({
       email: getEmail,
       emoji: getEmoji,
       existingLabels: getExistingLabels,
-      explainer: getExplainer,
       funding: getFunding,
       guide: getGuide,
       keywords: getKeywords,

package/lib/blocks/blockAllContributors.d.ts

@@ -8,6 +8,7 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockAreTheTypesWrong.d.ts

@@ -8,6 +8,7 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockCSpell.d.ts

@@ -11,6 +11,7 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -41,7 +42,6 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockCTATransitions.d.ts

@@ -8,6 +8,7 @@ declare const blockCTATransitions: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockCTATransitions: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockCodecov.d.ts

@@ -10,6 +10,7 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -40,7 +41,6 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockContributingDocs.d.ts

@@ -8,6 +8,7 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockContributorCovenant.d.ts

@@ -8,6 +8,7 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockDevelopmentDocs.d.ts

@@ -22,6 +22,7 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -52,7 +53,6 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLint.d.ts

@@ -34,6 +34,7 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -64,7 +65,6 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintComments.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintJSDoc.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintJSONC.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintMarkdown.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintMoreStyling.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintNode.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintPackageJson.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintPerfectionist.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintRegexp.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockESLintYML.d.ts

@@ -8,6 +8,7 @@ declare const blockESLintYML: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockESLintYML: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockExampleFiles.d.ts

@@ -10,6 +10,7 @@ declare const blockExampleFiles: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -40,7 +41,6 @@ declare const blockExampleFiles: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockFunding.d.ts

@@ -8,6 +8,7 @@ declare const blockFunding: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockFunding: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockGitHubActionsCI.d.ts

@@ -49,6 +49,7 @@ declare const blockGitHubActionsCI: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -79,7 +80,6 @@ declare const blockGitHubActionsCI: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockGitHubApps.d.ts

@@ -13,6 +13,7 @@ declare const blockGitHubApps: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -43,7 +44,6 @@ declare const blockGitHubApps: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockGitHubIssueTemplates.d.ts

@@ -8,6 +8,7 @@ declare const blockGitHubIssueTemplates: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockGitHubIssueTemplates: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockGitHubPRTemplate.d.ts

@@ -8,6 +8,7 @@ declare const blockGitHubPRTemplate: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockGitHubPRTemplate: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockGitignore.d.ts

@@ -10,6 +10,7 @@ declare const blockGitignore: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -40,7 +41,6 @@ declare const blockGitignore: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockKnip.d.ts

@@ -10,6 +10,7 @@ declare const blockKnip: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -40,7 +41,6 @@ declare const blockKnip: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockMITLicense.d.ts

@@ -8,6 +8,7 @@ declare const blockMITLicense: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockMITLicense: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockMain.d.ts

@@ -11,6 +11,7 @@ declare const blockMain: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -41,7 +42,6 @@ declare const blockMain: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockMarkdownlint.d.ts

@@ -10,6 +10,7 @@ declare const blockMarkdownlint: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -40,7 +41,6 @@ declare const blockMarkdownlint: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockNcc.d.ts

@@ -8,6 +8,7 @@ declare const blockNcc: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockNcc: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockNvmrc.d.ts

@@ -8,6 +8,7 @@ declare const blockNvmrc: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockNvmrc: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockPRCompliance.d.ts

@@ -8,6 +8,7 @@ declare const blockPRCompliance: bingo_stratum.BlockWithoutAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -38,7 +39,6 @@ declare const blockPRCompliance: bingo_stratum.BlockWithoutAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;

package/lib/blocks/blockPackageJson.d.ts

@@ -85,6 +85,7 @@ declare const blockPackageJson: bingo_stratum.BlockWithAddons<{
         readme: {
             usage: string;
             additional?: string | undefined;
+            explainer?: string | undefined;
         };
         development?: string | undefined;
     };
@@ -115,7 +116,6 @@ declare const blockPackageJson: bingo_stratum.BlockWithAddons<{
         description: string;
         color: string;
     }[] | undefined;
-    explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {
         href: string;