refactor: standardize binding answer parsing

Author: hanna-skryl

packages/create-cli/README.md

@@ -31,11 +31,11 @@ Each plugin exposes its own configuration keys that can be passed as CLI argumen
 
 #### ESLint
 
-| Option                    | Type      | Default       | Description                |
-| ------------------------- | --------- | ------------- | -------------------------- |
-| **`--eslint.eslintrc`**   | `string`  | auto-detected | Path to ESLint config      |
-| **`--eslint.patterns`**   | `string`  | `src` or `.`  | File patterns to lint      |
-| **`--eslint.categories`** | `boolean` | `true`        | Add recommended categories |
+| Option                    | Type      | Default       | Description           |
+| ------------------------- | --------- | ------------- | --------------------- |
+| **`--eslint.eslintrc`**   | `string`  | auto-detected | Path to ESLint config |
+| **`--eslint.patterns`**   | `string`  | `src` or `.`  | File patterns to lint |
+| **`--eslint.categories`** | `boolean` | `true`        | Add ESLint categories |
 
 #### Coverage
 
@@ -47,7 +47,7 @@ Each plugin exposes its own configuration keys that can be passed as CLI argumen
 | **`--coverage.testCommand`**    | `string`                                   | auto-detected        | Command to run tests           |
 | **`--coverage.types`**          | `('function'` \| `'branch'` \| `'line')[]` | all                  | Coverage types to measure      |
 | **`--coverage.continueOnFail`** | `boolean`                                  | `true`               | Continue if test command fails |
-| **`--coverage.categories`**     | `boolean`                                  | `true`               | Add code coverage category     |
+| **`--coverage.categories`**     | `boolean`                                  | `true`               | Add Code coverage categories   |
 
 ### Examples
 

packages/plugin-coverage/src/lib/binding.ts

@@ -8,6 +8,9 @@ import type {
   PluginSetupTree,
 } from '@code-pushup/models';
 import {
+  answerArray,
+  answerBoolean,
+  answerString,
   hasDependency,
   pluralize,
   readJsonFile,
@@ -119,7 +122,7 @@ export const coverageSetupBinding = {
       },
       {
         key: 'coverage.categories',
-        message: 'Add code coverage category?',
+        message: 'Add Code coverage categories?',
         type: 'confirm',
         default: true,
       },
@@ -129,37 +132,28 @@ export const coverageSetupBinding = {
     answers: Record<string, PluginAnswer>,
     tree?: PluginSetupTree,
   ) => {
-    const args = parseAnswers(answers);
-    const lcovConfigured = await configureLcovReporter(args, tree);
+    const options = parseAnswers(answers);
+    const lcovConfigured = await configureLcovReporter(options, tree);
     return {
       imports: [
         { moduleSpecifier: PACKAGE_NAME, defaultImport: 'coveragePlugin' },
       ],
-      pluginInit: formatPluginInit(args, lcovConfigured),
-      ...(args.categories ? { categories: CATEGORIES } : {}),
+      pluginInit: formatPluginInit(options, lcovConfigured),
+      ...(options.categories ? { categories: CATEGORIES } : {}),
     };
   },
 } satisfies PluginSetupBinding;
 
 function parseAnswers(answers: Record<string, PluginAnswer>): CoverageOptions {
-  const string = (key: string) => {
-    const value = answers[key];
-    return typeof value === 'string' ? value : '';
-  };
-  const types = answers['coverage.types'];
   return {
-    framework: string('coverage.framework'),
-    configFile: string('coverage.configFile'),
-    reportPath: string('coverage.reportPath') || DEFAULT_REPORT_PATH,
-    testCommand: string('coverage.testCommand'),
-    types: Array.isArray(types)
-      ? types
-      : (typeof types === 'string' ? types : '')
-          .split(',')
-          .map(item => item.trim())
-          .filter(Boolean),
-    continueOnFail: answers['coverage.continueOnFail'] !== false,
-    categories: answers['coverage.categories'] !== false,
+    framework: answerString(answers, 'coverage.framework'),
+    configFile: answerString(answers, 'coverage.configFile'),
+    reportPath:
+      answerString(answers, 'coverage.reportPath') || DEFAULT_REPORT_PATH,
+    testCommand: answerString(answers, 'coverage.testCommand'),
+    types: answerArray(answers, 'coverage.types'),
+    continueOnFail: answerBoolean(answers, 'coverage.continueOnFail'),
+    categories: answerBoolean(answers, 'coverage.categories'),
   };
 }
 

packages/plugin-eslint/src/lib/binding.ts

@@ -7,6 +7,9 @@ import type {
   PluginSetupBinding,
 } from '@code-pushup/models';
 import {
+  answerArray,
+  answerBoolean,
+  answerString,
   directoryExists,
   hasDependency,
   readJsonFile,
@@ -54,6 +57,12 @@ const ESLINT_CATEGORIES: CategoryConfig[] = [
   },
 ];
 
+type EslintOptions = {
+  eslintrc: string;
+  patterns: string[];
+  categories: boolean;
+};
+
 export const eslintSetupBinding = {
   slug: ESLINT_PLUGIN_SLUG,
   title: ESLINT_PLUGIN_TITLE,
@@ -76,36 +85,47 @@ export const eslintSetupBinding = {
     },
     {
       key: 'eslint.categories',
-      message: 'Add recommended categories (bug prevention, code style)?',
+      message: 'Add ESLint categories?',
       type: 'confirm',
       default: true,
     },
   ],
   generateConfig: (answers: Record<string, PluginAnswer>) => {
-    const withCategories = answers['eslint.categories'] !== false;
-    const args = [
-      resolveEslintrc(answers['eslint.eslintrc']),
-      resolvePatterns(answers['eslint.patterns']),
-    ].filter(Boolean);
-
+    const options = parseAnswers(answers);
     return {
       imports: [
         { moduleSpecifier: PACKAGE_NAME, defaultImport: 'eslintPlugin' },
       ],
-      pluginInit:
-        args.length > 0
-          ? `await eslintPlugin({ ${args.join(', ')} })`
-          : 'await eslintPlugin()',
-      ...(withCategories ? { categories: ESLINT_CATEGORIES } : {}),
+      pluginInit: formatPluginInit(options),
+      ...(options.categories ? { categories: ESLINT_CATEGORIES } : {}),
     };
   },
 } satisfies PluginSetupBinding;
 
-async function detectEslintConfig(
-  targetDir: string,
-): Promise<string | undefined> {
-  const files = await readdir(targetDir, { encoding: 'utf8' });
-  return files.find(file => ESLINT_CONFIG_PATTERN.test(file));
+function parseAnswers(answers: Record<string, PluginAnswer>): EslintOptions {
+  return {
+    eslintrc: answerString(answers, 'eslint.eslintrc'),
+    patterns: answerArray(answers, 'eslint.patterns'),
+    categories: answerBoolean(answers, 'eslint.categories'),
+  };
+}
+
+function formatPluginInit({ eslintrc, patterns }: EslintOptions): string {
+  const useCustomEslintrc =
+    eslintrc !== '' && !ESLINT_CONFIG_PATTERN.test(eslintrc);
+  const customPatterns = patterns
+    .filter(s => s !== '' && s !== DEFAULT_PATTERN)
+    .map(singleQuote);
+
+  const body = [
+    useCustomEslintrc ? `eslintrc: ${singleQuote(eslintrc)}` : '',
+    customPatterns.length === 1 ? `patterns: ${customPatterns[0]}` : '',
+    customPatterns.length > 1 ? `patterns: [${customPatterns.join(', ')}]` : '',
+  ]
+    .filter(Boolean)
+    .join(', ');
+
+  return body ? `await eslintPlugin({ ${body} })` : 'await eslintPlugin()';
 }
 
 async function isRecommended(targetDir: string): Promise<boolean> {
@@ -123,34 +143,9 @@ async function isRecommended(targetDir: string): Promise<boolean> {
   }
 }
 
-/** Omits `eslintrc` for standard config filenames (ESLint discovers them automatically). */
-function resolveEslintrc(value: PluginAnswer | undefined): string {
-  if (typeof value !== 'string' || !value) {
-    return '';
-  }
-  if (ESLINT_CONFIG_PATTERN.test(value)) {
-    return '';
-  }
-  return `eslintrc: ${singleQuote(value)}`;
-}
-
-/** Formats patterns as a string or array literal, omitting the plugin default. */
-function resolvePatterns(value: PluginAnswer | undefined): string {
-  if (typeof value === 'string') {
-    return resolvePatterns(value.split(','));
-  }
-  if (!Array.isArray(value)) {
-    return '';
-  }
-  const patterns = value
-    .map(s => s.trim())
-    .filter(s => s !== '' && s !== DEFAULT_PATTERN)
-    .map(singleQuote);
-  if (patterns.length === 0) {
-    return '';
-  }
-  if (patterns.length === 1) {
-    return `patterns: ${patterns.join('')}`;
-  }
-  return `patterns: [${patterns.join(', ')}]`;
+async function detectEslintConfig(
+  targetDir: string,
+): Promise<string | undefined> {
+  const files = await readdir(targetDir, { encoding: 'utf8' });
+  return files.find(file => ESLINT_CONFIG_PATTERN.test(file));
 }

packages/utils/src/index.ts

@@ -194,6 +194,11 @@ export {
   MONOREPO_TOOLS,
   type MonorepoTool,
 } from './lib/monorepo.js';
+export {
+  answerArray,
+  answerBoolean,
+  answerString,
+} from './lib/plugin-answers.js';
 export {
   hasCodePushUpDependency,
   hasDependency,

packages/utils/src/lib/plugin-answers.ts

@@ -0,0 +1,33 @@
+import type { PluginAnswer } from '@code-pushup/models';
+
+/** Extracts a string value from a plugin answer, defaulting to `''`. */
+export function answerString(
+  answers: Record<string, PluginAnswer>,
+  key: string,
+): string {
+  const value = answers[key];
+  return typeof value === 'string' ? value : '';
+}
+
+/** Extracts a string array from a plugin answer, splitting CSV strings as fallback. */
+export function answerArray(
+  answers: Record<string, PluginAnswer>,
+  key: string,
+): string[] {
+  const value = answers[key];
+  if (Array.isArray(value)) {
+    return value;
+  }
+  return (typeof value === 'string' ? value : '')
+    .split(',')
+    .map(item => item.trim())
+    .filter(Boolean);
+}
+
+/** Extracts a boolean from a plugin answer, defaulting to `true`. */
+export function answerBoolean(
+  answers: Record<string, PluginAnswer>,
+  key: string,
+): boolean {
+  return answers[key] !== false;
+}