feat: allow specific GitHub and/or npm emails (#858)

## PR Checklist

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

Builds off the ideas in #851 by adding optional `--email-github` and
`--email-npm` overrides. Adds a string complaint if an improper
combination is specified: one of those two without the other or `email`,
or both of those two along with `email`. At this point `email` is now a
required option.

Adjusts the sorting of rerun suggestions a bit to make sure emails are
sorted inline and `--base` comes immediately after `--mode`.

Also fills in some unit test coverage in the area.

Author: JoshuaKGoldberg

.github/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-npm@joshuakgoldberg.com.
+github@joshuakgoldberg.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/SECURITY.md

@@ -4,6 +4,6 @@ We take all security vulnerabilities seriously.
 If you have a vulnerability or other security issues to disclose:
 
 - Thank you very much, please do!
-- Please send them to us by emailing `npm@joshuakgoldberg.com`
+- Please send them to us by emailing `github@joshuakgoldberg.com`
 
 We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.

docs/Options.md

@@ -51,6 +51,7 @@ The setup scripts also allow for optional overrides of the following inputs whos
 
 - `--author` _(`string`)_: Username on npm to publish packages under (by default, an existing npm author, or the currently logged in npm user, or `owner.toLowerCase()`)
 - `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
+  - Optionally, `--email-github` _(`string`)_ and/or `--email-npm` _(`string`)_ may be provided to use different emails in `.md` files and `package.json`, respectively
 - `--funding` _(`string`)_: GitHub organization or username to mention in `funding.yml` (by default, `owner`)
 - `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md as a logo
   - `--logo-alt` _(`string`)_: If `--logo` is provided or detected from an existing README.md, alt text that describes the image will be prompted for if not provided

script/migrate-test-e2e.js

@@ -4,12 +4,14 @@ import { $, execaCommand } from "execa";
 import packageData from "../package.json" assert { type: "json" };
 
 const { description, name: repository } = packageData;
+const emailGithub = "[email protected]";
+const emailNpm = "[email protected]";
 const owner = "JoshuaKGoldberg";
 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} --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} --exclude-contributors --skip-github-api --skip-install`;
 
 const { stdout: gitStatus } = await $`git status`;
 console.log(`Stdout from running \`git status\`:\n${gitStatus}`);

src/bin/index.test.ts

@@ -120,7 +120,30 @@ describe("bin", () => {
 		expect(result).toEqual(code);
 	});
 
-	it("returns the cancel result containing zod error of the corresponding runner and output plus cancel logs when promptForMode returns a mode that cancels", async () => {
+	it("returns the cancel result containing a zod error of the corresponding runner and output plus cancel logs when promptForMode returns a mode that cancels with a string error", async () => {
+		const mode = "initialize";
+		const args = ["--email", "abc123"];
+		const code = 2;
+		const error = "Oh no!";
+
+		mockPromptForMode.mockResolvedValue(mode);
+		mockInitialize.mockResolvedValue({
+			code: 2,
+			error,
+			options: {},
+		});
+
+		const result = await bin(args);
+
+		expect(mockInitialize).toHaveBeenCalledWith(args);
+		expect(mockLogLine).toHaveBeenCalledWith(chalk.red(error));
+		expect(mockCancel).toHaveBeenCalledWith(
+			`Operation cancelled. Exiting - maybe another time? 👋`,
+		);
+		expect(result).toEqual(code);
+	});
+
+	it("returns the cancel result containing a zod error of the corresponding runner and output plus cancel logs when promptForMode returns a mode that cancels with a zod error", async () => {
 		const mode = "initialize";
 		const args = ["--email", "abc123"];
 		const code = 2;
@@ -132,8 +155,8 @@ describe("bin", () => {
 		mockPromptForMode.mockResolvedValue(mode);
 		mockInitialize.mockResolvedValue({
 			code: 2,
+			error: (validationResult as z.SafeParseError<{ email: string }>).error,
 			options: {},
-			zodError: (validationResult as z.SafeParseError<{ email: string }>).error,
 		});
 
 		const result = await bin(args);

src/bin/index.ts

@@ -52,7 +52,7 @@ export async function bin(args: string[]) {
 	}
 
 	const runners = { create, initialize, migrate };
-	const { code, options, zodError } = await runners[mode](args);
+	const { code, error, options } = await runners[mode](args);
 
 	prompts.log.info(
 		[
@@ -64,9 +64,10 @@ export async function bin(args: string[]) {
 	if (code) {
 		logLine();
 
-		if (zodError) {
-			const validationError = fromZodError(zodError);
-			logLine(chalk.red(validationError));
+		if (error) {
+			logLine(
+				chalk.red(typeof error === "string" ? error : fromZodError(error)),
+			);
 			logLine();
 		}
 

src/bin/mode.ts

@@ -8,8 +8,8 @@ import { Options } from "../shared/types.js";
 
 export interface ModeResult {
 	code: StatusCode;
+	error?: string | z.ZodError<object>;
 	options: Partial<Options>;
-	zodError?: z.ZodError<object>;
 }
 
 export type ModeRunner = (args: string[]) => Promise<ModeResult>;

src/create/createRerunSuggestion.test.ts

@@ -8,7 +8,10 @@ const options = {
 	base: "everything",
 	createRepository: true,
 	description: "Test description.",
-	email: "[email protected]",
+	email: {
+		github: "[email protected]",
+		npm: "[email protected]",
+	},
 	excludeCompliance: true,
 	excludeContributors: true,
 	excludeLintJson: true,
@@ -39,7 +42,7 @@ describe("createRerunSuggestion", () => {
 		const actual = createRerunSuggestion("initialize", options);
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --author TestAuthor --base everything --create-repository true --description \\"Test description.\\" --email test@test.com --exclude-compliance true --exclude-contributors true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --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 --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm npm@email.com --exclude-compliance true --exclude-contributors true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -53,7 +56,7 @@ describe("createRerunSuggestion", () => {
 		});
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --author TestAuthor --base everything --create-repository true --description \\"Test description.\\" --email test@test.com --exclude-compliance true --exclude-contributors true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --logo test/src.png --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\" --logo-alt \\"Test alt.\\""',
+			'"npx create-typescript-app --mode initialize --base everything --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github github@email.com --email-npm [email protected] --exclude-compliance true --exclude-contributors 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.\\" --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -66,7 +69,7 @@ describe("createRerunSuggestion", () => {
 		});
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --author TestAuthor --base everything --create-repository true --description \\"Test description.\\" --email test@test.com --exclude-compliance true --exclude-contributors 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 --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 --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm npm@email.com --exclude-compliance true --exclude-contributors 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 --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 });

src/create/createRerunSuggestion.ts

@@ -14,6 +14,13 @@ export function createRerunSuggestion(
 ): string {
 	const optionsNormalized = {
 		...options,
+		...(options.email
+			? {
+					email: undefined,
+					emailGitHub: options.email.github,
+					emailNpm: options.email.npm,
+			  }
+			: { email: undefined }),
 		...(options.logo
 			? {
 					logo: options.logo.src,
@@ -23,6 +30,9 @@ export function createRerunSuggestion(
 	};
 
 	const args = Object.entries(optionsNormalized)
+		.sort(([a], [b]) =>
+			a === "base" ? -1 : b === "base" ? 1 : a.localeCompare(b),
+		)
 		.filter(([, value]) => !!value)
 		.map(([key, value]) => {
 			const valueStringified = `${value}`;

src/create/index.ts

@@ -15,8 +15,8 @@ export async function create(args: string[]): Promise<ModeResult> {
 	if (inputs.cancelled) {
 		return {
 			code: StatusCodes.Cancelled,
+			error: inputs.error,
 			options: inputs.options,
-			zodError: inputs.zodError,
 		};
 	}
 

src/initialize/index.ts

@@ -11,8 +11,8 @@ export const initialize: ModeRunner = async (args) => {
 	if (inputs.cancelled) {
 		return {
 			code: StatusCodes.Cancelled,
+			error: inputs.error,
 			options: inputs.options,
-			zodError: inputs.zodError,
 		};
 	}
 

src/migrate/index.ts

@@ -11,8 +11,8 @@ export const migrate: ModeRunner = async (args) => {
 	if (inputs.cancelled) {
 		return {
 			code: StatusCodes.Cancelled,
+			error: inputs.error,
 			options: inputs.options,
-			zodError: inputs.zodError,
 		};
 	}
 

src/shared/options/args.ts

@@ -4,6 +4,8 @@ export const allArgOptions = {
 	"create-repository": { type: "boolean" },
 	description: { type: "string" },
 	email: { type: "string" },
+	"email-github": { type: "string" },
+	"email-npm": { type: "string" },
 	"exclude-compliance": { type: "boolean" },
 	"exclude-contributors": { type: "boolean" },
 	"exclude-lint-json": { type: "boolean" },

src/shared/options/augmentOptionsWithExcludes.test.ts

@@ -8,7 +8,10 @@ const optionsBase = {
 	base: undefined,
 	createRepository: undefined,
 	description: "",
-	email: undefined,
+	email: {
+		github: "[email protected]",
+		npm: "[email protected]",
+	},
 	excludeCompliance: undefined,
 	excludeContributors: undefined,
 	excludeLintJson: undefined,

src/shared/options/detectEmailRedundancy.test.ts

@@ -0,0 +1,38 @@
+import { describe, expect, it } from "vitest";
+
+import { detectEmailRedundancy } from "./detectEmailRedundancy.js";
+
+describe("detectEmailRedundancy", () => {
+	it("returns undefined when only email is specified", () => {
+		expect(detectEmailRedundancy({ email: "[email protected]" })).toBeUndefined();
+	});
+
+	it("returns undefined when email-github and email-npm are specified while email is not", () => {
+		expect(
+			detectEmailRedundancy({
+				"email-github": "[email protected]",
+				"email-npm": "[email protected]",
+			}),
+		).toBeUndefined();
+	});
+
+	it("returns a complaint when email-github is specified while email and email-npm are not", () => {
+		expect(
+			detectEmailRedundancy({
+				"email-github": "[email protected]",
+			}),
+		).toBe(
+			"If --email-github is specified, either --email or --email-npm should be.",
+		);
+	});
+
+	it("returns a complaint when email-npm is specified while email and email-github are not", () => {
+		expect(
+			detectEmailRedundancy({
+				"email-npm": "[email protected]",
+			}),
+		).toBe(
+			"If --email-npm is specified, either --email or --email-github should be.",
+		);
+	});
+});

src/shared/options/detectEmailRedundancy.ts

@@ -0,0 +1,23 @@
+export interface EmailValues {
+	email?: boolean | string;
+	"email-github"?: boolean | string;
+	"email-npm"?: boolean | string;
+}
+
+export function detectEmailRedundancy(values: EmailValues) {
+	if (values.email) {
+		return values["email-github"] && values["email-npm"]
+			? "--email should not be specified if both --email-github and --email-npm are specified."
+			: undefined;
+	}
+
+	if (values["email-github"] && !values["email-npm"]) {
+		return "If --email-github is specified, either --email or --email-npm should be.";
+	}
+
+	if (values["email-npm"] && !values["email-github"]) {
+		return "If --email-npm is specified, either --email or --email-github should be.";
+	}
+
+	return undefined;
+}

src/shared/options/optionsSchema.ts

@@ -0,0 +1,47 @@
+import { z } from "zod";
+
+export const optionsSchemaShape = {
+	author: z.string().optional(),
+	base: z
+		.union([
+			z.literal("common"),
+			z.literal("everything"),
+			z.literal("minimum"),
+			z.literal("prompt"),
+		])
+		.optional(),
+	createRepository: z.boolean().optional(),
+	description: z.string().optional(),
+	email: z
+		.object({
+			github: z.string().email(),
+			npm: z.string().email(),
+		})
+		.optional(),
+	excludeCompliance: z.boolean().optional(),
+	excludeContributors: z.boolean().optional(),
+	excludeLintJson: z.boolean().optional(),
+	excludeLintKnip: z.boolean().optional(),
+	excludeLintMd: z.boolean().optional(),
+	excludeLintPackageJson: z.boolean().optional(),
+	excludeLintPackages: z.boolean().optional(),
+	excludeLintPerfectionist: z.boolean().optional(),
+	excludeLintSpelling: z.boolean().optional(),
+	excludeLintYml: z.boolean().optional(),
+	excludeReleases: z.boolean().optional(),
+	excludeRenovate: z.boolean().optional(),
+	excludeTests: z.boolean().optional(),
+	funding: z.string().optional(),
+	logo: z.string().optional(),
+	logoAlt: z.string().optional(),
+	owner: z.string().optional(),
+	repository: z.string().optional(),
+	skipGitHubApi: z.boolean().optional(),
+	skipInstall: z.boolean().optional(),
+	skipRemoval: z.boolean().optional(),
+	skipRestore: z.boolean().optional(),
+	skipUninstall: z.boolean().optional(),
+	title: z.string().optional(),
+};
+
+export const optionsSchema = z.object(optionsSchemaShape);