create-typescript-app 2.15.1 → 2.15.2

package/README.md

@@ -13,8 +13,8 @@
 	<!-- prettier-ignore-end -->
 	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 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/JoshuaKGoldberg/create-typescript-app" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/create-typescript-app?label=%F0%9F%A7%AA%20coverage" /></a>
-	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
-	<a href="http://npmjs.com/package/create-typescript-app"><img alt="📦 npm version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg" /></a>
+	<a href="http://npmjs.com/package/create-typescript-app" target="_blank"><img alt="📦 npm version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
 	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>
 

package/lib/blocks/blockAllContributors.js

@@ -20,11 +20,19 @@ const blockAllContributors = base.createBlock({
         }),
         blockREADME({
           badges: [
-            `<!-- prettier-ignore-start -->
-	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-	<a href="#contributors" target="_blank"><img alt="\u{1F46A} All Contributors: ${contributions}" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-${contributions}-21bb42.svg" /></a>
+            {
+              alt: `\u{1F46A} All Contributors: ${contributions}`,
+              comments: {
+                after: `
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
-	<!-- prettier-ignore-end -->`
+	<!-- prettier-ignore-end -->`,
+                before: `<!-- prettier-ignore-start -->
+	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+	`
+              },
+              href: "#contributors",
+              src: `https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-${contributions}-21bb42.svg`
+            }
           ],
           sections: options.contributors ? [printAllContributorsTable(options.contributors)] : void 0
         }),

package/lib/blocks/blockCodecov.js

@@ -2,6 +2,7 @@ import { z } from "zod";
 import { base } from "../base.js";
 import { resolveUses } from "./actions/resolveUses.js";
 import { blockGitHubApps } from "./blockGitHubApps.js";
+import { blockREADME } from "./blockREADME.js";
 import { blockRemoveFiles } from "./blockRemoveFiles.js";
 import { blockVitest } from "./blockVitest.js";
 const blockCodecov = base.createBlock({
@@ -21,6 +22,15 @@ const blockCodecov = base.createBlock({
             }
           ]
         }),
+        blockREADME({
+          badges: [
+            {
+              alt: "\u{1F9EA} Coverage",
+              href: `https://codecov.io/gh/${options.owner}/${options.repository}`,
+              src: `https://img.shields.io/codecov/c/github/${options.owner}/${options.repository}?label=%F0%9F%A7%AA%20coverage`
+            }
+          ]
+        }),
         blockVitest({
           actionSteps: [
             {

package/lib/blocks/blockContributorCovenant.js

@@ -1,4 +1,5 @@
 import { base } from "../base.js";
+import { blockREADME } from "./blockREADME.js";
 import { blockRemoveFiles } from "./blockRemoveFiles.js";
 const blockContributorCovenant = base.createBlock({
   about: {
@@ -6,6 +7,17 @@ const blockContributorCovenant = base.createBlock({
   },
   produce({ options }) {
     return {
+      addons: [
+        blockREADME({
+          badges: [
+            {
+              alt: "\u{1F91D} Code of Conduct: Kept",
+              href: `https://github.com/${options.owner}/${options.repository}/blob/main/.github/CODE_OF_CONDUCT.md`,
+              src: "https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42"
+            }
+          ]
+        })
+      ],
       files: {
         ".github": {
           "CODE_OF_CONDUCT.md": `# Contributor Covenant Code of Conduct

package/lib/blocks/blockMITLicense.js

@@ -1,12 +1,22 @@
 import { base } from "../base.js";
 import { blockPackageJson } from "./blockPackageJson.js";
+import { blockREADME } from "./blockREADME.js";
 const blockMITLicense = base.createBlock({
   about: {
     name: "MIT License"
   },
-  produce() {
+  produce({ options }) {
     return {
       addons: [
+        blockREADME({
+          badges: [
+            {
+              alt: "\u{1F4DD} License: MIT",
+              href: `https://github.com/${options.owner}/${options.repository}/blob/main/LICENSE.md`,
+              src: "https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"
+            }
+          ]
+        }),
         blockPackageJson({
           properties: {
             files: ["LICENSE.md"],

package/lib/blocks/blockREADME.d.ts

@@ -2,7 +2,15 @@ import * as bingo_stratum from 'bingo-stratum';
 
 declare const blockREADME: bingo_stratum.BlockWithAddons<{
     sections: string[];
-    badges: string[];
+    badges: {
+        alt: string;
+        src: string;
+        href?: string | undefined;
+        comments?: {
+            before: string;
+            after: string;
+        } | undefined;
+    }[];
     notices: string[];
 }, {
     access: "public" | "restricted";

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.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/index.d.ts

@@ -2266,7 +2266,15 @@ declare const blocks: {
     }>;
     blockREADME: bingo_stratum.BlockWithAddons<{
         sections: string[];
-        badges: string[];
+        badges: {
+            alt: string;
+            src: string;
+            href?: string | undefined;
+            comments?: {
+                before: string;
+                after: string;
+            } | undefined;
+        }[];
         notices: string[];
     }, {
         access: "public" | "restricted";

package/lib/data/packageData.d.ts

@@ -1,5 +1,5 @@
 var name = "create-typescript-app";
-var version = "2.15.0";
+var version = "2.15.1";
 var description = "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁";
 var repository = {
 	type: "git",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-typescript-app",
-	"version": "2.15.1",
+	"version": "2.15.2",
 	"description": "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁",
 	"repository": {
 		"type": "git",