feat: split contributors option into exclude-all-contributors and --skip-all-contributors-api (#899)

JoshuaKGoldberg · web-flow · commit a51c624da09d · 2023-09-29T16:30:37.000+02:00
## PR Checklist - [x] Addresses an existing open issue: fixes #875; fixes #898 - [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 Splits the option into: * `--exclude-all-contributors`: disables the all-contributors feature altogether * `--skip-all-contributors-api`: allows the all-contributors feature, but skips fetching past contributions from GitHub
diff --git a/cspell.json b/cspell.json
@@ -9,6 +9,8 @@
 		"pnpm-lock.yaml"
 	],
 	"words": [
+		"allcontributors",
+		"apexskier",
 		"Codecov",
 		"codespace",
 		"commitlint",
@@ -20,11 +22,14 @@
 		"knip",
 		"lcov",
 		"markdownlintignore",
+		"mtfoley",
 		"npmignore",
+		"npmjs",
 		"npmpackagejsonlintrc",
 		"outro",
 		"packagejson",
 		"quickstart",
+		"tada",
 		"tsup",
 		"Unstaged",
 		"wontfix"
diff --git a/docs/Creation.md b/docs/Creation.md
@@ -23,8 +23,8 @@ Hooray! 🥳
 You can explicitly provide some or all of the options the script would prompt for as command-line flags.
 See [Options.md](./Options.md).
 
-For example, running the creation script and skipping all APIs:
+For example, running the creation script and skipping all GitHub APIs:
 
 ```shell
-npx create-typescript-app --mode create --exclude-contributors --skip-github-api
+npx create-typescript-app --mode create --skip-all-contributors-api --skip-github-api
 ```
diff --git a/docs/Initialization.md b/docs/Initialization.md
@@ -37,8 +37,8 @@ See [Options.md](./Options.md).
 
 `pnpm run initialize` will set `--mode` to `initialize`.
 
-For example, running the initialization script and skipping all APIs:
+For example, running the initialization script and skipping all GitHub APIs:
 
 ```shell
-pnpm run initialize --exclude-contributors --skip-github-api
+pnpm run initialize --skip-all-contributors-api --skip-github-api
 ```
diff --git a/docs/Migration.md b/docs/Migration.md
@@ -16,8 +16,8 @@ npx create-typescript-app
 You can explicitly provide some or all of the options the script would prompt for as command-line flags.
 See [Options.md](./Options.md).
 
-For example, running the migration script and skipping all APIs:
+For example, running the migration script and skipping all GitHub APIs:
 
 ```shell
-npx create-typescript-app --mode migrate --exclude-contributors --skip-github-api
+npx create-typescript-app --mode migrate --skip-all-contributors-api --skip-github-api
 ```
diff --git a/docs/Options.md b/docs/Options.md
@@ -74,8 +74,8 @@ The setup scripts can be directed with CLI flags to opt out tooling portions and
 The setup scripts normally will prompt you to select how much of the tooling you'd like to enable in a new repository.
 Alternately, you can bypass that prompt by providing any number of the following CLI flags:
 
+- `--exclude-all-contributors`: Don't add all-contributors to track contributions and display them in a README.md table.
 - `--exclude-compliance`: Don't add a GitHub Actions workflow to verify that PRs match an expected format.
-- `--exclude-contributors`: Don't add all-contributors to track contributions and display them in a README.md table.
 - `--exclude-lint-json`: Don't apply linting and sorting to `*.json` and `*.jsonc` files.
 - `--exclude-lint-knip`: Don't add Knip to detect unused files, dependencies, and code exports.
 - `--exclude-lint-md`: Don't apply linting to `*.md` files.
@@ -107,18 +107,18 @@ npx create-typescript-app --exclude-lint-package-json --exclude-lint-packages --
 
 You can prevent the migration script from making some network-based changes using any or all of the following CLI flags:
 
-- `--exclude-contributors` _(`boolean`)_: Skips network calls that fetch all-contributors data from GitHub
-  - This flag does nothing if `--exclude-contributors` was specified.
+- `--skip-all-contributors-api` _(`boolean`)_: Skips network calls that fetch all-contributors data from GitHub
+  - This flag does nothing if `--skip-all-contributors` was specified.
 - `--skip-github-api` _(`boolean`)_: Skips calling to GitHub APIs.
 - `--skip-install` _(`boolean`)_: Skips installing all the new template packages with `pnpm`.
 
 For example, providing all three flags will completely skip all network requests:
 
 ```shell
-npx create-typescript-app --exclude-contributors --skip-github-api --skip-install
+npx create-typescript-app --skip-all-contributors-api --skip-github-api --skip-install
 ```
 
-> 💡 Tip: To temporarily preview what the script would apply, you can run with all `--skip-*` flags, then `git add -A; git reset --hard HEAD` to completely reset all changes.
+> 💡 Tip: To temporarily preview what the script would apply without making changes on GitHub, you can run with all `--skip-*-api` flags, then `git add -A; git reset --hard HEAD` to completely reset all changes.
 
 ### Skipping Local Changes
 
diff --git a/script/create-test-e2e.js b/script/create-test-e2e.js
@@ -12,7 +12,7 @@ await $`rm -rf ${repository}`;
 
 await $({
 	stdio: "inherit",
-})`c8 -o ./coverage-create -r html -r lcov  --src src node ./bin/index.js --base everything --mode create --author ${author} --email ${email} --description ${description} --owner ${owner} --title ${title} --repository ${repository} --exclude-contributors --skip-github-api`;
+})`c8 -o ./coverage-create -r html -r lcov  --src src node ./bin/index.js --base everything --mode create --author ${author} --email ${email} --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-all-contributors-api --skip-github-api`;
 
 process.chdir(repository);
 
diff --git a/script/initialize-test-e2e.js b/script/initialize-test-e2e.js
@@ -11,7 +11,7 @@ const repository = "new-repository-test";
 // First we run initialize to modifies the local repo, so we can test the changes
 await $({
 	stdio: "inherit",
-})`node ./bin/index.js --description ${description} --base everything --mode initialize --owner ${owner} --title ${title} --repository ${repository} --skip-github-api --skip-restore`;
+})`node ./bin/index.js --description ${description} --base everything --mode initialize --owner ${owner} --title ${title} --repository ${repository} --skip-all-contributors-api --skip-github-api --skip-restore`;
 
 const newPackageJson = JSON.parse(
 	(await fs.readFile("./package.json")).toString(),
@@ -49,4 +49,4 @@ await $`pnpm i`;
 await $`pnpm run build`;
 await $({
 	stdio: "inherit",
-})`c8 -o ./coverage-initialize -r html -r lcov --src src node ./bin/index.js --base everything --description ${description} --mode initialize --owner ${owner} --title ${title} --repository ${repository} --exclude-contributors --skip-github-api --skip-removal --skip-restore`;
+})`c8 -o ./coverage-initialize -r html -r lcov --src src node ./bin/index.js --base everything --description ${description} --mode initialize --owner ${owner} --title ${title} --repository ${repository} --skip-all-contributors-api --skip-github-api --skip-removal --skip-restore`;
diff --git a/script/migrate-test-e2e.js b/script/migrate-test-e2e.js
@@ -11,7 +11,7 @@ const title = "Create TypeScript App";
 
 await $({
 	stdio: "inherit",
-})`c8 -o ./coverage-migrate -r html -r lcov --src src node ./bin/index.js --base everything --mode migrate --description ${description} --email-github ${emailGithub} --email-npm ${emailNpm} --owner ${owner} --title ${title} --repository ${repository} --exclude-contributors --skip-github-api --skip-install`;
+})`c8 -o ./coverage-migrate -r html -r lcov --src src node ./bin/index.js --base everything --mode migrate --description ${description} --email-github ${emailGithub} --email-npm ${emailNpm} --owner ${owner} --title ${title} --repository ${repository} --skip-all-contributors-api --skip-github-api --skip-install`;
 
 const { stdout: gitStatus } = await $`git status`;
 console.log(`Stdout from running \`git status\`:\n${gitStatus}`);
diff --git a/src/create/createRerunSuggestion.test.ts b/src/create/createRerunSuggestion.test.ts
@@ -13,8 +13,8 @@ const options = {
 		github: "github@email.com",
 		npm: "npm@email.com",
 	},
+	excludeAllContributors: true,
 	excludeCompliance: true,
-	excludeContributors: true,
 	excludeLintJSDoc: true,
 	excludeLintJson: true,
 	excludeLintKnip: true,
@@ -45,7 +45,7 @@ describe("createRerunSuggestion", () => {
 		const actual = createRerunSuggestion(options);
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode create --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm npm@email.com --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --mode create --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
+			'"npx create-typescript-app --mode create --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm npm@email.com --exclude-all-contributors true --exclude-compliance true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --mode create --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -60,7 +60,7 @@ describe("createRerunSuggestion", () => {
 		});
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm npm@email.com --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --logo test/src.png --logo-alt \\"Test alt.\\" --mode initialize --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm npm@email.com --exclude-all-contributors true --exclude-compliance true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --logo test/src.png --logo-alt \\"Test alt.\\" --mode initialize --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -74,7 +74,7 @@ describe("createRerunSuggestion", () => {
 		});
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm npm@email.com --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-md true --exclude-lint-package-json true --exclude-lint-perfectionist true --exclude-lint-spelling true --mode initialize --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm npm@email.com --exclude-all-contributors true --exclude-compliance true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-md true --exclude-lint-package-json true --exclude-lint-perfectionist true --exclude-lint-spelling true --mode initialize --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 });
diff --git a/src/create/createWithOptions.ts b/src/create/createWithOptions.ts
@@ -27,7 +27,7 @@ export async function createWithOptions({ github, options }: GitHubAndOptions) {
 		],
 	]);
 
-	if (!options.excludeContributors) {
+	if (!options.excludeAllContributors && !options.skipAllContributorsApi) {
 		await withSpinner("Adding contributors to table", async () => {
 			await addToolAllContributors(options.owner);
 		});
diff --git a/src/initialize/initializeWithOptions.ts b/src/initialize/initializeWithOptions.ts
@@ -33,7 +33,7 @@ export async function initializeWithOptions({
 		["Resetting Git tags", resetGitTags],
 	]);
 
-	if (!options.excludeContributors) {
+	if (!options.excludeAllContributors) {
 		await withSpinner("Updating existing contributor details", async () => {
 			await addOwnerAsAllContributor(options.owner);
 		});
diff --git a/src/migrate/migrateWithOptions.ts b/src/migrate/migrateWithOptions.ts
@@ -48,7 +48,7 @@ export async function migrateWithOptions({
 		});
 	}
 
-	if (!options.excludeContributors) {
+	if (!options.excludeAllContributors && !options.skipAllContributorsApi) {
 		await withSpinner("Detecting existing contributors", async () =>
 			detectExistingContributors(github?.auth, options),
 		);
diff --git a/src/shared/options/args.ts b/src/shared/options/args.ts
@@ -7,8 +7,8 @@ export const allArgOptions = {
 	email: { type: "string" },
 	"email-github": { type: "string" },
 	"email-npm": { type: "string" },
+	"exclude-all-contributors": { type: "boolean" },
 	"exclude-compliance": { type: "boolean" },
-	"exclude-contributors": { type: "boolean" },
 	"exclude-lint-deprecation": { type: "boolean" },
 	"exclude-lint-eslint": { type: "boolean" },
 	"exclude-lint-jsdoc": { type: "boolean" },
@@ -32,6 +32,7 @@ export const allArgOptions = {
 	mode: { type: "string" },
 	owner: { type: "string" },
 	repository: { type: "string" },
+	"skip-all-contributors-api": { type: "boolean" },
 	"skip-github-api": { type: "boolean" },
 	"skip-install": { type: "boolean" },
 	"skip-removal": { type: "boolean" },
diff --git a/src/shared/options/augmentOptionsWithExcludes.test.ts b/src/shared/options/augmentOptionsWithExcludes.test.ts
@@ -6,15 +6,15 @@ import { augmentOptionsWithExcludes } from "./augmentOptionsWithExcludes.js";
 const optionsBase = {
 	access: "public",
 	author: undefined,
-	base: undefined,
+	base: "everything",
 	createRepository: undefined,
 	description: "",
 	email: {
 		github: "github@email.com",
 		npm: "npm@email.com",
 	},
+	excludeAllContributors: undefined,
 	excludeCompliance: undefined,
-	excludeContributors: undefined,
 	excludeLintDeprecation: undefined,
 	excludeLintESLint: undefined,
 	excludeLintJSDoc: undefined,
@@ -94,8 +94,8 @@ describe("augmentOptionsWithExcludes", () => {
 
 		expect(actual).toEqual({
 			...options,
+			excludeAllContributors: true,
 			excludeCompliance: true,
-			excludeContributors: true,
 			excludeLintDeprecation: true,
 			excludeLintESLint: true,
 			excludeLintJSDoc: true,
diff --git a/src/shared/options/augmentOptionsWithExcludes.ts b/src/shared/options/augmentOptionsWithExcludes.ts
@@ -13,17 +13,17 @@ interface ExclusionDescription {
 type ExclusionKey = keyof Options & `exclude${string}`;
 
 const exclusionDescriptions: Record<ExclusionKey, ExclusionDescription> = {
+	excludeAllContributors: {
+		hint: "--exclude-all-contributors",
+		label:
+			"Add all-contributors to track contributions and display them in a README.md table.",
+	},
 	excludeCompliance: {
 		hint: "--exclude-compliance",
 		label:
 			"Add a GitHub Actions workflow to verify that PRs match an expected format.",
 		uncommon: true,
 	},
-	excludeContributors: {
-		hint: "--exclude-contributors",
-		label:
-			"Add all-contributors to track contributions and display them in a README.md table.",
-	},
 	excludeLintDeprecation: {
 		hint: "--exclude-lint-deprecation",
 		label:
diff --git a/src/shared/options/optionsSchema.ts b/src/shared/options/optionsSchema.ts
@@ -19,8 +19,8 @@ export const optionsSchemaShape = {
 			npm: z.string().email(),
 		})
 		.optional(),
+	excludeAllContributors: z.boolean().optional(),
 	excludeCompliance: z.boolean().optional(),
-	excludeContributors: z.boolean().optional(),
 	excludeLintDeprecation: z.boolean().optional(),
 	excludeLintESLint: z.boolean().optional(),
 	excludeLintJSDoc: z.boolean().optional(),
@@ -46,6 +46,7 @@ export const optionsSchemaShape = {
 		.optional(),
 	owner: z.string().optional(),
 	repository: z.string().optional(),
+	skipAllContributorsApi: z.boolean().optional(),
 	skipGitHubApi: z.boolean().optional(),
 	skipInstall: z.boolean().optional(),
 	skipRemoval: z.boolean().optional(),
diff --git a/src/shared/options/readOptions.test.ts b/src/shared/options/readOptions.test.ts
@@ -11,8 +11,8 @@ const emptyOptions = {
 	createRepository: undefined,
 	description: undefined,
 	email: undefined,
+	excludeAllContributors: undefined,
 	excludeCompliance: undefined,
-	excludeContributors: undefined,
 	excludeLintDeprecation: undefined,
 	excludeLintESLint: undefined,
 	excludeLintJSDoc: undefined,
@@ -32,6 +32,7 @@ const emptyOptions = {
 	funding: undefined,
 	owner: undefined,
 	repository: undefined,
+	skipAllContributorsApi: undefined,
 	skipGitHubApi: undefined,
 	skipInstall: undefined,
 	skipRemoval: undefined,
diff --git a/src/shared/options/readOptions.ts b/src/shared/options/readOptions.ts
@@ -56,8 +56,8 @@ export async function readOptions(
 						npm: values.email ?? values["email-npm"],
 				  }
 				: undefined,
+		excludeAllContributors: values["exclude-all-contributors"],
 		excludeCompliance: values["exclude-compliance"],
-		excludeContributors: values["exclude-contributors"],
 		excludeLintDeprecation: values["exclude-lint-deprecation"],
 		excludeLintESLint: values["exclude-lint-eslint"],
 		excludeLintJSDoc: values["exclude-lint-jsdoc"],
@@ -77,6 +77,7 @@ export async function readOptions(
 		funding: values.funding,
 		owner: values.owner,
 		repository: values.repository,
+		skipAllContributorsApi: values["skip-all-contributors-api"],
 		skipGitHubApi: values["skip-github-api"],
 		skipInstall: values["skip-install"],
 		skipRemoval: values["skip-removal"],
diff --git a/src/shared/types.ts b/src/shared/types.ts
@@ -40,8 +40,8 @@ export interface Options {
 	createRepository?: boolean;
 	description: string;
 	email: OptionsEmail;
+	excludeAllContributors?: boolean;
 	excludeCompliance?: boolean;
-	excludeContributors?: boolean;
 	excludeLintDeprecation?: boolean;
 	excludeLintESLint?: boolean;
 	excludeLintJSDoc?: boolean;
@@ -64,6 +64,7 @@ export interface Options {
 	mode: Mode;
 	owner: string;
 	repository: string;
+	skipAllContributorsApi?: boolean;
 	skipGitHubApi?: boolean;
 	skipInstall?: boolean;
 	skipRemoval?: boolean;
diff --git a/src/steps/finalizeDependencies.test.ts b/src/steps/finalizeDependencies.test.ts
@@ -26,8 +26,8 @@ const options = {
 		github: "github@email.com",
 		npm: "npm@email.com",
 	},
+	excludeAllContributors: undefined,
 	excludeCompliance: undefined,
-	excludeContributors: undefined,
 	excludeLintJson: undefined,
 	excludeLintKnip: undefined,
 	excludeLintMd: undefined,
@@ -71,8 +71,8 @@ describe("finalize", () => {
 	it("installs the base list of commands when all options are enabled", async () => {
 		await finalizeDependencies({
 			...options,
+			excludeAllContributors: true,
 			excludeCompliance: true,
-			excludeContributors: true,
 			excludeLintJson: true,
 			excludeLintKnip: true,
 			excludeLintMd: true,
diff --git a/src/steps/finalizeDependencies.ts b/src/steps/finalizeDependencies.ts
@@ -21,7 +21,7 @@ export async function finalizeDependencies(options: Options) {
 		"prettier-plugin-packagejson",
 		"tsup",
 		"typescript",
-		...(options.excludeContributors ? [] : ["all-contributors-cli"]),
+		...(options.excludeAllContributors ? [] : ["all-contributors-cli"]),
 		...(options.excludeLintJson
 			? []
 			: ["eslint-plugin-jsonc", "jsonc-eslint-parser"]),
@@ -68,7 +68,7 @@ export async function finalizeDependencies(options: Options) {
 
 	await execaCommand(`pnpm add ${devDependencies} -D`);
 
-	if (!options.excludeContributors) {
+	if (!options.excludeAllContributors) {
 		await execaCommand(`npx all-contributors-cli generate`);
 		await removeDependencies(
 			["all-contributors-cli", "all-contributors-for-repository"],
diff --git a/src/steps/updateLocalFiles.test.ts b/src/steps/updateLocalFiles.test.ts
@@ -29,8 +29,8 @@ const options = {
 		github: "github@email.com",
 		npm: "npm@email.com",
 	},
+	excludeAllContributors: undefined,
 	excludeCompliance: undefined,
-	excludeContributors: undefined,
 	excludeLintJson: undefined,
 	excludeLintKnip: undefined,
 	excludeLintMd: undefined,
diff --git a/src/steps/writeReadme/generateTopContent.test.ts b/src/steps/writeReadme/generateTopContent.test.ts
@@ -13,8 +13,8 @@ const optionsBase = {
 		github: "github@email.com",
 		npm: "npm@email.com",
 	},
+	excludeAllContributors: undefined,
 	excludeCompliance: undefined,
-	excludeContributors: undefined,
 	excludeLintJson: undefined,
 	excludeLintKnip: undefined,
 	excludeLintMd: undefined,
diff --git a/src/steps/writeReadme/generateTopContent.ts b/src/steps/writeReadme/generateTopContent.ts
@@ -23,7 +23,7 @@ export function generateTopContent(options: Options, existingBadges: string[]) {
 
 	for (const [badgeLine, existingMatcher] of [
 		[
-			!options.excludeContributors &&
+			!options.excludeAllContributors &&
 				`<a href="#contributors" target="_blank">
 <!-- prettier-ignore-start -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
diff --git a/src/steps/writeReadme/index.test.ts b/src/steps/writeReadme/index.test.ts
diff --git a/src/steps/writeReadme/index.ts b/src/steps/writeReadme/index.ts
diff --git a/src/steps/writing/creation/createESLintRC.test.ts b/src/steps/writing/creation/createESLintRC.test.ts
diff --git a/src/steps/writing/creation/dotGitHub/createDevelopment.test.ts b/src/steps/writing/creation/dotGitHub/createDevelopment.test.ts
diff --git a/src/steps/writing/creation/dotGitHub/createWorkflows.test.ts b/src/steps/writing/creation/dotGitHub/createWorkflows.test.ts
diff --git a/src/steps/writing/creation/dotGitHub/createWorkflows.ts b/src/steps/writing/creation/dotGitHub/createWorkflows.ts
diff --git a/src/steps/writing/creation/dotGitHub/index.ts b/src/steps/writing/creation/dotGitHub/index.ts
diff --git a/src/steps/writing/creation/rootFiles.ts b/src/steps/writing/creation/rootFiles.ts
diff --git a/src/steps/writing/creation/writePackageJson.test.ts b/src/steps/writing/creation/writePackageJson.test.ts
