refactor(create-cli): extract plugin slug utils

Author: hanna-skryl

packages/create-cli/src/index.ts

@@ -1,9 +1,16 @@
 #! /usr/bin/env node
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { CONFIG_FILE_FORMATS } from './lib/setup/types.js';
+import { parsePluginSlugs, validatePluginSlugs } from './lib/setup/plugins.js';
+import {
+  CONFIG_FILE_FORMATS,
+  type PluginSetupBinding,
+} from './lib/setup/types.js';
 import { runSetupWizard } from './lib/setup/wizard.js';
 
+// TODO: create, import and pass plugin bindings (eslint, coverage, lighthouse, typescript, js-packages, jsdocs, axe)
+const bindings: PluginSetupBinding[] = [];
+
 const argv = await yargs(hideBin(process.argv))
   .option('dry-run', {
     type: 'boolean',
@@ -24,8 +31,12 @@ const argv = await yargs(hideBin(process.argv))
   .option('plugins', {
     type: 'string',
     describe: 'Comma-separated plugin slugs to include (e.g. eslint,coverage)',
+    coerce: parsePluginSlugs,
+  })
+  .check(parsed => {
+    validatePluginSlugs(bindings, parsed.plugins);
+    return true;
   })
   .parse();
 
-// TODO: create, import and pass plugin bindings (eslint, coverage, lighthouse, typescript, js-packages, jsdocs, axe)
-await runSetupWizard([], argv);
+await runSetupWizard(bindings, argv);

packages/create-cli/src/lib/setup/plugins.ts

@@ -0,0 +1,29 @@
+import type { PluginSetupBinding } from './types.js';
+
+/** Parses a comma-separated string of plugin slugs into a deduplicated array. */
+export function parsePluginSlugs(value: string): string[] {
+  return [
+    ...new Set(
+      value
+        .split(',')
+        .map(s => s.trim())
+        .filter(Boolean),
+    ),
+  ];
+}
+
+/** Throws if any slug is not found in the available bindings. */
+export function validatePluginSlugs(
+  bindings: PluginSetupBinding[],
+  plugins?: string[],
+): void {
+  if (plugins == null || plugins.length === 0) {
+    return;
+  }
+  const unknown = plugins.filter(slug => !bindings.some(b => b.slug === slug));
+  if (unknown.length > 0) {
+    throw new TypeError(
+      `Unknown plugin slugs: ${unknown.join(', ')}. Available: ${bindings.map(b => b.slug).join(', ')}`,
+    );
+  }
+}

packages/create-cli/src/lib/setup/plugins.unit.test.ts

@@ -0,0 +1,45 @@
+import { parsePluginSlugs, validatePluginSlugs } from './plugins.js';
+
+describe('parsePluginSlugs', () => {
+  it.each([
+    ['eslint,coverage', ['eslint', 'coverage']],
+    [' eslint , coverage ', ['eslint', 'coverage']],
+    ['eslint,eslint', ['eslint']],
+    ['eslint,,coverage', ['eslint', 'coverage']],
+  ])('should parse %j into %j', (input, expected) => {
+    expect(parsePluginSlugs(input)).toStrictEqual(expected);
+  });
+});
+
+describe('validatePluginSlugs', () => {
+  const bindings = [
+    {
+      slug: 'eslint',
+      title: 'ESLint',
+      packageName: '@code-pushup/eslint-plugin',
+      generateConfig: () => ({ imports: [], pluginInit: '' }),
+    },
+    {
+      slug: 'coverage',
+      title: 'Code Coverage',
+      packageName: '@code-pushup/coverage-plugin',
+      generateConfig: () => ({ imports: [], pluginInit: '' }),
+    },
+  ];
+
+  it('should not throw for valid or missing slugs', () => {
+    expect(() => validatePluginSlugs(bindings)).not.toThrow();
+    expect(() =>
+      validatePluginSlugs(bindings, ['eslint', 'coverage']),
+    ).not.toThrow();
+  });
+
+  it('should throw TypeError on unknown slug', () => {
+    expect(() => validatePluginSlugs(bindings, ['eslint', 'unknown'])).toThrow(
+      TypeError,
+    );
+    expect(() => validatePluginSlugs(bindings, ['eslint', 'unknown'])).toThrow(
+      'Unknown plugin slugs: unknown',
+    );
+  });
+});

packages/create-cli/src/lib/setup/prompts.ts

@@ -10,24 +10,23 @@ import type {
  * Resolves which plugins to include in the generated config.
  *
  * Resolution order (first match wins):
- * 1. `--plugins`: comma-separated slugs, validated against available bindings
+ * 1. `--plugins`: user-provided slugs
  * 2. `--yes`: recommended plugins
  * 3. Interactive: checkbox prompt with recommended plugins pre-checked
  */
 export async function promptPluginSelection(
   bindings: PluginSetupBinding[],
   targetDir: string,
-  cliArgs: CliArgs,
+  { plugins, yes }: CliArgs,
 ): Promise<PluginSetupBinding[]> {
   if (bindings.length === 0) {
     return [];
   }
-  const slugs = parsePluginSlugs(cliArgs.plugins);
-  if (slugs != null) {
-    return filterBindingsBySlugs(bindings, slugs);
+  if (plugins != null && plugins.length > 0) {
+    return bindings.filter(b => plugins.includes(b.slug));
   }
   const recommended = await detectRecommended(bindings, targetDir);
-  if (cliArgs.yes) {
+  if (yes) {
     return bindings.filter(({ slug }) => recommended.has(slug));
   }
   const selected = await checkbox({
@@ -43,33 +42,6 @@ export async function promptPluginSelection(
   return bindings.filter(({ slug }) => selectedSet.has(slug));
 }
 
-function parsePluginSlugs(value: string | undefined): string[] | null {
-  if (value == null || value.trim() === '') {
-    return null;
-  }
-  return [
-    ...new Set(
-      value
-        .split(',')
-        .map(s => s.trim())
-        .filter(Boolean),
-    ),
-  ];
-}
-
-function filterBindingsBySlugs(
-  bindings: PluginSetupBinding[],
-  slugs: string[],
-): PluginSetupBinding[] {
-  const unknown = slugs.filter(slug => !bindings.some(b => b.slug === slug));
-  if (unknown.length > 0) {
-    throw new Error(
-      `Unknown plugin slugs: ${unknown.join(', ')}. Available: ${bindings.map(b => b.slug).join(', ')}`,
-    );
-  }
-  return bindings.filter(b => slugs.includes(b.slug));
-}
-
 /**
  * Calls each binding's `isRecommended` callback (if provided)
  * and collects the slugs of bindings that returned `true`.

packages/create-cli/src/lib/setup/prompts.unit.test.ts

@@ -124,18 +124,12 @@ describe('promptPluginSelection', () => {
     it('should return matching bindings for valid slugs', async () => {
       await expect(
         promptPluginSelection(bindings, '/test', {
-          plugins: 'eslint,lighthouse',
+          plugins: ['eslint', 'lighthouse'],
         }),
       ).resolves.toStrictEqual([bindings[0], bindings[2]]);
 
       expect(mockCheckbox).not.toHaveBeenCalled();
     });
-
-    it('should throw on unknown slug', async () => {
-      await expect(
-        promptPluginSelection(bindings, '/test', { plugins: 'eslint,unknown' }),
-      ).rejects.toThrow('Unknown plugin slugs: unknown');
-    });
   });
 
   describe('--yes (non-interactive)', () => {

packages/create-cli/src/lib/setup/types.ts

@@ -94,7 +94,7 @@ export type CliArgs = {
   'dry-run'?: boolean;
   yes?: boolean;
   'config-format'?: string;
-  plugins?: string;
+  plugins?: string[];
   'target-dir'?: string;
   [key: string]: unknown;
 };