feat: support package.json keywords

docs/Options.md

@@ -54,6 +54,8 @@ The setup scripts also allow for optional overrides of the following inputs whos
 - `--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`)
+- `--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-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
 

src/create/createRerunSuggestion.test.ts

@@ -28,6 +28,7 @@ const options = {
 	excludeRenovate: undefined,
 	excludeTests: undefined,
 	funding: undefined,
+	keywords: ["abc", "def ghi", "jkl mno pqr"],
 	logo: undefined,
 	mode: "create",
 	owner: "TestOwner",
@@ -45,7 +46,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 [email protected] --email-npm [email protected] --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\\""',
+			'"npx create-typescript-app --mode create --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --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 --keywords \\"abc def ghi jkl mno pqr\\" --mode create --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -60,7 +61,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 [email protected] --email-npm [email protected] --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\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --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 --keywords \\"abc def ghi jkl mno pqr\\" --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 +75,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 [email protected] --email-npm [email protected] --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\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --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 --keywords \\"abc def ghi jkl mno pqr\\" --mode initialize --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 });

src/create/createRerunSuggestion.ts

@@ -31,12 +31,23 @@ export function createRerunSuggestion(options: Partial<Options>): string {
 		)
 		.filter(([, value]) => !!value)
 		.map(([key, value]) => {
-			const valueStringified = `${value}`;
-			return `--${getFirstMatchingArg(key)} ${
-				valueStringified.includes(" ") ? `"${value}"` : value
-			}`;
+			return `--${getFirstMatchingArg(key)} ${stringifyValue(value)}`;
 		})
 		.join(" ");
 
 	return `npx create-typescript-app --mode ${options.mode} ${args}`;
 }
+
+function stringifyValue(
+	value: boolean | string | string[] | undefined,
+): string {
+	if (Array.isArray(value)) {
+		return stringifyValue(value.join(" "));
+	}
+
+	const valueStringified = `${value}`;
+
+	return valueStringified.includes(" ")
+		? `"${valueStringified}"`
+		: valueStringified;
+}

src/shared/options/args.ts

@@ -1,3 +1,5 @@
+import { ParseArgsConfig } from "node:util";
+
 export const allArgOptions = {
 	access: { type: "string" },
 	author: { type: "string" },
@@ -27,6 +29,7 @@ export const allArgOptions = {
 	"exclude-renovate": { type: "boolean" },
 	"exclude-tests": { type: "boolean" },
 	funding: { type: "string" },
+	keywords: { multiple: true, type: "string" },
 	logo: { type: "string" },
 	"logo-alt": { type: "string" },
 	mode: { type: "string" },
@@ -40,4 +43,4 @@ export const allArgOptions = {
 	"skip-restore": { type: "boolean" },
 	"skip-uninstall": { type: "boolean" },
 	title: { type: "string" },
-} as const;
+} as const satisfies ParseArgsConfig["options"];

src/shared/options/optionsSchema.ts

@@ -39,6 +39,7 @@ export const optionsSchemaShape = {
 	excludeRenovate: z.boolean().optional(),
 	excludeTests: z.boolean().optional(),
 	funding: z.string().optional(),
+	keywords: z.array(z.string()).optional(),
 	logo: z.string().optional(),
 	logoAlt: z.string().optional(),
 	mode: z

src/shared/types.ts

@@ -60,6 +60,7 @@ export interface Options {
 	excludeRenovate?: boolean;
 	excludeTests?: boolean;
 	funding?: string;
+	keywords?: string[];
 	logo: OptionsLogo | undefined;
 	mode: Mode;
 	offline?: boolean;

src/steps/writing/creation/writePackageJson.test.ts

@@ -70,6 +70,19 @@ describe("writePackageJson", () => {
 		);
 	});
 
+	it("includes flattened keywords when they're specified", async () => {
+		mockReadFileSafeAsJson.mockResolvedValue({});
+
+		const keywords = ["abc", "def ghi", "jkl mno pqr"];
+		const packageJson = await writePackageJson({ ...options, keywords });
+
+		expect(JSON.parse(packageJson)).toEqual(
+			expect.objectContaining({
+				keywords: ["abc", "def", "ghi", "jkl", "mno", "pqr"],
+			}),
+		);
+	});
+
 	it("includes all optional portions when no exclusions are enabled", async () => {
 		mockReadFileSafeAsJson.mockResolvedValue({});
 

src/steps/writing/creation/writePackageJson.ts

@@ -40,6 +40,9 @@ export async function writePackageJson(options: Options) {
 
 		author: { email: options.email.npm, name: options.author },
 		description: options.description,
+		keywords: options.keywords?.length
+			? options.keywords.flatMap((keyword) => keyword.split(/ /))
+			: undefined,
 
 		// We copy all existing dev dependencies except those we know are not used anymore
 		devDependencies: copyDevDependencies(existingPackageJson),