From f7f2c788b1059a109bc1cdbc27aeb3df3168826c Mon Sep 17 00:00:00 2001
From: Josh Goldberg <git@joshuakgoldberg.com>
Date: Thu, 3 Apr 2025 11:21:46 -0400
Subject: [PATCH] fix: account for footnotes in README.md

---
 src/base.ts                             |  6 +++
 src/blocks/blockREADME.test.ts          | 48 +++++++++++++++++--
 src/blocks/blockREADME.ts               |  7 ++-
 src/options/readDocumentation.ts        | 16 ++++---
 src/options/readReadmeAdditional.ts     |  7 ++-
 src/options/readReadmeFootnotes.test.ts | 62 +++++++++++++++++++++++++
 src/options/readReadmeFootnotes.ts      | 18 +++++++
 src/schemas.ts                          |  1 +
 8 files changed, 150 insertions(+), 15 deletions(-)
 create mode 100644 src/options/readReadmeFootnotes.test.ts
 create mode 100644 src/options/readReadmeFootnotes.ts

diff --git a/src/base.ts b/src/base.ts
index b35dc66de..e07a1b1c0 100644
--- a/src/base.ts
+++ b/src/base.ts
@@ -31,6 +31,7 @@ import { readPackageData } from "./options/readPackageData.js";
 import { readPnpm } from "./options/readPnpm.js";
 import { readReadmeAdditional } from "./options/readReadmeAdditional.js";
 import { readReadmeExplainer } from "./options/readReadmeExplainer.js";
+import { readReadmeFootnotes } from "./options/readReadmeFootnotes.js";
 import { readReadmeUsage } from "./options/readReadmeUsage.js";
 import { readRepository } from "./options/readRepository.js";
 import { readRulesetId } from "./options/readRulesetId.js";
@@ -197,6 +198,7 @@ export const base = createBase({
 					getDevelopmentDocumentation,
 					getReadmeAdditional,
 					getReadmeExplainer,
+					getReadmeFootnotes,
 					getReadmeUsage,
 				),
 		);
@@ -281,6 +283,10 @@ export const base = createBase({
 			async () => await readReadmeExplainer(getReadme),
 		);
 
+		const getReadmeFootnotes = lazyValue(
+			async () => await readReadmeFootnotes(getReadme),
+		);
+
 		const getReadmeUsage = lazyValue(
 			async () => await readReadmeUsage(getEmoji, getReadme, getRepository),
 		);
diff --git a/src/blocks/blockREADME.test.ts b/src/blocks/blockREADME.test.ts
index ad38c95ad..d45a9e5fe 100644
--- a/src/blocks/blockREADME.test.ts
+++ b/src/blocks/blockREADME.test.ts
@@ -117,7 +117,7 @@ describe("blockREADME", () => {
 		`);
 	});
 
-	test("options.explainer", () => {
+	test("options.documentation.readme.explainer", () => {
 		const creation = testBlock(blockREADME, {
 			options: {
 				...optionsBase,
@@ -125,7 +125,7 @@ describe("blockREADME", () => {
 					...optionsBase.documentation,
 					readme: {
 						...optionsBase.documentation.readme,
-						explainer: "\nAnd a one.\nAnd a two.\n",
+						explainer: "And a one.\nAnd a two.",
 					},
 				},
 			},
@@ -142,11 +142,9 @@ describe("blockREADME", () => {
 				<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 			</p>
 
-
 			And a one.
 			And a two.
 
-
 			## Usage
 
 			Test usage.
@@ -162,6 +160,48 @@ describe("blockREADME", () => {
 		`);
 	});
 
+	test("options.documentation.readme.footnotes", () => {
+		const creation = testBlock(blockREADME, {
+			options: {
+				...optionsBase,
+				documentation: {
+					...optionsBase.documentation,
+					readme: {
+						...optionsBase.documentation.readme,
+						footnotes: "And a one.\nAnd a two.",
+					},
+				},
+			},
+		});
+
+		expect(creation).toMatchInlineSnapshot(`
+			{
+			  "files": {
+			    "README.md": "<h1 align="center">Test Title</h1>
+
+			<p align="center">Test description</p>
+
+			<p align="center">
+				<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
+			</p>
+
+			## Usage
+
+			Test usage.
+
+			## Development
+
+			See [\`.github/CONTRIBUTING.md\`](./.github/CONTRIBUTING.md), then [\`.github/DEVELOPMENT.md\`](./.github/DEVELOPMENT.md).
+			Thanks! 💖
+
+
+			And a one.
+			And a two.",
+			  },
+			}
+		`);
+	});
+
 	test("options.logo without sizing", () => {
 		const creation = testBlock(blockREADME, {
 			options: {
diff --git a/src/blocks/blockREADME.ts b/src/blocks/blockREADME.ts
index b0300950e..a6c969283 100644
--- a/src/blocks/blockREADME.ts
+++ b/src/blocks/blockREADME.ts
@@ -43,6 +43,11 @@ export const blockREADME = base.createBlock({
 			options.logo &&
 			`\n<img ${printAttributes({ align: "right", ...options.logo })}>\n`;
 
+		const suffixes = [
+			...notices,
+			options.documentation.readme.footnotes,
+		].filter((suffix) => typeof suffix === "string");
+
 		return {
 			files: {
 				"README.md": `<h1 align="center">${options.title}</h1>
@@ -65,7 +70,7 @@ ${[...sections, options.documentation.readme.additional]
 	.filter(Boolean)
 	.map((section) => `\n${section}`)
 	.join("")}
-${notices.length ? `\n${notices.map((notice) => notice.trim()).join("\n\n")}` : ""}`,
+${suffixes.length ? `\n${suffixes.map((suffix) => suffix.trim()).join("\n\n")}` : ""}`,
 			},
 		};
 	},
diff --git a/src/options/readDocumentation.ts b/src/options/readDocumentation.ts
index fc1eb7065..d828f348e 100644
--- a/src/options/readDocumentation.ts
+++ b/src/options/readDocumentation.ts
@@ -4,20 +4,24 @@ export async function readDocumentation(
 	getDevelopmentDocumentation: () => Promise<string | undefined>,
 	getReadmeAdditional: () => Promise<string | undefined>,
 	getReadmeExplainer: () => Promise<string | undefined>,
+	getReadmeFootnotes: () => Promise<string | undefined>,
 	getReadmeUsage: () => Promise<string>,
 ): Promise<Documentation> {
-	const [additional, explainer, development, usage] = await Promise.all([
-		getReadmeAdditional(),
-		getReadmeExplainer(),
-		getDevelopmentDocumentation(),
-		getReadmeUsage(),
-	]);
+	const [additional, explainer, footnotes, development, usage] =
+		await Promise.all([
+			getReadmeAdditional(),
+			getReadmeExplainer(),
+			getReadmeFootnotes(),
+			getDevelopmentDocumentation(),
+			getReadmeUsage(),
+		]);
 
 	return {
 		development,
 		readme: {
 			additional,
 			explainer,
+			footnotes,
 			usage,
 		},
 	};
diff --git a/src/options/readReadmeAdditional.ts b/src/options/readReadmeAdditional.ts
index a06eb585e..9aed6af68 100644
--- a/src/options/readReadmeAdditional.ts
+++ b/src/options/readReadmeAdditional.ts
@@ -1,10 +1,9 @@
+import { indicatorTemplatedBy } from "./readReadmeFootnotes.js";
+
 const indicatorAfterAllContributors = /<!--\s*ALL-CONTRIBUTORS-LIST:END\s*-->/;
 const indicatorAfterAllContributorsSpellCheck =
 	/<!--\s*spellchecker:\s*enable\s*-->/;
 
-const indicatorBeforeTemplatedBy =
-	/> .* This package (?:is|was) (?:based|build|templated) (?:on|with) |<!-- You can remove this notice/;
-
 export async function readReadmeAdditional(getReadme: () => Promise<string>) {
 	const readme = await getReadme();
 	if (!readme) {
@@ -18,7 +17,7 @@ export async function readReadmeAdditional(getReadme: () => Promise<string>) {
 		return undefined;
 	}
 
-	const templatedByMatch = indicatorBeforeTemplatedBy.exec(readme);
+	const templatedByMatch = indicatorTemplatedBy.exec(readme);
 
 	return readme
 		.slice(
diff --git a/src/options/readReadmeFootnotes.test.ts b/src/options/readReadmeFootnotes.test.ts
new file mode 100644
index 000000000..373eefeef
--- /dev/null
+++ b/src/options/readReadmeFootnotes.test.ts
@@ -0,0 +1,62 @@
+import { describe, expect, it } from "vitest";
+
+import { readReadmeFootnotes } from "./readReadmeFootnotes.js";
+
+describe(readReadmeFootnotes, () => {
+	it("resolves undefined when there is no existing readme content", async () => {
+		const getReadme = () => Promise.resolve("");
+
+		const result = await readReadmeFootnotes(getReadme);
+
+		expect(result).toBeUndefined();
+	});
+
+	it("resolves undefined when there is no templated by notice", async () => {
+		const getReadme = () => Promise.resolve(`# My Package`);
+
+		const result = await readReadmeFootnotes(getReadme);
+
+		expect(result).toBeUndefined();
+	});
+
+	it("resolves undefined when there is no content after a templated by notice", async () => {
+		const getReadme = () =>
+			Promise.resolve(`# My Package
+			
+> 💖 This package was templated with etc. etc.
+
+`);
+
+		const result = await readReadmeFootnotes(getReadme);
+
+		expect(result).toBeUndefined();
+	});
+
+	it("resolves the content when there plain text content after a templated by notice", async () => {
+		const getReadme = () =>
+			Promise.resolve(`# My Package
+			
+> 💖 This package was templated with etc. etc.
+
+After.
+`);
+
+		const result = await readReadmeFootnotes(getReadme);
+
+		expect(result).toBe("After.");
+	});
+
+	it("resolves the content when there are footnotes after a templated by notice", async () => {
+		const getReadme = () =>
+			Promise.resolve(`# My Package
+			
+> 💖 This package was templated with etc. etc.
+
+[^1]: After.
+`);
+
+		const result = await readReadmeFootnotes(getReadme);
+
+		expect(result).toBe("[^1]: After.");
+	});
+});
diff --git a/src/options/readReadmeFootnotes.ts b/src/options/readReadmeFootnotes.ts
new file mode 100644
index 000000000..1211e6bdc
--- /dev/null
+++ b/src/options/readReadmeFootnotes.ts
@@ -0,0 +1,18 @@
+export const indicatorTemplatedBy =
+	/> .* This package (?:is|was) (?:based|build|templated) (?:on|with) |<!-- You can remove this notice/;
+
+export async function readReadmeFootnotes(getReadme: () => Promise<string>) {
+	const readme = await getReadme();
+	if (!readme) {
+		return undefined;
+	}
+
+	const indexOfTemplatedBy = indicatorTemplatedBy.exec(readme)?.index;
+	if (!indexOfTemplatedBy) {
+		return undefined;
+	}
+
+	const indexOfNextLine = readme.indexOf("\n", indexOfTemplatedBy);
+
+	return readme.slice(indexOfNextLine).trim() || undefined;
+}
diff --git a/src/schemas.ts b/src/schemas.ts
index 508ba0cef..841502169 100644
--- a/src/schemas.ts
+++ b/src/schemas.ts
@@ -13,6 +13,7 @@ export type Contributor = z.infer<typeof zContributor>;
 export const zReadme = z.object({
 	additional: z.string().optional(),
 	explainer: z.string().optional(),
+	footnotes: z.string().optional(),
 	usage: z.string(),
 });