fix: use standard packages or link to issues for remaining code TODOs (#1994)

JoshuaKGoldberg · web-flow · commit 855c1dafe6d9 · 2025-03-17T23:52:33.000-04:00
## PR Checklist - [x] Addresses an existing open issue: fixes #1987 - [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 Cleans up some pending code TODOs: * Bumping `@vitest/eslint-plugin` to include vitest-dev/eslint-plugin-vitest#682 * Refactors `retGitDefaults` to execute a straightforward `git remote get-url origin` instead of the full `git-remote-origin-url` * Uses [`sort-keys`](http://npmjs.com/package/sort-keys) instead of the ad-hoc internal `sortKeys` * Uses [`zod-package-json`](http://npmjs.com/package/zod-package-json) instead of a manually written schema Otherwise doesn't change behavior, instead adding links to: * #1990 * #1991 * #1992 * #1993 🎁
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -45,7 +45,7 @@ Each defaults to a value based on the running system, including an repository if
 
 | Flag           | Type       | Description                                                                                                         | Default                                                                               |
 | -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `--access`     | `string`   | Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with | `"public"` (TODO: file issue for `readAccess`)                                        |
+| `--access`     | `string`   | Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with | `"public"`                                                                            |
 | `--author`     | `string`   | Username on npm to publish packages under                                                                           | 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)   | _(none)_                                                                              |
 | `--email`      | `string`   | Email address to be listed as the point of contact in docs and packages (e.g. `example@joshuakgoldberg.com`)        | Yours from `gh`, `git config`, or `npm whoami`                                        |
diff --git a/package.json b/package.json
@@ -42,7 +42,6 @@
 		"bingo-stratum": "^0.5.5",
 		"cspell-populate-words": "^0.3.0",
 		"execa": "^9.5.2",
-		"git-remote-origin-url": "^4.0.0",
 		"git-url-parse": "^16.0.1",
 		"github-default-labels": "^0.1.0",
 		"html-to-text": "^9.0.5",
@@ -60,9 +59,11 @@
 		"remove-dependencies": "^0.1.0",
 		"remove-undefined-objects": "^6.0.0",
 		"set-github-repository-labels": "^0.2.0",
+		"sort-keys": "^5.1.0",
 		"sort-package-json": "^3.0.0",
 		"title-case": "^4.3.2",
-		"zod": "^3.24.2"
+		"zod": "^3.24.2",
+		"zod-package-json": "^1.1.0"
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.4.1",
@@ -77,7 +78,7 @@
 		"@types/node": "22.13.9",
 		"@types/parse-author": "2.0.3",
 		"@vitest/coverage-v8": "3.0.7",
-		"@vitest/eslint-plugin": "1.1.36",
+		"@vitest/eslint-plugin": "1.1.38",
 		"all-contributors-cli": "6.26.1",
 		"bingo-requests": "^0.5.4",
 		"bingo-stratum-testers": "0.5.6",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/base.ts b/src/base.ts
@@ -78,6 +78,7 @@ export const base = createBase({
 				}),
 			])
 			// TODO: Test this? Is it still working?
+			// https://github.com/JoshuaKGoldberg/create-typescript-app/issues/1991
 			.transform((email) =>
 				typeof email === "string" ? { github: email, npm: email } : email,
 			)
@@ -220,7 +221,7 @@ export const base = createBase({
 
 		const getFunding = lazyValue(async () => await readFunding(take));
 
-		const getGitDefaults = lazyValue(async () => await readGitDefaults());
+		const getGitDefaults = lazyValue(async () => await readGitDefaults(take));
 
 		const getGuide = lazyValue(async () => await readGuide(take));
 
diff --git a/src/blocks/blockESLint.ts b/src/blocks/blockESLint.ts
@@ -1,10 +1,10 @@
 // @ts-expect-error -- https://github.com/egoist/parse-package-name/issues/30
 import { parse as parsePackageName } from "parse-package-name";
+import sortKeys from "sort-keys";
 import { z } from "zod";
 
 import { base } from "../base.js";
 import { getPackageDependencies } from "../data/packageData.js";
-import { sortObject } from "../utils/sortObject.js";
 import { blockCSpell } from "./blockCSpell.js";
 import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
 import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
@@ -243,7 +243,7 @@ function printExtension(extension: z.infer<typeof zExtension>) {
 			`linterOptions: ${JSON.stringify(extension.linterOptions)}`,
 		extension.rules && `rules: ${printExtensionRules(extension.rules)},`,
 		extension.settings &&
-			`settings: ${JSON.stringify(sortObject(extension.settings))},`,
+			`settings: ${JSON.stringify(sortKeys(extension.settings))},`,
 		"}",
 	]
 		.filter(Boolean)
diff --git a/src/blocks/blockExampleFiles.ts b/src/blocks/blockExampleFiles.ts
@@ -16,8 +16,8 @@ export const blockExampleFiles = base.createBlock({
 			},
 		};
 	},
-	// TODO: Make produce() optional
-	// This needs createBlock to be generic to know if block.produce({}) is ok
+	// TODO: Make produce() optional, so this empty-ish produce() can be removed
+	// https://github.com/JoshuaKGoldberg/bingo/issues/295
 	produce() {
 		return {};
 	},
diff --git a/src/blocks/blockPackageJson.ts b/src/blocks/blockPackageJson.ts
@@ -2,6 +2,7 @@ import * as htmlToText from "html-to-text";
 import removeUndefinedObjects from "remove-undefined-objects";
 import sortPackageJson from "sort-package-json";
 import { z } from "zod";
+import { PackageJson } from "zod-package-json";
 
 import { base } from "../base.js";
 import { CommandPhase } from "./phases.js";
@@ -12,19 +13,7 @@ export const blockPackageJson = base.createBlock({
 	},
 	addons: {
 		cleanupCommands: z.array(z.string()).default([]),
-		// TODO: Find a zod package for this?
-		properties: z
-			.intersection(
-				z.object({
-					dependencies: z.record(z.string(), z.string()).optional(),
-					devDependencies: z.record(z.string(), z.string()).optional(),
-					files: z.array(z.string()).optional(),
-					peerDependencies: z.record(z.string(), z.string()).optional(),
-					scripts: z.record(z.string(), z.string()).optional(),
-				}),
-				z.record(z.string(), z.unknown()),
-			)
-			.default({}),
+		properties: PackageJson.partial().default({}),
 	},
 	produce({ addons, offline, options }) {
 		const dependencies = {
diff --git a/src/blocks/blockRepositoryBranchRuleset.ts b/src/blocks/blockRepositoryBranchRuleset.ts
@@ -49,8 +49,8 @@ export const blockRepositoryBranchRuleset = base.createBlock({
 			],
 		};
 	},
-	// TODO: Make produce() optional
-	// This needs createBlock to be generic to know if block.produce({}) is ok
+	// TODO: Make produce() optional, so this empty-ish produce() can be removed
+	// https://github.com/JoshuaKGoldberg/bingo/issues/295
 	produce() {
 		return {};
 	},
diff --git a/src/blocks/blockVSCode.ts b/src/blocks/blockVSCode.ts
@@ -1,7 +1,7 @@
+import sortKeys from "sort-keys";
 import { z } from "zod";
 
 import { base } from "../base.js";
-import { sortObject } from "../utils/sortObject.js";
 import { blockDevelopmentDocs } from "./blockDevelopmentDocs.js";
 
 export const blockVSCode = base.createBlock({
@@ -83,7 +83,7 @@ To launch it, open a test file, then run _Debug Current Test File_ from the VS C
 							version: "0.2.0",
 						}),
 					"settings.json": JSON.stringify(
-						sortObject({
+						sortKeys({
 							"editor.formatOnSave": true,
 							"editor.rulers": [80],
 							...settings,
diff --git a/src/blocks/blockVitest.test.ts b/src/blocks/blockVitest.test.ts
@@ -170,7 +170,7 @@ describe("blockVitest", () => {
 			        "properties": {
 			          "devDependencies": {
 			            "@vitest/coverage-v8": "3.0.7",
-			            "@vitest/eslint-plugin": "1.1.36",
+			            "@vitest/eslint-plugin": "1.1.38",
 			            "console-fail-test": "0.5.0",
 			            "vitest": "3.0.7",
 			          },
@@ -408,7 +408,7 @@ describe("blockVitest", () => {
 			        "properties": {
 			          "devDependencies": {
 			            "@vitest/coverage-v8": "3.0.7",
-			            "@vitest/eslint-plugin": "1.1.36",
+			            "@vitest/eslint-plugin": "1.1.38",
 			            "console-fail-test": "0.5.0",
 			            "vitest": "3.0.7",
 			          },
@@ -667,7 +667,7 @@ describe("blockVitest", () => {
 			        "properties": {
 			          "devDependencies": {
 			            "@vitest/coverage-v8": "3.0.7",
-			            "@vitest/eslint-plugin": "1.1.36",
+			            "@vitest/eslint-plugin": "1.1.38",
 			            "console-fail-test": "0.5.0",
 			            "vitest": "3.0.7",
 			          },
diff --git a/src/docsBlocks.test.ts b/src/docsBlocks.test.ts
@@ -29,9 +29,6 @@ describe("docs/Blocks.md", () => {
 			continue;
 		}
 
-		// TODO: Enable vitest/eslint-plugin type-checking:
-		// https://github.com/vitest-dev/eslint-plugin-vitest?tab=readme-ov-file#enabling-with-type-testing
-		// eslint-disable-next-line vitest/valid-title
 		test(name, () => {
 			const actualLine = actualLines.find((line) => line.includes(`| ${name}`));
 			const expectedLine = expectedLines[i];
diff --git a/src/inputs/inputFromOctokit.ts b/src/inputs/inputFromOctokit.ts
@@ -7,8 +7,7 @@ export const inputFromOctokit = createInput({
 		options: z.record(z.string(), z.unknown()).optional(),
 	},
 	// TODO: Strongly type this, then push it upstream to Bingo
-	// This will require smart types around GitHub endpoints, similar to:
-	// https://github.com/JoshuaKGoldberg/bingo/issues/65
+	// https://github.com/JoshuaKGoldberg/bingo/issues/296
 	async produce({ args, fetchers }): Promise<unknown> {
 		try {
 			const response = await fetchers.octokit.request(args.endpoint, {
diff --git a/src/options/readGitDefaults.test.ts b/src/options/readGitDefaults.test.ts
@@ -11,20 +11,20 @@ vi.mock("git-remote-origin-url", () => ({
 }));
 
 describe(readGitDefaults, () => {
-	it("resolves undefined when fetching the origin url rejects", async () => {
-		mockGitRemoteOriginUrl.mockRejectedValueOnce(new Error("Oh no!"));
+	it("resolves undefined when get-url origin has no stdout", async () => {
+		const take = vi.fn().mockResolvedValueOnce({});
 
-		const actual = await readGitDefaults();
+		const actual = await readGitDefaults(take);
 
 		expect(actual).toBeUndefined();
 	});
 
-	it("resolves the parsed when fetching the origin url succeeds", async () => {
-		mockGitRemoteOriginUrl.mockResolvedValueOnce(
-			"git@github.com/JoshuaKGoldberg/create-typescript-app",
-		);
+	it("resolves the parsed url when get-url origin url succeeds", async () => {
+		const take = vi.fn().mockResolvedValueOnce({
+			stdout: "https://github.com/JoshuaKGoldberg/create-typescript-app.git",
+		});
 
-		const actual = await readGitDefaults();
+		const actual = await readGitDefaults(take);
 
 		expect(actual).toMatchObject({
 			name: "create-typescript-app",
diff --git a/src/options/readGitDefaults.ts b/src/options/readGitDefaults.ts
@@ -1,13 +1,11 @@
-import gitRemoteOriginUrl from "git-remote-origin-url";
+import { TakeInput } from "bingo";
 import gitUrlParse from "git-url-parse";
+import { inputFromScript } from "input-from-script";
 
-// TODO: gitRemoteOriginUrl does not go through take(input*), making it harder to test.
-// The next refactor here should add an input.
+export async function readGitDefaults(take: TakeInput) {
+	const url = await take(inputFromScript, {
+		command: "git remote get-url origin",
+	});
 
-export async function readGitDefaults() {
-	try {
-		return gitUrlParse(await gitRemoteOriginUrl());
-	} catch {
-		return undefined;
-	}
+	return url.stdout ? gitUrlParse(url.stdout.toString()) : undefined;
 }
diff --git a/src/options/readLogoSizing.ts b/src/options/readLogoSizing.ts
diff --git a/src/options/readNpmDefaults.ts b/src/options/readNpmDefaults.ts
diff --git a/src/utils/resolveBin.ts b/src/utils/resolveBin.ts
diff --git a/src/utils/sortObject.ts b/src/utils/sortObject.ts
