feat: run setup after hydration, with unified code (#489)

## PR Checklist

- [x] Addresses an existing open issue: fixes #475; fixes #476
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

A sweeping refactor, hooray! This unifies much of the the _hydration_
and _setup_ infrastructure:

* Reuses the spinner blocks already used in _setup_ for the steps in
_hydration_
* Extracts the `try`/`catch` logic already used in _setup_ to a new
`runOrRestore` function, and uses it in _hydration_
* `runOrRestore` also includes args parsing for the shared values
between the two
* Standardizes the names of settings/values as `values`

Test coverage has dipped a bit, even with the end-to-end scripts.
This'll be a good followup issue - the _setup_ script's end-to-end test
doesn't upload coverage...

Author: JoshuaKGoldberg

README.md

@@ -91,6 +91,10 @@ pnpm run setup --repository "testing-repository" --title "Testing Title" --owner
 
 ## Repository Hydration
 
+> **Warning**
+> Hydration will override many files in your repository.
+> You'll want to review each of the changes and make sure nothing important is removed.
+
 Alternately, if you have an existing repository that you'd like to give the files from this repository, you can run `template-typescript-node-package` in a repository to "hydrate" it.
 
 ```shell
@@ -123,9 +127,14 @@ You can disable some of them on the command-line:
 npx template-typescript-node-package --releases false --unitTests false
 ```
 
-> **Warning**
-> This will override many files in your repository.
-> You'll want to review each of the changes and make sure nothing important is removed.
+You can prevent the hydration script from making network-based changes using either or both of the following CLI flags:
+
+- `--skip-install` _(`boolean`)_: Skips installing all the new template packages with `pnpm`
+- `--skip-setup` _(`boolean`)_: Skips running the setup script at the end of hydration
+
+```shell
+npx template-typescript-node-package --skip-install --skip-setup
+```
 
 ## Usage
 

knip.jsonc

@@ -7,7 +7,7 @@
 		"script/*e2e.js"
 	],
 	"ignoreBinaries": ["dedupe", "gh"],
-	"ignoreDependencies": ["c8"],
+	"ignoreDependencies": ["all-contributors-cli", "c8"],
 	"ignoreExportsUsedInFile": {
 		"interface": true,
 		"type": true

package.json

@@ -7,7 +7,10 @@
 		"url": "https://github.com/JoshuaKGoldberg/template-typescript-node-package"
 	},
 	"license": "MIT",
-	"author": "Josh Goldberg <[email protected]>",
+	"author": {
+		"name": "Josh Goldberg",
+		"email": "[email protected]"
+	},
 	"type": "module",
 	"main": "./lib/index.js",
 	"bin": "./lib/hydrate/index.js",

script/hydrate-test-e2e.js

@@ -1,9 +1,15 @@
 import chalk from "chalk";
-import { $ } from "execa";
+import { $, execaCommand } from "execa";
+
+import packageData from "../package.json" assert { type: "json" };
+
+const { description, name: repository } = packageData;
+const owner = "JoshuaKGoldberg";
+const title = "Template TypeScript Node Package";
 
 await $({
 	stdio: "inherit",
-})`c8 -o ./coverage-hydrate -r html -r lcov node ./lib/hydrate/index.js`;
+})`c8 -o ./coverage-hydrate -r html -r lcov node ./lib/hydrate/index.js  --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-api --skip-install --skip-setup`;
 
 const { stdout: gitStatus } = await $`git status`;
 console.log(`Stdout from running \`git status\`:\n${gitStatus}`);
@@ -46,7 +52,7 @@ if (unstagedModifiedFiles.length) {
 	const gitDiffCommand = `git diff HEAD -- ${unstagedModifiedFiles.join(" ")}`;
 	console.log(
 		`Stdout from running \`${gitDiffCommand}\`:\n${
-			(await $(gitDiffCommand)).stdout
+			(await execaCommand(gitDiffCommand)).stdout
 		}`
 	);
 	console.error(

src/hydrate/hydrate.test.ts

@@ -1,82 +1,68 @@
 import { parseArgs } from "node:util";
 
-import chalk from "chalk";
-import { $ } from "execa";
-
-import { clearUnnecessaryFiles } from "./clearUnnecessaryFiles.js";
-import { createStructure } from "./creation/index.js";
-import { finalize } from "./finalize.js";
-import { readFileSafe } from "./readFileSafe.js";
-import { readFundingIfExists } from "./readFundingIfExists.js";
-import { ensureSettingsAreFilledOut } from "./repositorySettings.js";
-import { writeReadme } from "./writeReadme.js";
-import { writeStructure } from "./writing.js";
-
-interface PartialPackageData {
-	author?: string | { email: string; name: string };
-	description?: string;
-	email?: string;
-	name?: string;
-	repository?: string;
-}
+import { setupWithInformation } from "../setup/setupWithInformation.js";
+import {
+	skipSpinnerBlock,
+	successSpinnerBlock,
+	withSpinner,
+} from "../shared/cli/spinners.js";
+import { runOrRestore } from "../shared/runOrRestore.js";
+import { clearUnnecessaryFiles } from "./steps/clearUnnecessaryFiles.js";
+import { finalizeDependencies as finalizeDependencies } from "./steps/finalizeDependencies.js";
+import { writeReadme } from "./steps/writeReadme.js";
+import { writeStructure } from "./steps/writing/writeStructure.js";
+import { getHydrationDefaults } from "./values/getHydrationDefaults.js";
+import { ensureHydrationInputValues } from "./values/hydrationInputValues.js";
 
 export async function hydrate(args: string[]) {
-	const { values } = parseArgs({
+	const { values: hydrationValues } = parseArgs({
 		args,
 		options: {
-			author: { type: "string" },
-			description: { type: "string" },
-			email: { type: "string" },
-			funding: { type: "string" },
-			owner: { type: "string" },
-			releases: { type: "boolean" },
-			repository: { type: "string" },
-			unitTests: { type: "boolean" },
-			title: { type: "string" },
+			"skip-install": { type: "boolean" },
+			"skip-setup": { type: "boolean" },
 		},
 		tokens: true,
 		strict: false,
 	});
 
-	const existingReadme = await readFileSafe("./README.md", "");
-	const existingPackage = JSON.parse(
-		await readFileSafe("./package.json", "{}")
-	) as PartialPackageData;
+	return await runOrRestore({
+		args,
+		defaults: await getHydrationDefaults(),
+		label: "hydration",
+		run: async ({ octokit, values }) => {
+			ensureHydrationInputValues(values);
+
+			await withSpinner(clearUnnecessaryFiles, "clearing unnecessary files");
+
+			await withSpinner(
+				() => writeStructure(values),
+				"writing new repository structure"
+			);
 
-	const settings = {
-		author:
-			(values.author as string | undefined) ??
-			(typeof existingPackage.author === "string"
-				? existingPackage.author.split("<")[0].trim()
-				: existingPackage.author?.name),
-		description:
-			(values.description as string | undefined) ?? existingPackage.description,
-		email:
-			(values.email as string | undefined) ??
-			(typeof existingPackage.author === "string"
-				? existingPackage.author.split(/<|>/)[1]
-				: existingPackage.author?.email),
-		funding: await readFundingIfExists(),
-		owner:
-			(values.owner as string | undefined) ??
-			(await $`git remote -v`).stdout.match(
-				/origin\s+https:\/\/\S+\.\w+\/([^/]+)/
-			)?.[1],
-		releases: (values.releases as boolean | undefined) ?? true,
-		repository:
-			(values.repository as string | undefined) ?? existingPackage.name,
-		unitTests: (values.unitTests as boolean | undefined) ?? true,
-		title:
-			(values.title as string | undefined) ??
-			existingReadme.match(/^(?:# |<h1\s+align="center">)(\S+)/)?.[1],
-	};
+			await withSpinner(() => writeReadme(values), "writing README.md");
 
-	ensureSettingsAreFilledOut(settings);
+			if (hydrationValues["skip-install"]) {
+				skipSpinnerBlock(`Skipping package installations.`);
+			} else {
+				await withSpinner(
+					() => finalizeDependencies(values),
+					"finalizing dependencies"
+				);
+			}
 
-	await clearUnnecessaryFiles();
-	await writeStructure(createStructure(settings));
-	await writeReadme(settings);
-	await finalize(settings);
+			if (hydrationValues["skip-setup"]) {
+				skipSpinnerBlock(`Done hydrating, and skipping setup command.`);
+			} else {
+				successSpinnerBlock("Done hydrating. Starting setup command...");
 
-	console.log(chalk.green("Done!"));
+				await setupWithInformation({
+					octokit,
+					values: {
+						...values,
+						skipUninstalls: true,
+					},
+				});
+			}
+		},
+	});
 }

src/hydrate/hydrate.ts

@@ -1,3 +1,3 @@
 import { hydrate } from "./hydrate.js";
 
-await hydrate(process.argv.slice(2));
+process.exitCode = await hydrate(process.argv.slice(2));

src/hydrate/index.ts

@@ -1,5 +1,4 @@
-import chalk from "chalk";
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import { describe, expect, it, vi } from "vitest";
 
 import { clearUnnecessaryFiles } from "./clearUnnecessaryFiles.js";
 
@@ -12,16 +11,9 @@ vi.mock("execa", () => ({
 }));
 
 describe("clearUnnecessaryFiles", () => {
-	beforeEach(() => {
-		console.log = vi.fn();
-	});
-
 	it("runs all commands even when they fail", async () => {
 		await clearUnnecessaryFiles();
 
-		expect(console.log).toHaveBeenCalledWith(
-			chalk.gray(`rm -rf ./src/**/*.js`)
-		);
 		expect(mockExecaCommand).toHaveBeenCalledWith(`rm -rf ./src/**/*.js`);
 	});
 });

src/hydrate/clearUnnecessaryFiles.test.ts renamed to src/hydrate/steps/clearUnnecessaryFiles.test.ts

@@ -1,4 +1,3 @@
-import chalk from "chalk";
 import { execaCommand } from "execa";
 
 export async function clearUnnecessaryFiles() {
@@ -8,7 +7,6 @@ export async function clearUnnecessaryFiles() {
 		"./src/**/*.js",
 	]) {
 		try {
-			console.log(chalk.gray(`rm -rf ${glob}`));
 			await execaCommand(`rm -rf ${glob}`);
 		} catch {
 			// (we ignore failures if nothing matched)

src/hydrate/clearUnnecessaryFiles.ts renamed to src/hydrate/steps/clearUnnecessaryFiles.ts

@@ -1,6 +1,6 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import { describe, expect, it, vi } from "vitest";
 
-import { finalize } from "./finalize.js";
+import { finalizeDependencies } from "./finalizeDependencies.js";
 
 const mockExecaCommand = vi.fn();
 
@@ -11,12 +11,8 @@ vi.mock("execa", () => ({
 }));
 
 describe("finalize", () => {
-	beforeEach(() => {
-		console.log = vi.fn();
-	});
-
 	it("installs the base list of commands when no options are enabled", async () => {
-		await finalize({ releases: false, unitTests: false });
+		await finalizeDependencies({ releases: false, unitTests: false });
 
 		expect(mockExecaCommand).toHaveBeenCalledWith(
 			[
@@ -53,13 +49,12 @@ describe("finalize", () => {
 				"typescript",
 				"yaml-eslint-parser",
 				"-D",
-			].join(" "),
-			{ stdio: "inherit" }
+			].join(" ")
 		);
 	});
 
 	it("installs the full list of commands when both options are enabled", async () => {
-		await finalize({ releases: true, unitTests: true });
+		await finalizeDependencies({ releases: true, unitTests: true });
 
 		expect(mockExecaCommand).toHaveBeenCalledWith(
 			[
@@ -102,8 +97,7 @@ describe("finalize", () => {
 				"eslint-plugin-vitest",
 				"vitest",
 				"-D",
-			].join(" "),
-			{ stdio: "inherit" }
+			].join(" ")
 		);
 	});
 });