Implement Zod for Robust Configuration Validation

package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "build": "npm run clean && tsc -p tsconfig.build.json --sourceMap --declaration",
-    "lint": "biome lint --write && biome format --write && biome check --write && tsc --noEmit && secretlint **/*",
+    "lint": "biome check --write && tsc --noEmit && secretlint **/*",
     "test": "vitest",
     "test-coverage": "vitest run --coverage",
     "cli-run": "npm run build && node --trace-warnings bin/repopack",
@@ -63,7 +63,8 @@
     "p-map": "^7.0.2",
     "picocolors": "^1.1.0",
     "strip-comments": "^2.0.1",
-    "tiktoken": "^1.0.16"
+    "tiktoken": "^1.0.16",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.1",

src/cli/actions/defaultActionRunner.ts

@@ -1,12 +1,14 @@
 import path from 'node:path';
 import { loadFileConfig, mergeConfigs } from '../../config/configLoader.js';
-import type {
-  RepopackConfigCli,
-  RepopackConfigFile,
-  RepopackConfigMerged,
-  RepopackOutputStyle,
-} from '../../config/configTypes.js';
+import {
+  type RepopackConfigCli,
+  type RepopackConfigFile,
+  type RepopackConfigMerged,
+  type RepopackOutputStyle,
+  repopackConfigCliSchema,
+} from '../../config/configSchema.js';
 import { type PackResult, pack } from '../../core/packager.js';
+import { rethrowValidationErrorIfZodError } from '../../shared/errorHandler.js';
 import { logger } from '../../shared/logger.js';
 import { printCompletion, printSecurityCheck, printSummary, printTopFiles } from '../cliPrinter.js';
 import type { CliOptions } from '../cliRunner.js';
@@ -28,26 +30,8 @@ export const runDefaultAction = async (
   const fileConfig: RepopackConfigFile = await loadFileConfig(cwd, options.config ?? null);
   logger.trace('Loaded file config:', fileConfig);
 
-  // Parse the CLI options
-  const cliConfig: RepopackConfigCli = {};
-  if (options.output) {
-    cliConfig.output = { filePath: options.output };
-  }
-  if (options.include) {
-    cliConfig.include = options.include.split(',');
-  }
-  if (options.ignore) {
-    cliConfig.ignore = { customPatterns: options.ignore.split(',') };
-  }
-  if (options.topFilesLen !== undefined) {
-    cliConfig.output = { ...cliConfig.output, topFilesLength: options.topFilesLen };
-  }
-  if (options.outputShowLineNumbers !== undefined) {
-    cliConfig.output = { ...cliConfig.output, showLineNumbers: options.outputShowLineNumbers };
-  }
-  if (options.style) {
-    cliConfig.output = { ...cliConfig.output, style: options.style.toLowerCase() as RepopackOutputStyle };
-  }
+  // Parse the CLI options into a config
+  const cliConfig: RepopackConfigCli = buildCliConfig(options);
   logger.trace('CLI config:', cliConfig);
 
   // Merge default, file, and CLI configs
@@ -99,3 +83,33 @@ export const runDefaultAction = async (
     config,
   };
 };
+
+const buildCliConfig = (options: CliOptions): RepopackConfigCli => {
+  const cliConfig: RepopackConfigCli = {};
+
+  if (options.output) {
+    cliConfig.output = { filePath: options.output };
+  }
+  if (options.include) {
+    cliConfig.include = options.include.split(',');
+  }
+  if (options.ignore) {
+    cliConfig.ignore = { customPatterns: options.ignore.split(',') };
+  }
+  if (options.topFilesLen !== undefined) {
+    cliConfig.output = { ...cliConfig.output, topFilesLength: options.topFilesLen };
+  }
+  if (options.outputShowLineNumbers !== undefined) {
+    cliConfig.output = { ...cliConfig.output, showLineNumbers: options.outputShowLineNumbers };
+  }
+  if (options.style) {
+    cliConfig.output = { ...cliConfig.output, style: options.style.toLowerCase() as RepopackOutputStyle };
+  }
+
+  try {
+    return repopackConfigCliSchema.parse(cliConfig);
+  } catch (error) {
+    rethrowValidationErrorIfZodError(error, 'Invalid cli arguments');
+    throw error;
+  }
+};

src/cli/actions/initActionRunner.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 import * as prompts from '@clack/prompts';
 import pc from 'picocolors';
-import type { RepopackConfigFile, RepopackOutputStyle } from '../../config/configTypes.js';
+import type { RepopackConfigFile, RepopackOutputStyle } from '../../config/configSchema.js';
 import { defaultConfig } from '../../config/defaultConfig.js';
 import { getGlobalDirectory } from '../../config/globalDirectory.js';
 import { logger } from '../../shared/logger.js';

src/cli/cliPrinter.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import pc from 'picocolors';
-import type { RepopackConfigMerged } from '../config/configTypes.js';
+import type { RepopackConfigMerged } from '../config/configSchema.js';
 import type { SuspiciousFileResult } from '../core/security/securityCheckRunner.js';
 import { logger } from '../shared/logger.js';
 

src/cli/cliRunner.ts

@@ -1,7 +1,7 @@
 import process from 'node:process';
 import { type OptionValues, program } from 'commander';
 import pc from 'picocolors';
-import type { RepopackOutputStyle } from '../config/configTypes.js';
+import type { RepopackOutputStyle } from '../config/configSchema.js';
 import { getVersion } from '../core/file/packageJsonParser.js';
 import { handleError } from '../shared/errorHandler.js';
 import { logger } from '../shared/logger.js';

src/config/configLoader.ts

@@ -1,9 +1,15 @@
 import * as fs from 'node:fs/promises';
 import path from 'node:path';
-import { RepopackError } from '../shared/errorHandler.js';
+import { z } from 'zod';
+import { RepopackError, rethrowValidationErrorIfZodError } from '../shared/errorHandler.js';
 import { logger } from '../shared/logger.js';
-import type { RepopackConfigCli, RepopackConfigFile, RepopackConfigMerged } from './configTypes.js';
-import { RepopackConfigValidationError, validateConfig } from './configValidator.js';
+import {
+  type RepopackConfigCli,
+  type RepopackConfigFile,
+  type RepopackConfigMerged,
+  repopackConfigFileSchema,
+  repopackConfigMergedSchema,
+} from './configSchema.js';
 import { defaultConfig } from './defaultConfig.js';
 import { getGlobalDirectory } from './globalDirectory.js';
 
@@ -25,7 +31,6 @@ export const loadFileConfig = async (rootDir: string, argConfigPath: string | nu
 
   logger.trace('Loading local config from:', fullPath);
 
-  // Check local file existence
   const isLocalFileExists = await fs
     .stat(fullPath)
     .then((stats) => stats.isFile())
@@ -36,7 +41,6 @@ export const loadFileConfig = async (rootDir: string, argConfigPath: string | nu
   }
 
   if (useDefaultConfig) {
-    // Try to load global config
     const globalConfigPath = getGlobalConfigPath();
     logger.trace('Loading global config from:', globalConfigPath);
 
@@ -61,12 +65,9 @@ const loadAndValidateConfig = async (filePath: string): Promise<RepopackConfigFi
   try {
     const fileContent = await fs.readFile(filePath, 'utf-8');
     const config = JSON.parse(fileContent);
-    validateConfig(config);
-    return config;
+    return repopackConfigFileSchema.parse(config);
   } catch (error) {
-    if (error instanceof RepopackConfigValidationError) {
-      throw new RepopackError(`Invalid configuration in ${filePath}: ${error.message}`);
-    }
+    rethrowValidationErrorIfZodError(error, 'Invalid config schema');
     if (error instanceof SyntaxError) {
       throw new RepopackError(`Invalid JSON in config file ${filePath}: ${error.message}`);
     }
@@ -81,27 +82,36 @@ export const mergeConfigs = (
   cwd: string,
   fileConfig: RepopackConfigFile,
   cliConfig: RepopackConfigCli,
-): RepopackConfigMerged => ({
-  cwd,
-  output: {
-    ...defaultConfig.output,
-    ...fileConfig.output,
-    ...cliConfig.output,
-  },
-  ignore: {
-    ...defaultConfig.ignore,
-    ...fileConfig.ignore,
-    ...cliConfig.ignore,
-    customPatterns: [
-      ...(defaultConfig.ignore.customPatterns || []),
-      ...(fileConfig.ignore?.customPatterns || []),
-      ...(cliConfig.ignore?.customPatterns || []),
-    ],
-  },
-  include: [...(defaultConfig.include || []), ...(fileConfig.include || []), ...(cliConfig.include || [])],
-  security: {
-    ...defaultConfig.security,
-    ...fileConfig.security,
-    ...cliConfig.security,
-  },
-});
+): RepopackConfigMerged => {
+  const mergedConfig = {
+    cwd,
+    output: {
+      ...defaultConfig.output,
+      ...fileConfig.output,
+      ...cliConfig.output,
+    },
+    ignore: {
+      ...defaultConfig.ignore,
+      ...fileConfig.ignore,
+      ...cliConfig.ignore,
+      customPatterns: [
+        ...(defaultConfig.ignore.customPatterns || []),
+        ...(fileConfig.ignore?.customPatterns || []),
+        ...(cliConfig.ignore?.customPatterns || []),
+      ],
+    },
+    include: [...(defaultConfig.include || []), ...(fileConfig.include || []), ...(cliConfig.include || [])],
+    security: {
+      ...defaultConfig.security,
+      ...fileConfig.security,
+      ...cliConfig.security,
+    },
+  };
+
+  try {
+    return repopackConfigMergedSchema.parse(mergedConfig);
+  } catch (error) {
+    rethrowValidationErrorIfZodError(error, 'Invalid merged config');
+    throw error;
+  }
+};

src/config/configSchema.ts

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+import { RepopackError } from '../shared/errorHandler.js';
+
+export const repopackOutputStyleSchema = z.enum(['plain', 'xml']);
+
+export type RepopackOutputStyle = z.infer<typeof repopackOutputStyleSchema>;
+
+const repopackConfigBaseSchema = z.object({
+  output: z
+    .object({
+      filePath: z.string().optional(),
+      style: repopackOutputStyleSchema.optional(),
+      headerText: z.string().optional(),
+      instructionFilePath: z.string().optional(),
+      removeComments: z.boolean().optional(),
+      removeEmptyLines: z.boolean().optional(),
+      topFilesLength: z.number().optional(),
+      showLineNumbers: z.boolean().optional(),
+    })
+    .optional(),
+  include: z.array(z.string()).optional(),
+  ignore: z
+    .object({
+      useGitignore: z.boolean().optional(),
+      useDefaultPatterns: z.boolean().optional(),
+      customPatterns: z.array(z.string()).optional(),
+    })
+    .optional(),
+  security: z
+    .object({
+      enableSecurityCheck: z.boolean().optional(),
+    })
+    .optional(),
+});
+
+export const repopackConfigDefaultSchema = repopackConfigBaseSchema.and(
+  z.object({
+    output: z.object({
+      filePath: z.string(),
+      style: repopackOutputStyleSchema,
+      headerText: z.string().optional(),
+      instructionFilePath: z.string().optional(),
+      removeComments: z.boolean(),
+      removeEmptyLines: z.boolean(),
+      topFilesLength: z.number(),
+      showLineNumbers: z.boolean(),
+    }),
+    include: z.array(z.string()),
+    ignore: z.object({
+      useGitignore: z.boolean(),
+      useDefaultPatterns: z.boolean(),
+      customPatterns: z.array(z.string()).optional(),
+    }),
+    security: z.object({
+      enableSecurityCheck: z.boolean(),
+    }),
+  }),
+);
+
+export type RepopackConfigDefault = z.infer<typeof repopackConfigDefaultSchema>;
+
+export const repopackConfigFileSchema = repopackConfigBaseSchema;
+
+export type RepopackConfigFile = z.infer<typeof repopackConfigFileSchema>;
+
+export const repopackConfigCliSchema = repopackConfigBaseSchema;
+
+export type RepopackConfigCli = z.infer<typeof repopackConfigCliSchema>;
+
+export const repopackConfigMergedSchema = repopackConfigDefaultSchema
+  .and(repopackConfigFileSchema)
+  .and(repopackConfigCliSchema)
+  .and(
+    z.object({
+      cwd: z.string(),
+    }),
+  );
+
+export type RepopackConfigMerged = z.infer<typeof repopackConfigMergedSchema>;