build: add coverage tracking to setup script (#496)

## PR Checklist

- [x] Addresses an existing open issue: fixes #495
- [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

Uses similar tracking to the hydration script.

Author: JoshuaKGoldberg

.github/workflows/setup.yml

@@ -6,6 +6,14 @@ jobs:
       - uses: ./.github/actions/prepare
       - run: pnpm run build
       - run: pnpm run setup:test
+      - name: Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: coverage-setup/lcov.info
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          path: coverage-setup
 
 name: Test Setup Script
 

script/setup-test-e2e.js

@@ -9,6 +9,7 @@ const owner = "RNR1";
 const title = "New Title Test";
 const repository = "new-repository-test";
 
+// First we run setup to modifies the local repo, so we can test the changes
 await $({
 	stdio: "inherit",
 })`node ./lib/setup/index.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-api --skip-restore`;
@@ -43,3 +44,13 @@ try {
 	console.error("Error running lint:knip:", error);
 	process.exitCode = 1;
 }
+
+// Now that setup has passed normal steps, we reset everything,
+// then run again without removing files - so we can capture test coverage
+await $`git add -A`;
+await $`git reset --hard HEAD`;
+await $`pnpm i`;
+await $`pnpm run build`;
+await $({
+	stdio: "inherit",
+})`c8 -o ./coverage-setup -r html -r lcov node ./lib/setup/index.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-api --skip-removal --skip-restore`;

src/hydrate/values/hydrationInputValues.test.ts

@@ -16,6 +16,7 @@ describe("ensureHydrationInputValues", () => {
 				title: undefined,
 				unitTests: undefined,
 				skipApi: undefined,
+				skipRemoval: undefined,
 				skipRestore: undefined,
 				skipUninstalls: undefined,
 			})
@@ -41,6 +42,7 @@ describe("ensureHydrationInputValues", () => {
 				title: "Test Title",
 				unitTests: true,
 				skipApi: undefined,
+				skipRemoval: undefined,
 				skipRestore: undefined,
 				skipUninstalls: undefined,
 			})

src/setup/setupWithInformation.ts

@@ -78,7 +78,11 @@ export async function setupWithInformation({
 		successSpinnerBlock(`Finished API hydration.`);
 	}
 
-	await withSpinner(removeSetupScripts, "removing setup scripts");
+	if (values.skipRemoval) {
+		skipSpinnerBlock(`Skipping removal of setup scripts.`);
+	} else {
+		await withSpinner(removeSetupScripts, "removing setup scripts");
+	}
 
 	if (values.skipUninstalls) {
 		skipSpinnerBlock(`Skipping uninstall of packages only used for setup.`);

src/shared/inputs.ts

@@ -33,6 +33,7 @@ export interface DefaultInputValues {
 	releases: boolean | undefined;
 	repository: string;
 	skipApi: boolean;
+	skipRemoval: boolean;
 	skipRestore: boolean;
 	skipUninstalls: boolean;
 	title: string;
@@ -68,6 +69,7 @@ export async function getInputValuesAndOctokit(
 			unitTests: { type: "boolean" },
 			title: { type: "string" },
 			"skip-api": { type: "boolean" },
+			"skip-removal": { type: "boolean" },
 			"skip-restore": { type: "boolean" },
 			"skip-uninstall": { type: "boolean" },
 		},
@@ -134,6 +136,7 @@ export async function getInputValuesAndOctokit(
 			owner,
 			repository,
 			skipApi: !!values["skip-api"],
+			skipRemoval: !!values["skip-removal"],
 			skipRestore: !!values["skip-restore"],
 			skipUninstalls: !!values["skip-uninstalls"],
 			title,