create-typescript-app 2.4.6 → 2.6.0

package/README.md

@@ -59,7 +59,7 @@ You can read more about `create-typescript-app` and the tooling it supports:
 ## Development
 
 See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
-Thanks! 💖
+Thanks! 🎁
 
 ## Contributors
 

package/lib/base.d.ts

@@ -64,6 +64,20 @@ declare const base: bingo_stratum.Base<{
         github: string;
         npm: string;
     }>;
+    emoji: z.ZodOptional<z.ZodString>;
+    existingLabels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        color: z.ZodString;
+        description: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        color: string;
+    }, {
+        name: string;
+        description: string;
+        color: string;
+    }>, "many">>;
     explainer: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     funding: z.ZodOptional<z.ZodString>;
     guide: z.ZodOptional<z.ZodObject<{

package/lib/base.js

@@ -8,6 +8,8 @@ import lazyValue from "lazy-value";
 import npmUser from "npm-user";
 import { z } from "zod";
 import { inputFromOctokit } from "./inputs/inputFromOctokit.js";
+import { getExistingLabels } from "./options/getExistingLabels.js";
+import { parseEmojiFromDescription } from "./options/parseEmojiFromDescription.js";
 import { parsePackageAuthor } from "./options/parsePackageAuthor.js";
 import { readAllContributors } from "./options/readAllContributors.js";
 import { readDefaultsFromReadme } from "./options/readDefaultsFromReadme.js";
@@ -34,7 +36,7 @@ const base = createBase({
     author: z.string().optional().describe("username on npm to publish packages under"),
     bin: z.string().optional().describe('value to set in `package.json`\'s `"bin"` property'),
     contributors: z.array(zContributor).optional().describe("AllContributors contributors to store in .all-contributorsrc"),
-    description: z.string().default("A very lovely package. Hooray! \u{1F496}").describe("'Sentence case.' description of the repository"),
+    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"),
     email: z.union([
@@ -48,6 +50,14 @@ const base = createBase({
     ).describe(
       "email address to be listed as the point of contact in docs and packages"
     ),
+    emoji: z.string().optional().describe("decorative emoji to use in descriptions and docs"),
+    existingLabels: z.array(
+      z.object({
+        color: z.string(),
+        description: z.string(),
+        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({
@@ -90,6 +100,9 @@ const base = createBase({
         filePath: ".nvmrc"
       })
     );
+    const existingLabels = lazyValue(
+      async () => getExistingLabels(take, await owner(), await repository())
+    );
     const githubCliUser = lazyValue(async () => {
       return swallowError(
         await take(inputFromScript, {
@@ -110,6 +123,8 @@ const base = createBase({
         (ruleset) => ruleset.name === "Branch protection for main"
       )?.id;
     });
+    const emoji = async () => parseEmojiFromDescription(description);
+    const description = async () => await readDescription(packageData, readme);
     const gitDefaults = tryCatchLazyValueAsync(
       async () => gitUrlParse(await gitRemoteOriginUrl())
     );
@@ -145,9 +160,11 @@ const base = createBase({
       author,
       bin: async () => (await packageData()).bin,
       contributors: allContributors,
-      description: async () => await readDescription(packageData, readme),
+      description,
       documentation,
       email,
+      emoji,
+      existingLabels,
       funding: readFunding,
       guide: readGuide,
       login: author,
@@ -164,7 +181,7 @@ const base = createBase({
       pnpm,
       repository,
       rulesetId,
-      ...readDefaultsFromReadme(readme, repository),
+      ...readDefaultsFromReadme(emoji, readme, repository),
       version
     };
   }

package/lib/blocks/blockAllContributors.d.ts

@@ -21,6 +21,12 @@ declare const blockAllContributors: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockAreTheTypesWrong.d.ts

@@ -21,6 +21,12 @@ declare const blockAreTheTypesWrong: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockCSpell.d.ts

@@ -24,6 +24,12 @@ declare const blockCSpell: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockCodecov.d.ts

@@ -23,6 +23,12 @@ declare const blockCodecov: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockContributingDocs.d.ts

@@ -21,6 +21,12 @@ declare const blockContributingDocs: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockContributingDocs.js

@@ -10,7 +10,7 @@ const blockContributingDocs = base.createBlock({
         ".github": {
           "CONTRIBUTING.md": `# Contributing
 
-Thanks for your interest in contributing to \`${options.repository}\`! \u{1F496}
+Thanks for your interest in contributing to \`${options.repository}\`! ${options.emoji}
 
 > After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
 
@@ -104,7 +104,7 @@ Please do ping the maintainer who merged your PR if that doesn't happen within 2
 
 If you made it all the way to the end, bravo dear user, we love you.
 Please include your favorite emoji in the bottom of your issues and PRs to signal to us that you did in fact read this file and are trying to conform to it as best as possible.
-\u{1F496} is a good starter if you're not sure which to use.
+${options.emoji} is a good starter if you're not sure which to use.
 `
         }
       }

package/lib/blocks/blockContributorCovenant.d.ts

@@ -21,6 +21,12 @@ declare const blockContributorCovenant: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockDevelopmentDocs.d.ts

@@ -35,6 +35,12 @@ declare const blockDevelopmentDocs: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLint.d.ts

@@ -47,6 +47,12 @@ declare const blockESLint: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintComments.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintComments: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintJSDoc.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintJSDoc: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintJSONC.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintJSONC: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintMarkdown.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintMarkdown: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintMoreStyling.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintMoreStyling: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintNode.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintNode: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintPackageJson.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintPackageJson: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintPerfectionist.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintPerfectionist: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintRegexp.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintRegexp: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockESLintYML.d.ts

@@ -21,6 +21,12 @@ declare const blockESLintYML: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockExampleFiles.d.ts

@@ -23,6 +23,12 @@ declare const blockExampleFiles: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockFunding.d.ts

@@ -21,6 +21,12 @@ declare const blockFunding: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockGitHubActionsCI.d.ts

@@ -60,6 +60,12 @@ declare const blockGitHubActionsCI: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockGitHubApps.d.ts

@@ -26,6 +26,12 @@ declare const blockGitHubApps: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockGitHubIssueTemplates.d.ts

@@ -21,6 +21,12 @@ declare const blockGitHubIssueTemplates: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockGitHubPRTemplate.d.ts

@@ -21,6 +21,12 @@ declare const blockGitHubPRTemplate: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockGitHubPRTemplate.js

@@ -7,7 +7,7 @@ const blockGitHubPRTemplate = base.createBlock({
     return {
       files: {
         ".github": {
-          "PULL_REQUEST_TEMPLATE.md": `<!-- \u{1F44B} Hi, thanks for sending a PR to ${options.repository}! \u{1F496}.
+          "PULL_REQUEST_TEMPLATE.md": `<!-- \u{1F44B} Hi, thanks for sending a PR to ${options.repository}! ${options.emoji}.
 Please fill out all fields below and make sure each item is true and [x] checked.
 Otherwise we may not be able to review your PR. -->
 

package/lib/blocks/blockGitignore.d.ts

@@ -23,6 +23,12 @@ declare const blockGitignore: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockKnip.d.ts

@@ -23,6 +23,12 @@ declare const blockKnip: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockMITLicense.d.ts

@@ -21,6 +21,12 @@ declare const blockMITLicense: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockMarkdownlint.d.ts

@@ -23,6 +23,12 @@ declare const blockMarkdownlint: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockNvmrc.d.ts

@@ -21,6 +21,12 @@ declare const blockNvmrc: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPRCompliance.d.ts

@@ -21,6 +21,12 @@ declare const blockPRCompliance: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPackageJson.d.ts

@@ -30,6 +30,12 @@ declare const blockPackageJson: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPnpmDedupe.d.ts

@@ -21,6 +21,12 @@ declare const blockPnpmDedupe: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPrettier.d.ts

@@ -30,6 +30,12 @@ declare const blockPrettier: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPrettierPluginCurly.d.ts

@@ -21,6 +21,12 @@ declare const blockPrettierPluginCurly: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPrettierPluginPackageJson.d.ts

@@ -21,6 +21,12 @@ declare const blockPrettierPluginPackageJson: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockPrettierPluginSh.d.ts

@@ -21,6 +21,12 @@ declare const blockPrettierPluginSh: bingo_stratum.BlockWithoutAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockREADME.d.ts

@@ -25,6 +25,12 @@ declare const blockREADME: bingo_stratum.BlockWithAddons<{
         profile: string;
     }[] | undefined;
     documentation?: string | undefined;
+    emoji?: string | undefined;
+    existingLabels?: {
+        name: string;
+        description: string;
+        color: string;
+    }[] | undefined;
     explainer?: string[] | undefined;
     funding?: string | undefined;
     guide?: {

package/lib/blocks/blockREADME.js

@@ -42,7 +42,7 @@ ${options.usage}
 ## Development
 
 See [\`.github/CONTRIBUTING.md\`](./.github/CONTRIBUTING.md), then [\`.github/DEVELOPMENT.md\`](./.github/DEVELOPMENT.md).
-Thanks! \u{1F496}
+Thanks! ${options.emoji}
 ${sections.map((section) => `
 ${section}`).join("")}
 ${notices.length ? `