feat: add emoji option (#1984)

JoshuaKGoldberg · web-flow · commit c2d239b36265 · 2025-03-17T15:02:09.000-04:00
## PR Checklist - [x] Addresses an existing open issue: fixes #1942 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Adds a separate `options.emoji` that defaults to the last detected emoji in `options.description`, or `"💖"` if not found. 🎁
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for your interest in contributing to `create-typescript-app`! 💖
+Thanks for your interest in contributing to `create-typescript-app`! 🎁
 
 > After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
 
@@ -94,4 +94,4 @@ 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.
-💖 is a good starter if you're not sure which to use.
+🎁 is a good starter if you're not sure which to use.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,4 +1,4 @@
-<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
+<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 🎁.
 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. -->
 
diff --git a/README.md b/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
 
diff --git a/src/base.test.ts b/src/base.test.ts
@@ -25,6 +25,7 @@ describe("base", () => {
 				github: "github@joshuakgoldberg.com",
 				npm: "npm@joshuakgoldberg.com",
 			},
+			emoji: "🎁",
 			existingLabels: expect.any(Array),
 			explainer: [
 				`\`create-typescript-app\` is a one-stop-shop solution to set up a new or existing repository with the latest and greatest TypeScript tooling.`,
diff --git a/src/base.ts b/src/base.ts
@@ -10,6 +10,7 @@ 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";
@@ -53,7 +54,7 @@ export const base = createBase({
 			.describe("AllContributors contributors to store in .all-contributorsrc"),
 		description: z
 			.string()
-			.default("A very lovely package. Hooray! 💖")
+			.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
@@ -74,6 +75,10 @@ export 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({
@@ -196,6 +201,10 @@ export const base = createBase({
 
 		// TODO: Make these all use take
 
+		const emoji = async () => parseEmojiFromDescription(description);
+
+		const description = async () => await readDescription(packageData, readme);
+
 		const gitDefaults = tryCatchLazyValueAsync(async () =>
 			gitUrlParse(await gitRemoteOriginUrl()),
 		);
@@ -253,9 +262,10 @@ export 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,
@@ -274,7 +284,7 @@ export const base = createBase({
 			pnpm,
 			repository,
 			rulesetId,
-			...readDefaultsFromReadme(readme, repository),
+			...readDefaultsFromReadme(emoji, readme, repository),
 			version,
 		};
 	},
diff --git a/src/blocks/blockCSpell.test.ts b/src/blocks/blockCSpell.test.ts
@@ -211,7 +211,7 @@ describe("blockCSpell", () => {
 			  "scripts": [
 			    {
 			      "commands": [
-			        "node path/to/cspell-populate-words/bin/index.mjs --words "access" --words "public" --words "description" --words "Test description" --words "directory" --words "." --words "email" --words "github" --words "github@email.com" --words "npm" --words "npm@email.com" --words "owner" --words "test-owner" --words "repository" --words "test-repository" --words "title" --words "Test Title"",
+			        "node path/to/cspell-populate-words/bin/index.mjs --words "access" --words "public" --words "description" --words "Test description" --words "directory" --words "." --words "email" --words "github" --words "github@email.com" --words "npm" --words "npm@email.com" --words "emoji" --words "💖" --words "owner" --words "test-owner" --words "repository" --words "test-repository" --words "title" --words "Test Title"",
 			      ],
 			      "phase": 3,
 			    },
diff --git a/src/blocks/blockContributingDocs.ts b/src/blocks/blockContributingDocs.ts
@@ -11,7 +11,7 @@ export const blockContributingDocs = base.createBlock({
 				".github": {
 					"CONTRIBUTING.md": `# Contributing
 
-Thanks for your interest in contributing to \`${options.repository}\`! 💖
+Thanks for your interest in contributing to \`${options.repository}\`! ${options.emoji}
 
 > After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
 
@@ -105,7 +105,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.
-💖 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.
 `,
 				},
 			},
diff --git a/src/blocks/blockGitHubPRTemplate.ts b/src/blocks/blockGitHubPRTemplate.ts
@@ -8,7 +8,7 @@ export const blockGitHubPRTemplate = base.createBlock({
 		return {
 			files: {
 				".github": {
-					"PULL_REQUEST_TEMPLATE.md": `<!-- 👋 Hi, thanks for sending a PR to ${options.repository}! 💖.
+					"PULL_REQUEST_TEMPLATE.md": `<!-- 👋 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. -->
 
diff --git a/src/blocks/blockREADME.ts b/src/blocks/blockREADME.ts
@@ -49,7 +49,7 @@ ${options.usage}
 ## Development
 
 See [\`.github/CONTRIBUTING.md\`](./.github/CONTRIBUTING.md), then [\`.github/DEVELOPMENT.md\`](./.github/DEVELOPMENT.md).
-Thanks! 💖
+Thanks! ${options.emoji}
 ${sections.map((section) => `\n${section}`).join("")}
 ${notices.length ? `\n${notices.map((notice) => notice.trim()).join("\n\n")}` : ""}`,
 			},
diff --git a/src/blocks/options.fakes.ts b/src/blocks/options.fakes.ts
@@ -8,6 +8,7 @@ export const optionsBase = {
 		github: "github@email.com",
 		npm: "npm@email.com",
 	},
+	emoji: "💖",
 	owner: "test-owner",
 	repository: "test-repository",
 	title: "Test Title",
diff --git a/src/options/parseEmojiFromDescription.test.ts b/src/options/parseEmojiFromDescription.test.ts
@@ -0,0 +1,37 @@
+import { describe, expect, it, vi } from "vitest";
+
+import { parseEmojiFromDescription } from "./parseEmojiFromDescription.js";
+
+describe("parseEmojiFromDescription", () => {
+	it("resolves with undefined when description is undefined", async () => {
+		const getDescription = vi.fn().mockResolvedValue(undefined);
+
+		const actual = await parseEmojiFromDescription(getDescription);
+
+		expect(actual).toBe("💖");
+	});
+
+	it("resolves with undefined when the description does not have any emoji", async () => {
+		const getDescription = () => Promise.resolve("Hello world.");
+
+		const actual = await parseEmojiFromDescription(getDescription);
+
+		expect(actual).toBe("💖");
+	});
+
+	it("resolves with the emoji when the description has one emoji", async () => {
+		const getDescription = () => Promise.resolve("Hello. 😊");
+
+		const actual = await parseEmojiFromDescription(getDescription);
+
+		expect(actual).toBe("😊");
+	});
+
+	it("resolves with the last emoji when the description has multiple emoji", async () => {
+		const getDescription = () => Promise.resolve("Hello 🌍. 😊");
+
+		const actual = await parseEmojiFromDescription(getDescription);
+
+		expect(actual).toBe("😊");
+	});
+});
diff --git a/src/options/parseEmojiFromDescription.ts b/src/options/parseEmojiFromDescription.ts
@@ -0,0 +1,8 @@
+export async function parseEmojiFromDescription(
+	getDescription: () => Promise<string | undefined>,
+) {
+	return (
+		(await getDescription())?.match(/\p{Extended_Pictographic}/gu)?.at(-1) ??
+		"💖"
+	);
+}
diff --git a/src/options/readDefaultsFromReadme.test.ts b/src/options/readDefaultsFromReadme.test.ts
@@ -18,10 +18,13 @@ vi.mock("./getUsageFromReadme.js", () => ({
 	},
 }));
 
+const emoji = () => Promise.resolve("💖");
+
 describe(readDefaultsFromReadme, () => {
 	describe("explainer", () => {
 		it("defaults to undefined when it cannot be found", async () => {
 			const explainer = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(`nothing.`),
 				() => Promise.resolve(undefined),
 			).explainer();
@@ -31,6 +34,7 @@ describe(readDefaultsFromReadme, () => {
 
 		it("parses a line after badges", async () => {
 			const explainer = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 </p>
@@ -47,6 +51,7 @@ This is my project.
 
 		it("parses multiple lines after badges", async () => {
 			const explainer = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 </p>
@@ -64,6 +69,7 @@ It is good.
 
 		it("parses multiple lines after badges and a logo", async () => {
 			const explainer = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <p align="center">
@@ -96,6 +102,7 @@ It is good.
 	describe("logo", () => {
 		it("defaults to undefined when it cannot be found", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(`nothing.`),
 				() => Promise.resolve(undefined),
 			).logo();
@@ -105,6 +112,7 @@ It is good.
 
 		it("parses when found in an unquoted string", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <img src=abc/def.jpg/>`),
@@ -119,6 +127,7 @@ It is good.
 
 		it("parses when found in a single quoted string", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <img src='abc/def.jpg'/>`),
@@ -133,6 +142,7 @@ It is good.
 
 		it("parses when found in a double quoted string", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <img src="abc/def.jpg"/>`),
@@ -147,6 +157,7 @@ It is good.
 
 		it("includes alt text when it exists in double quotes", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <img alt="Project logo: a fancy circle" src="abc/def.jpg"/>`),
@@ -161,6 +172,7 @@ It is good.
 
 		it("includes alt text when it exists in single quotes", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <img alt='Project logo: a fancy circle' src='abc/def.jpg'/>`),
@@ -179,6 +191,7 @@ It is good.
 			mockReadLogoSizing.mockReturnValueOnce(sizing);
 
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <img alt='Project logo: a fancy circle' height='117px' src='abc/def.jpg' width=' 117px'/>`),
@@ -194,6 +207,7 @@ It is good.
 
 		it("parses when found after a badge image", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 		<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 48" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-48-21bb42.svg" /></a>
@@ -210,6 +224,7 @@ It is good.
 
 		it("parses when found after an h1 and many badge images", async () => {
 			const logo = await readDefaultsFromReadme(
+				emoji,
 				() =>
 					Promise.resolve(`
 <h1 align="center">Create TypeScript App</h1>
@@ -244,6 +259,7 @@ It is good.
 	describe("title", () => {
 		it("defaults to undefined when it cannot be found", async () => {
 			const title = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(`nothing`),
 				() => Promise.resolve(undefined),
 			).title();
@@ -253,6 +269,7 @@ It is good.
 
 		it('reads title as markdown from "README.md" when it exists', async () => {
 			const title = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(`# My Awesome Package`),
 				() => Promise.resolve(undefined),
 			).title();
@@ -262,6 +279,7 @@ It is good.
 
 		it('reads title as HTML from "README.md" when it exists', async () => {
 			const title = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve('<h1 align="center">My Awesome Package</h1>'),
 				() => Promise.resolve(undefined),
 			).title();
@@ -271,6 +289,7 @@ It is good.
 
 		it("converts 'typescript' to 'TypeScript' when parsed from the repository name", async () => {
 			const title = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(""),
 				() => Promise.resolve("my-typescript-app"),
 			).title();
@@ -280,6 +299,7 @@ It is good.
 
 		it("converts 'eslint' to 'ESLint' when parsed from the repository name", async () => {
 			const title = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(""),
 				() => Promise.resolve("my-eslint-plugin"),
 			).title();
@@ -289,6 +309,7 @@ It is good.
 
 		it("returns undefined when title does not exist", async () => {
 			const title = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(`Other text.`),
 				() => Promise.resolve(undefined),
 			).title();
@@ -304,6 +325,7 @@ It is good.
 			mockGetUsageFromReadme.mockReturnValueOnce(existing);
 
 			const usage = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(""),
 				() => Promise.resolve(undefined),
 			).usage();
@@ -315,6 +337,7 @@ It is good.
 			mockGetUsageFromReadme.mockReturnValueOnce(undefined);
 
 			const usage = await readDefaultsFromReadme(
+				emoji,
 				() => Promise.resolve(""),
 				() => Promise.resolve("test-repository"),
 			).usage();
diff --git a/src/options/readDefaultsFromReadme.ts b/src/options/readDefaultsFromReadme.ts
@@ -5,6 +5,7 @@ import { getUsageFromReadme } from "./getUsageFromReadme.js";
 import { readLogoSizing } from "./readLogoSizing.js";
 
 export function readDefaultsFromReadme(
+	emoji: () => Promise<string>,
 	readme: () => Promise<string>,
 	repository: () => Promise<string | undefined>,
 ) {
@@ -83,7 +84,7 @@ npm i ${await repository()}
 \`\`\`ts
 import { greet } from "${await repository()}";
 
-greet("Hello, world! 💖");
+greet("Hello, world! ${await emoji()}");
 \`\`\``
 			);
 		},

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.`
	`1`	`+<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 🎁.`
`2`	`2`	`Please fill out all fields below and make sure each item is true and [x] checked.`
`3`	`3`	`Otherwise we may not be able to review your PR. -->`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ describe("blockCSpell", () => {`
`211`	`211`	`"scripts": [`
`212`	`212`	`{`
`213`	`213`	`"commands": [`
`214`		`- "node path/to/cspell-populate-words/bin/index.mjs --words "access" --words "public" --words "description" --words "Test description" --words "directory" --words "." --words "email" --words "github" --words "[email protected]" --words "npm" --words "[email protected]" --words "owner" --words "test-owner" --words "repository" --words "test-repository" --words "title" --words "Test Title"",`
	`214`	`+ "node path/to/cspell-populate-words/bin/index.mjs --words "access" --words "public" --words "description" --words "Test description" --words "directory" --words "." --words "email" --words "github" --words "[email protected]" --words "npm" --words "[email protected]" --words "emoji" --words "💖" --words "owner" --words "test-owner" --words "repository" --words "test-repository" --words "title" --words "Test Title"",`
`215`	`215`	`],`
`216`	`216`	`"phase": 3,`
`217`	`217`	`},`