create-typescript-app 2.15.1 → 2.15.3

package/lib/blocks/blockREADME.js

@@ -3,22 +3,31 @@ import { base } from "../base.js";
 function printAttributes(attributes) {
   return Object.entries(attributes).map(([key, value]) => `${key}="${value}"`).sort().join(" ");
 }
+const zBadge = z.object({
+  alt: z.string(),
+  comments: z.object({
+    after: z.string(),
+    before: z.string()
+  }).optional(),
+  href: z.string().optional(),
+  src: z.string()
+});
 const blockREADME = base.createBlock({
   about: {
     name: "README.md"
   },
   addons: {
-    badges: z.array(z.string()).default([]),
+    badges: z.array(zBadge).default([]),
     notices: z.array(z.string()).default([]),
     sections: z.array(z.string()).default([])
   },
   produce({ addons, options }) {
     const { badges, notices, sections } = addons;
-    const logo = options.logo && `
-<img ${printAttributes({ align: "right", ...options.logo })}>
-`;
     const explainer = options.explainer && `
 ${options.explainer.join("\n")}
+`;
+    const logo = options.logo && `
+<img ${printAttributes({ align: "right", ...options.logo })}>
 `;
     return {
       files: {
@@ -26,13 +35,8 @@ ${options.explainer.join("\n")}
 
 <p align="center">${formatDescription(options.description)}</p>
 
-<p align="center">${badges.length ? badges.map((badge) => `
-	${badge}`).join("\n") : ""}
-	<a href="https://github.com/${options.owner}/${options.repository}/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="\u{1F91D} Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
-	<a href="https://codecov.io/gh/${options.owner}/${options.repository}" target="_blank"><img alt="\u{1F9EA} Coverage" src="https://img.shields.io/codecov/c/github/${options.owner}/${options.repository}?label=%F0%9F%A7%AA%20coverage" /></a>
-	<a href="https://github.com/${options.owner}/${options.repository}/blob/main/LICENSE.md" target="_blank"><img alt="\u{1F4DD} License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
-	<a href="http://npmjs.com/package/${options.repository}"><img alt="\u{1F4E6} npm version" src="https://img.shields.io/npm/v/${options.repository}?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
-	<img alt="\u{1F4AA} TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
+<p align="center">
+${formatBadges(badges)}
 </p>
 ${[logo, explainer].filter(Boolean).join("")}
 ## Usage
@@ -51,12 +55,33 @@ ${notices.map((notice) => notice.trim()).join("\n\n")}` : ""}`
     };
   }
 });
+function badgeSorter(a, b) {
+  return removeEmojis(a.alt).localeCompare(removeEmojis(b.alt));
+}
+function formatBadge(badge) {
+  const image = `<img alt="${badge.alt}" src="${badge.src}" />`;
+  const tagged = badge.href ? `<a href="${badge.href}" target="_blank">${image}</a>` : image;
+  const commented = badge.comments ? `${badge.comments.before}${tagged}${badge.comments.after}` : tagged;
+  return `	${commented}`;
+}
+function formatBadges(badges) {
+  return [
+    ...badges,
+    {
+      alt: "\u{1F4AA} TypeScript: Strict",
+      src: "https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg"
+    }
+  ].sort(badgeSorter).map(formatBadge).join("\n");
+}
 function formatDescription(description) {
   if (!description.includes(". ")) {
     return description;
   }
   return "\n	" + description.replaceAll(". ", ".\n	") + "\n";
 }
+function removeEmojis(text) {
+  return text.replaceAll(/\p{Emoji}/gu, "").trim();
+}
 export {
   blockREADME
 };

package/lib/blocks/blockReleaseIt.d.ts

@@ -12,7 +12,7 @@ declare const blockReleaseIt: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockReleaseIt.js

@@ -3,6 +3,7 @@ import { getPackageDependencies } from "../data/packageData.js";
 import { resolveUses } from "./actions/resolveUses.js";
 import { blockCSpell } from "./blockCSpell.js";
 import { blockPackageJson } from "./blockPackageJson.js";
+import { blockREADME } from "./blockREADME.js";
 import { blockRemoveDependencies } from "./blockRemoveDependencies.js";
 import { blockRepositorySecrets } from "./blockRepositorySecrets.js";
 import { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.js";
@@ -30,6 +31,15 @@ const blockReleaseIt = base.createBlock({
             }
           }
         }),
+        blockREADME({
+          badges: [
+            {
+              alt: "\u{1F4E6} npm version",
+              href: `http://npmjs.com/package/${options.repository}`,
+              src: `https://img.shields.io/npm/v/${options.repository}?color=21bb42&label=%F0%9F%93%A6%20npm`
+            }
+          ]
+        }),
         blockRemoveDependencies({
           dependencies: ["should-semantic-release"]
         }),

package/lib/blocks/blockRemoveDependencies.d.ts

@@ -14,7 +14,7 @@ declare const blockRemoveDependencies: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRemoveFiles.d.ts

@@ -14,7 +14,7 @@ declare const blockRemoveFiles: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRemoveWorkflows.d.ts

@@ -14,7 +14,7 @@ declare const blockRemoveWorkflows: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRenovate.d.ts

@@ -12,7 +12,7 @@ declare const blockRenovate: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRepositoryBranchRuleset.d.ts

@@ -14,7 +14,7 @@ declare const blockRepositoryBranchRuleset: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRepositoryLabels.d.ts

@@ -12,7 +12,7 @@ declare const blockRepositoryLabels: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRepositorySecrets.d.ts

@@ -17,7 +17,7 @@ declare const blockRepositorySecrets: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockRepositorySettings.d.ts

@@ -12,7 +12,7 @@ declare const blockRepositorySettings: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockSecurityDocs.d.ts

@@ -12,7 +12,7 @@ declare const blockSecurityDocs: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockTSup.d.ts

@@ -15,7 +15,7 @@ declare const blockTSup: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockTemplatedWith.d.ts

@@ -12,7 +12,7 @@ declare const blockTemplatedWith: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockTypeScript.d.ts

@@ -12,7 +12,7 @@ declare const blockTypeScript: bingo_stratum.BlockWithoutAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockTypeScript.js

@@ -1,5 +1,6 @@
 import { base } from "../base.js";
 import { getPackageDependencies } from "../data/packageData.js";
+import { getPrimaryBin } from "./bin/getPrimaryBin.js";
 import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
 import { blockExampleFiles } from "./blockExampleFiles.js";
 import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
@@ -14,6 +15,7 @@ const blockTypeScript = base.createBlock({
     name: "TypeScript"
   },
   produce({ options }) {
+    const primaryBin = getPrimaryBin(options.bin, options.repository);
     return {
       addons: [
         blockDevelopmentDocs({
@@ -85,11 +87,11 @@ export * from "./types.js";
         }),
         blockVitest({ coverage: { include: ["src"] }, exclude: ["lib"] }),
         blockVSCode({
-          debuggers: options.bin ? [
+          debuggers: primaryBin ? [
             {
               name: "Debug Program",
               preLaunchTask: "build",
-              program: options.bin,
+              program: primaryBin,
               request: "launch",
               skipFiles: ["<node_internals>/**"],
               type: "node"

package/lib/blocks/blockVSCode.d.ts

@@ -21,7 +21,7 @@ declare const blockVSCode: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];

package/lib/blocks/blockVSCode.js

@@ -1,6 +1,7 @@
 import sortKeys from "sort-keys";
 import { z } from "zod";
 import { base } from "../base.js";
+import { getPrimaryBin } from "./bin/getPrimaryBin.js";
 import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
 const blockVSCode = base.createBlock({
   about: {
@@ -24,6 +25,7 @@ const blockVSCode = base.createBlock({
   },
   produce({ addons, options }) {
     const { debuggers, extensions, settings, tasks } = addons;
+    const primaryBin = getPrimaryBin(options.bin, options.repository);
     return {
       addons: [
         blockDevelopmentDocs({
@@ -33,12 +35,12 @@ const blockVSCode = base.createBlock({
           ],
           sections: {
             Building: {
-              innerSections: options.bin ? [
+              innerSections: primaryBin ? [
                 {
                   contents: `
 This repository includes a [VS Code launch configuration](https://code.visualstudio.com/docs/editor/debugging) for debugging.
 To debug a \`bin\` app, add a breakpoint to your code, then run _Debug Program_ from the VS Code Debug panel (or press F5).
-VS Code will automatically run the \`build\` task in the background before running \`${options.bin}\`.
+VS Code will automatically run the \`build\` task in the background before running \`${primaryBin}\`.
 `,
                   heading: "Built App Debugging"
                 }

package/lib/blocks/blockVitest.d.ts

@@ -27,7 +27,7 @@ declare const blockVitest: bingo_stratum.BlockWithAddons<{
     owner: string;
     repository: string;
     author?: string | undefined;
-    bin?: string | undefined;
+    bin?: string | Record<string, string> | undefined;
     contributors?: {
         avatar_url: string;
         contributions: string[];