chore: bring in updates for create's interactive CLI

docs/Options.md

@@ -37,7 +37,7 @@ These required options determine the options that will be substituted into the t
 - `--description` _(`string`)_: Sentence case description of the repository (e.g. `Quickstart-friendly TypeScript package with lots of great repository tooling. ✨`)
 - `--owner` _(`string`)_: GitHub organization or user the repository is underneath (e.g. `JoshuaKGoldberg`)
 - `--repository` _(`string`)_: The kebab-case name of the repository (e.g. `create-typescript-app`)
-- `--title` _(`string`)_: Title Case title for the repository to be used in documentation (e.g. `Create TypeScript App`)
+- `--title` _(`string`)_: Title Case title for the repository (e.g. `Create TypeScript App`)
 
 For example, pre-populating all core required options and also creating a new repository:
 
@@ -53,16 +53,16 @@ The setup scripts also allow for optional overrides of the following inputs whos
 
 - `--access` _(`"public" | "restricted"`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
 - `--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()`)
-- `--bin` _(`string`)_: value to set in `package.json`'s `"bin"` property, per [FAQs > How can I use `bin`?](./FAQs.md#how-can-i-use-bin)
+- `--bin` _(`string`)_: Value to set in `package.json`'s `"bin"` property, per [FAQs > How can I use `bin`?](./FAQs.md#how-can-i-use-bin)
 - `--directory` _(`string`)_: Directory to create the repository in (by default, the same name as the repository)
 - `--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`)
-- `--guide` _(`string`)_: Link to a contribution guide to place at the top of the development docs
+- `--guide` _(`string`)_: Link to a contribution guide to place at the top of development docs
   - `--guide-title` _(`string`)_: If `--guide` is provided or detected from an existing DEVELOPMENT.md, the text title to place in the guide link
 - `--keywords` _(`string[]`)_: Any number of keywords to include in `package.json` (by default, none)
   - This can be specified any number of times, like `--keywords apple --keywords "banana cherry"`
-- `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md as a logo
+- `--logo` _(`string`)_: Local image file in the repository to display near the top of the README.md
   - `--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)
 - `--preserve-generated-from` _(`boolean`)_: Whether to keep the GitHub repository _generated from_ notice (by default, `false`)
 

src/next/base.ts

@@ -5,6 +5,7 @@ import gitUrlParse from "git-url-parse";
 import { inputFromFile } from "input-from-file";
 import { inputFromFileJSON } from "input-from-file-json";
 import lazyValue from "lazy-value";
+import path from "node:path";
 import npmUser from "npm-user";
 import { z } from "zod";
 
@@ -16,13 +17,25 @@ import { readGuide } from "../shared/options/createOptionDefaults/readGuide.js";
 import { readPackageData } from "../shared/packages.js";
 import { tryCatchLazyValueAsync } from "../shared/tryCatchLazyValueAsync.js";
 import { AllContributorsData } from "../shared/types.js";
+import { inputFromScript } from "./inputs/inputFromScript.js";
 import { swallowError } from "./utils/swallowError.js";
 
+// TODO: Add a concept of Block-specific Options...
+
 export const base = createBase({
 	options: {
-		access: z.union([z.literal("public"), z.literal("restricted")]).optional(),
-		author: z.string().optional(),
-		bin: z.string().optional(),
+		access: z
+			.union([z.literal("public"), z.literal("restricted")])
+			.optional()
+			.describe("which `npm publish --access` to release npm packages with"),
+		author: z
+			.string()
+			.optional()
+			.describe("username on npm to publish packages under"),
+		bin: z
+			.string()
+			.optional()
+			.describe('value to set in `package.json`\'s `"bin"` property.'),
 		contributors: z
 			.array(
 				z.object({
@@ -33,9 +46,16 @@ export const base = createBase({
 					profile: z.string(),
 				}),
 			)
-			.optional(),
-		description: z.string(),
-		documentation: z.string().optional(),
+			.optional()
+			.describe("allcontributors contributors to store in .all-contributorsrc"),
+		description: z
+			.string()
+			.describe("sentence case description of the repository"),
+		directory: z.string(),
+		documentation: z
+			.string()
+			.optional()
+			.describe("any additional docs to add to .github/DEVELOPMENT.md"),
 		email: z
 			.union([
 				z.string(),
@@ -46,46 +66,77 @@ export const base = createBase({
 			])
 			.transform((email) =>
 				typeof email === "string" ? { github: email, npm: email } : email,
+			)
+			.describe(
+				"email address to be listed as the point of contact in docs and packages",
 			),
-		funding: z.string().optional(),
+		funding: z
+			.string()
+			.optional()
+			.describe("GitHub organization or username to mention in `funding.yml`"),
 		guide: z
 			.object({
 				href: z.string(),
 				title: z.string(),
 			})
-			.optional(),
-		hideTemplatedBy: z.boolean().optional(),
-		keywords: z.array(z.string()).optional(),
-		login: z.string().optional(),
+			.optional()
+			.describe(
+				"link to a contribution guide to place at the top of development docs",
+			),
+		hideTemplatedBy: z
+			.boolean()
+			.optional()
+			.describe(
+				"whether to hide the 'created by ...' notice at the bottom of the README.md",
+			),
+		keywords: z
+			.array(z.string())
+			.optional()
+			.describe("any number of keywords to include in `package.json`"),
 		logo: z
 			.object({
 				alt: z.string(),
 				src: z.string(),
 			})
-			.optional(),
+			.optional()
+			.describe(
+				"local image file in the repository to display near the top of the README.md",
+			),
 		node: z
 			.object({
 				minimum: z.string(),
 				pinned: z.string().optional(),
 			})
-			.optional(),
-		owner: z.string(),
+			.optional()
+			.describe("node.js engine version(s) to pin and require a minimum of"),
+		owner: z
+			.string()
+			.describe("GitHub organization or user the repository is underneath"),
 		packageData: z
 			.object({
 				dependencies: z.record(z.string(), z.string()).optional(),
 				devDependencies: z.record(z.string(), z.string()).optional(),
 				scripts: z.record(z.string(), z.string()).optional(),
 			})
-			.optional(),
-		preserveGeneratedFrom: z.boolean().optional(),
-		repository: z.string(),
-		title: z.string(),
-		version: z.string().optional(),
+			.optional()
+			.describe("additional properties to include in `package.json`"),
+		repository: z
+			.string()
+			.describe("sentence case description of the repository"),
+		title: z.string().describe("title case title for the repository"),
+		version: z
+			.string()
+			.optional()
+			.describe("package version to publish as and store in `package.json`"),
 	},
 	produce({ options, take }) {
+		// TODO: Make directory required at the create level
+		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+		const directory = options.directory!;
+
 		const allContributors = lazyValue(async () => {
 			const contributions = (await take(inputFromFileJSON, {
-				filePath: ".all-contributorsrc",
+				filePath: path.join(directory, ".all-contributorsrc"),
 			})) as AllContributorsData;
 
 			return contributions.contributors;
@@ -94,30 +145,38 @@ export const base = createBase({
 		const documentation = lazyValue(async () =>
 			swallowError(
 				await take(inputFromFile, {
-					filePath: ".github/DEVELOPMENT.md",
+					filePath: path.join(directory, ".github/DEVELOPMENT.md"),
 				}),
 			),
 		);
 
 		const nvmrc = lazyValue(
 			async () =>
 				await take(inputFromFile, {
-					filePath: ".nvmrc",
+					filePath: path.join(directory, ".nvmrc"),
 				}),
 		);
 
+		const githubCliUser = lazyValue(async () => {
+			return swallowError(
+				await take(inputFromScript, {
+					command: "gh config get user -h github.com",
+				}),
+			)?.stdout?.toString();
+		});
+
 		// TODO: Make these all use take
 
 		const gitDefaults = tryCatchLazyValueAsync(async () =>
-			gitUrlParse(await gitRemoteOriginUrl()),
+			gitUrlParse(await gitRemoteOriginUrl({ cwd: options.directory })),
 		);
 
 		const npmDefaults = tryCatchLazyValueAsync(async () => {
 			const whoami = (await execaCommand(`npm whoami`)).stdout;
 			return whoami ? await npmUser(whoami) : undefined;
 		});
 
-		const packageData = lazyValue(readPackageData);
+		const packageData = lazyValue(async () => readPackageData(directory));
 		const packageAuthor = lazyValue(async () =>
 			parsePackageAuthor(await packageData()),
 		);
@@ -149,12 +208,14 @@ export const base = createBase({
 			description: async () => (await packageData()).description,
 			documentation,
 			email: async () => readEmails(npmDefaults, packageAuthor),
-			funding: readFunding,
-			guide: readGuide,
+			funding: async () => readFunding(directory),
+			guide: async () => readGuide(directory),
 			login: author,
 			node,
 			owner: async () =>
-				(await gitDefaults())?.organization ?? (await packageAuthor()).author,
+				(await gitDefaults())?.organization ??
+				(await packageAuthor()).author ??
+				(await githubCliUser()),
 			packageData: async () => {
 				const original = await packageData();
 
@@ -168,7 +229,7 @@ export const base = createBase({
 				options.repository ??
 				(await gitDefaults())?.name ??
 				(await packageData()).name,
-			...readDefaultsFromReadme(),
+			...readDefaultsFromReadme(directory),
 			version,
 		};
 	},

src/next/blocks/blockRepositoryBranchProtection.ts

@@ -16,7 +16,7 @@ export const blockRepositoryBranchProtection = base.createBlock({
 					id: "branch-protection",
 					async send({ octokit }) {
 						await octokit.request(
-							`PUT /repos/{owner}/{repository}/branches/{main}/protection`,
+							`PUT /repos/{owner}/{repo}/branches/{branch}/protection`,
 							{
 								allow_deletions: false,
 								allow_force_pushes: true,
@@ -31,10 +31,12 @@ export const blockRepositoryBranchProtection = base.createBlock({
 								required_linear_history: false,
 								required_pull_request_reviews: null,
 								required_status_checks: {
-									checks: addons.requiredStatusChecks.map((context) => ({
-										context,
-									})),
-									strict: false,
+									contexts: addons.requiredStatusChecks,
+									strict: true,
+									// checks: addons.requiredStatusChecks.map((context) => ({
+									// 	context,
+									// })),
+									// strict: false,
 								},
 								restrictions: null,
 							},

src/next/blocks/blockRepositoryLabels.ts

@@ -1,3 +1,5 @@
+import { setGitHubRepositoryLabels } from "set-github-repository-labels";
+
 import { outcomeLabels } from "../../steps/initializeGitHubRepository/outcomeLabels.js";
 import { base } from "../base.js";
 
@@ -7,8 +9,17 @@ export const blockRepositoryLabels = base.createBlock({
 	},
 	produce({ options }) {
 		return {
-			scripts: [
-				`npx set-github-repository-labels --labels ${JSON.stringify(outcomeLabels)} --owner "${options.owner}" --repository "${options.repository}"`,
+			requests: [
+				{
+					id: "repository-labels",
+					async send() {
+						await setGitHubRepositoryLabels({
+							labels: outcomeLabels,
+							owner: options.owner,
+							repository: options.repository,
+						});
+					},
+				},
 			],
 		};
 	},

src/next/blocks/blockRepositorySettings.ts

@@ -14,7 +14,7 @@ export const blockRepositorySettings = base.createBlock({
 							allow_auto_merge: true,
 							allow_rebase_merge: false,
 							allow_squash_merge: true,
-							default_branch: "main",
+							// default_branch: "main",
 							delete_branch_on_merge: true,
 							description: options.description,
 							has_wiki: false,

src/next/blocks/options.fakes.ts

@@ -3,6 +3,7 @@ import { BaseOptions } from "../base.js";
 export const optionsBase = {
 	access: "public",
 	description: "Test description",
+	directory: ".",
 	email: {
 		github: "[email protected]",
 		npm: "[email protected]",

src/next/inputs/inputFromScript.ts

@@ -0,0 +1,15 @@
+import { createInput } from "create";
+import { z } from "zod";
+
+export const inputFromScript = createInput({
+	args: {
+		command: z.string(),
+	},
+	async produce({ args, runner }) {
+		try {
+			return await runner(args.command);
+		} catch (error) {
+			return error instanceof Error ? error : new Error(error as string);
+		}
+	},
+});

src/next/template.ts

@@ -9,11 +9,11 @@
 		name: "TypeScript App",
 	},
 	default: "common",
-	presets: [
-		{ label: "common", preset: presetCommon },
-		{ label: "everything", preset: presetEverything },
-		{ label: "minimal", preset: presetMinimal },
-	],
+	presets: {
+		common: { label: "Common", preset: presetCommon },
+		everything: { label: "Everything", preset: presetEverything },
+		minimal: { label: "Minimal", preset: presetMinimal },
+	},
 });
 
 export default template;

src/shared/options/createOptionDefaults/index.ts

@@ -24,7 +24,7 @@ export function createOptionDefaults(promptedOptions?: PromptedOptions) {
 		return whoami ? await npmUser(whoami) : undefined;
 	});
 
-	const packageData = lazyValue(readPackageData);
+	const packageData = lazyValue(async () => readPackageData("."));
 	const packageAuthor = lazyValue(async () =>
 		parsePackageAuthor(await packageData()),
 	);
@@ -42,13 +42,13 @@ export function createOptionDefaults(promptedOptions?: PromptedOptions) {
 					.split(":")[1]
 					?.trim(),
 			),
-		guide: readGuide,
+		guide: async () => readGuide("."),
 		owner: async () =>
 			(await gitDefaults())?.organization ?? (await packageAuthor()).author,
 		repository: async () =>
 			promptedOptions?.repository ??
 			(await gitDefaults())?.name ??
 			(await packageData()).name,
-		...readDefaultsFromReadme(),
+		...readDefaultsFromReadme("."),
 	};
 }