feat: allow description to safely include HTML tags

Author: JoshuaKGoldberg

package.json

@@ -49,6 +49,7 @@
 		"execa": "^9.5.2",
 		"git-remote-origin-url": "^4.0.0",
 		"git-url-parse": "^16.0.0",
+		"html-to-text": "^9.0.5",
 		"image-size": "^1.2.0",
 		"input-from-file": "0.1.0-alpha.4",
 		"input-from-file-json": "0.1.0-alpha.4",
@@ -79,6 +80,7 @@
 		"@release-it/conventional-changelog": "9.0.3",
 		"@types/eslint-plugin-markdown": "2.0.2",
 		"@types/git-url-parse": "9.0.3",
+		"@types/html-to-text": "^9.0.4",
 		"@types/js-yaml": "4.0.9",
 		"@types/node": "22.10.2",
 		"@types/parse-author": "2.0.3",

pnpm-lock.yaml

@@ -156,6 +156,8 @@ export const base = createBase({
 			)?.stdout?.toString();
 		});
 
+		const readme = lazyValue(async () => await readFileSafe("README.md", ""));
+
 		// TODO: Make these all use take
 
 		const gitDefaults = tryCatchLazyValueAsync(async () =>
@@ -196,7 +198,7 @@ export const base = createBase({
 			author,
 			bin: async () => (await packageData()).bin,
 			contributors: allContributors,
-			description: async () => await readDescription(packageData),
+			description: async () => await readDescription(packageData, readme),
 			documentation,
 			email: async () => readEmails(npmDefaults, packageAuthor),
 			funding: readFunding,
@@ -220,7 +222,7 @@ export const base = createBase({
 				options.repository ??
 				(await gitDefaults())?.name ??
 				(await packageData()).name,
-			...readDefaultsFromReadme(),
+			...readDefaultsFromReadme(readme, options.repository),
 			version,
 		};
 	},

src/next/base.ts

@@ -1,3 +1,4 @@
+import * as htmlToText from "html-to-text";
 import removeUndefinedObjects from "remove-undefined-objects";
 import sortPackageJson from "sort-package-json";
 import { z } from "zod";
@@ -44,6 +45,7 @@ export const blockPackageJson = base.createBlock({
 			...options.packageData?.devDependencies,
 			...addons.properties.devDependencies,
 		};
+		const description = htmlToText.convert(options.description);
 
 		return {
 			files: {
@@ -56,7 +58,7 @@ export const blockPackageJson = base.createBlock({
 							dependencies: Object.keys(dependencies).length
 								? dependencies
 								: undefined,
-							description: options.description,
+							description,
 							devDependencies: Object.keys(devDependencies).length
 								? devDependencies
 								: undefined,