create-typescript-app 2.21.4 → 2.22.1

package/lib/base.d.ts

@@ -27,7 +27,31 @@ declare const base: bingo_stratum.Base<{
     }>, "many">>;
     description: z.ZodDefault<z.ZodString>;
     directory: z.ZodString;
-    documentation: z.ZodOptional<z.ZodString>;
+    documentation: z.ZodObject<{
+        development: z.ZodOptional<z.ZodString>;
+        readme: z.ZodObject<{
+            additional: z.ZodOptional<z.ZodString>;
+            usage: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            usage: string;
+            additional?: string | undefined;
+        }, {
+            usage: string;
+            additional?: string | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    }, {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    }>;
     email: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
         github: z.ZodString;
         npm: z.ZodString;
@@ -121,7 +145,6 @@ declare const base: bingo_stratum.Base<{
     repository: z.ZodString;
     rulesetId: z.ZodOptional<z.ZodString>;
     title: z.ZodString;
-    usage: z.ZodOptional<z.ZodString>;
     version: z.ZodOptional<z.ZodString>;
     words: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     workflowsVersions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodObject<{

package/lib/base.js

@@ -8,6 +8,7 @@ import { readAllContributors } from "./options/readAllContributors.js";
 import { readAuthor } from "./options/readAuthor.js";
 import { readBin } from "./options/readBin.js";
 import { readDescription } from "./options/readDescription.js";
+import { readDevelopmentDocumentation } from "./options/readDevelopmentDocumentation.js";
 import { readDocumentation } from "./options/readDocumentation.js";
 import { readEmailFromCodeOfConduct } from "./options/readEmailFromCodeOfConduct.js";
 import { readEmailFromGit } from "./options/readEmailFromGit.js";
@@ -27,13 +28,14 @@ import { readOwner } from "./options/readOwner.js";
 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 { readReadmeUsage } from "./options/readReadmeUsage.js";
 import { readRepository } from "./options/readRepository.js";
 import { readRulesetId } from "./options/readRulesetId.js";
 import { readTitle } from "./options/readTitle.js";
-import { readUsage } from "./options/readUsage.js";
 import { readWords } from "./options/readWords.js";
 import { readWorkflowsVersions } from "./options/readWorkflowsVersions.js";
-import { zContributor, zWorkflowsVersions } from "./schemas.js";
+import { zContributor, zDocumentation, zWorkflowsVersions } from "./schemas.js";
 const base = createBase({
   options: {
     access: z.union([z.literal("public"), z.literal("restricted")]).describe("which `npm publish --access` to release npm packages with"),
@@ -42,7 +44,9 @@ const base = createBase({
     contributors: z.array(zContributor).optional().describe("AllContributors contributors to store in .all-contributorsrc"),
     description: z.string().default("A very lovely package. Hooray!").describe("'Sentence case.' description of the repository"),
     directory: z.string().describe("Directory to create the repository in"),
-    documentation: z.string().optional().describe("any additional docs to add to .github/DEVELOPMENT.md"),
+    documentation: zDocumentation.describe(
+      "additional docs to add to .md files"
+    ),
     email: z.union([
       z.string(),
       z.object({
@@ -95,7 +99,6 @@ const base = createBase({
     repository: z.string().describe("'kebab-case' or 'PascalCase' title of the repository"),
     rulesetId: z.string().optional().describe("GitHub branch ruleset ID for main branch protections"),
     title: z.string().describe("'Title Case' title for the repository"),
-    usage: z.string().optional().describe("Markdown docs to put in README.md under the ## Usage heading"),
     version: z.string().optional().describe("package version to publish as and store in `package.json`"),
     words: z.array(z.string()).optional().describe("additional words to add to the CSpell dictionary"),
     workflowsVersions: zWorkflowsVersions.optional().describe("existing versions of GitHub Actions workflows used")
@@ -113,8 +116,15 @@ const base = createBase({
     const getDescription = lazyValue(
       async () => await readDescription(getPackageData, getReadme)
     );
+    const getDevelopmentDocumentation = lazyValue(
+      async () => await readDevelopmentDocumentation(take)
+    );
     const getDocumentation = lazyValue(
-      async () => await readDocumentation(take)
+      async () => await readDocumentation(
+        getDevelopmentDocumentation,
+        getReadmeAdditional,
+        getReadmeUsage
+      )
     );
     const getEmail = lazyValue(
       async () => await readEmails(
@@ -163,6 +173,12 @@ const base = createBase({
     const getReadme = lazyValue(
       async () => await readFileSafe("README.md", "")
     );
+    const getReadmeAdditional = lazyValue(
+      async () => await readReadmeAdditional(getReadme)
+    );
+    const getReadmeUsage = lazyValue(
+      async () => await readReadmeUsage(getEmoji, getReadme, getRepository)
+    );
     const getRepository = lazyValue(
       async () => await readRepository(getGitDefaults, getPackageData, options)
     );
@@ -172,9 +188,6 @@ const base = createBase({
     const getTitle = lazyValue(
       async () => await readTitle(getReadme, getRepository)
     );
-    const getUsage = lazyValue(
-      async () => await readUsage(getEmoji, getReadme, getRepository)
-    );
     const getVersion = lazyValue(async () => (await getPackageData()).version);
     const getWords = lazyValue(async () => await readWords(take));
     const getWorkflowData = lazyValue(
@@ -201,7 +214,6 @@ const base = createBase({
       repository: getRepository,
       rulesetId: getRulesetId,
       title: getTitle,
-      usage: getUsage,
       version: getVersion,
       words: getWords,
       workflowsVersions: getWorkflowData

package/lib/blocks/blockAllContributors.d.ts

@@ -4,6 +4,13 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockAreTheTypesWrong.d.ts

@@ -4,6 +4,13 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockCSpell.d.ts

@@ -7,6 +7,13 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -23,7 +30,6 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -56,7 +62,6 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockCTATransitions.d.ts

@@ -4,6 +4,13 @@ declare const blockCTATransitions: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockCTATransitions: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockCTATransitions: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockCodecov.d.ts

@@ -6,6 +6,13 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -22,7 +29,6 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -55,7 +61,6 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockContributingDocs.d.ts

@@ -4,6 +4,13 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockContributorCovenant.d.ts

@@ -4,6 +4,13 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockDevelopmentDocs.d.ts

@@ -18,6 +18,13 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -34,7 +41,6 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -67,7 +73,6 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockDevelopmentDocs.js

@@ -65,7 +65,7 @@ const blockDevelopmentDocs = base.createBlock({
       ``,
       ...addons.hints.length ? [...addons.hints, ``] : [],
       ...Object.entries(addons.sections).sort(([a], [b]) => a.localeCompare(b)).flatMap(([heading, section]) => printSection(heading, section)),
-      ...options.documentation ? [options.documentation] : []
+      ...options.documentation.development ? [options.documentation.development] : []
     ];
     return {
       files: {

package/lib/blocks/blockESLint.d.ts

@@ -30,6 +30,13 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -46,7 +53,6 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -79,7 +85,6 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintComments.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintJSDoc.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintJSONC.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintMarkdown.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintMoreStyling.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintNode.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintPackageJson.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintPerfectionist.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {

package/lib/blocks/blockESLintRegexp.d.ts

@@ -4,6 +4,13 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
     access: "public" | "restricted";
     description: string;
     directory: string;
+    documentation: {
+        readme: {
+            usage: string;
+            additional?: string | undefined;
+        };
+        development?: string | undefined;
+    };
     email: {
         github: string;
         npm: string;
@@ -20,7 +27,6 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
         name: string;
         profile: string;
     }[] | undefined;
-    documentation?: string | undefined;
     emoji?: string | undefined;
     existingLabels?: {
         name: string;
@@ -53,7 +59,6 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
     } | undefined;
     pnpm?: string | undefined;
     rulesetId?: string | undefined;
-    usage?: string | undefined;
     version?: string | undefined;
     words?: string[] | undefined;
     workflowsVersions?: Record<string, Record<string, {