feat(config): Implement Zod for robust configuration validation

yamadashy · Nov 10, 2024 · 3af0bf3 · 3af0bf3
1 parent 9726e3a
commit 3af0bf3
Show file tree

Hide file tree

Showing 24 changed files with 367 additions and 208 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -67,7 +67,8 @@
     "p-map": "^7.0.2",
     "picocolors": "^1.1.1",
     "strip-comments": "^2.0.1",
-    "tiktoken": "^1.0.17"
+    "tiktoken": "^1.0.17",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",

diff --git a/src/cli/actions/defaultAction.ts b/src/cli/actions/defaultAction.ts
@@ -5,7 +5,7 @@ import type {
   RepomixConfigFile,
   RepomixConfigMerged,
   RepomixOutputStyle,
-} from '../../config/configTypes.js';
+} from '../../config/configSchema.js';
 import { type PackResult, pack } from '../../core/packager.js';
 import { logger } from '../../shared/logger.js';
 import { printCompletion, printSecurityCheck, printSummary, printTopFiles } from '../cliPrint.js';

diff --git a/src/cli/actions/initAction.ts b/src/cli/actions/initAction.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 { RepomixConfigFile, RepomixOutputStyle } from '../../config/configTypes.js';
+import type { RepomixConfigFile, RepomixOutputStyle } from '../../config/configSchema.js';
 import { defaultConfig, defaultFilePathMap } from '../../config/defaultConfig.js';
 import { getGlobalDirectory } from '../../config/globalDirectory.js';
 import { logger } from '../../shared/logger.js';

diff --git a/src/cli/cliPrint.ts b/src/cli/cliPrint.ts
@@ -1,6 +1,6 @@
 import path from 'node:path';
 import pc from 'picocolors';
-import type { RepomixConfigMerged } from '../config/configTypes.js';
+import type { RepomixConfigMerged } from '../config/configSchema.js';
 import type { SuspiciousFileResult } from '../core/security/securityCheck.js';
 import { logger } from '../shared/logger.js';
 

diff --git a/src/cli/cliRun.ts b/src/cli/cliRun.ts
@@ -1,7 +1,7 @@
 import process from 'node:process';
 import { type OptionValues, program } from 'commander';
 import pc from 'picocolors';
-import type { RepomixOutputStyle } from '../config/configTypes.js';
+import type { RepomixOutputStyle } from '../config/configSchema.js';
 import { getVersion } from '../core/file/packageJsonParse.js';
 import { handleError } from '../shared/errorHandle.js';
 import { logger } from '../shared/logger.js';

diff --git a/src/config/configLoad.ts b/src/config/configLoad.ts
@@ -1,9 +1,14 @@
 import * as fs from 'node:fs/promises';
 import path from 'node:path';
-import { RepomixError } from '../shared/errorHandle.js';
+import { RepomixError, rethrowValidationErrorIfZodError } from '../shared/errorHandle.js';
 import { logger } from '../shared/logger.js';
-import type { RepomixConfigCli, RepomixConfigFile, RepomixConfigMerged } from './configTypes.js';
-import { RepomixConfigValidationError, validateConfig } from './configValidate.js';
+import {
+  type RepomixConfigCli,
+  type RepomixConfigFile,
+  type RepomixConfigMerged,
+  repomixConfigFileSchema,
+  repomixConfigMergedSchema,
+} from './configSchema.js';
 import { defaultConfig, defaultFilePathMap } from './defaultConfig.js';
 import { getGlobalDirectory } from './globalDirectory.js';
 
@@ -25,7 +30,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 +40,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 +64,9 @@ const loadAndValidateConfig = async (filePath: string): Promise<RepomixConfigFil
   try {
     const fileContent = await fs.readFile(filePath, 'utf-8');
     const config = JSON.parse(fileContent);
-    validateConfig(config);
-    return config;
+    return repomixConfigFileSchema.parse(config);
   } catch (error) {
-    if (error instanceof RepomixConfigValidationError) {
-      throw new RepomixError(`Invalid configuration in ${filePath}: ${error.message}`);
-    }
+    rethrowValidationErrorIfZodError(error, 'Invalid config schema');
     if (error instanceof SyntaxError) {
       throw new RepomixError(`Invalid JSON in config file ${filePath}: ${error.message}`);
     }
@@ -88,7 +88,7 @@ export const mergeConfigs = (
     defaultConfig.output.filePath = defaultFilePathMap[style];
   }
 
-  return {
+  const mergedConfig = {
     cwd,
     output: {
       ...defaultConfig.output,
@@ -112,4 +112,11 @@ export const mergeConfigs = (
       ...cliConfig.security,
     },
   };
+
+  try {
+    return repomixConfigMergedSchema.parse(mergedConfig);
+  } catch (error) {
+    rethrowValidationErrorIfZodError(error, 'Invalid merged config');
+    throw error;
+  }
 };
diff --git a/src/config/configSchema.ts b/src/config/configSchema.ts
@@ -0,0 +1,81 @@
+import { z } from 'zod';
+import { RepomixError } from '../shared/errorHandle.js';
+
+export const repomixOutputStyleSchema = z.enum(['plain', 'xml', 'markdown']);
+
+export const repomixConfigBaseSchema = z.object({
+  output: z
+    .object({
+      filePath: z.string().optional(),
+      style: repomixOutputStyleSchema.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(),
+      copyToClipboard: 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 repomixConfigDefaultSchema = repomixConfigBaseSchema.and(
+  z.object({
+    output: z.object({
+      filePath: z.string(),
+      style: repomixOutputStyleSchema,
+      headerText: z.string().optional(),
+      instructionFilePath: z.string().optional(),
+      removeComments: z.boolean(),
+      removeEmptyLines: z.boolean(),
+      topFilesLength: z.number(),
+      showLineNumbers: z.boolean(),
+      copyToClipboard: 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 const repomixConfigFileSchema = repomixConfigBaseSchema;
+
+export const repomixConfigCliSchema = repomixConfigBaseSchema;
+
+export const repomixConfigMergedSchema = repomixConfigDefaultSchema
+  .and(repomixConfigFileSchema)
+  .and(repomixConfigCliSchema)
+  .and(
+    z.object({
+      cwd: z.string(),
+    }),
+  );
+
+export type RepomixOutputStyle = z.infer<typeof repomixOutputStyleSchema>;
+
+export type RepomixConfigDefault = z.infer<typeof repomixConfigDefaultSchema>;
+
+export type RepomixConfigFile = z.infer<typeof repomixConfigFileSchema>;
+
+export type RepomixConfigCli = z.infer<typeof repomixConfigCliSchema>;
+
+export type RepomixConfigMerged = z.infer<typeof repomixConfigMergedSchema>;
diff --git a/src/config/configTypes.ts b/src/config/configTypes.ts
diff --git a/src/config/configValidate.ts b/src/config/configValidate.ts
diff --git a/src/config/defaultConfig.ts b/src/config/defaultConfig.ts
@@ -1,4 +1,4 @@
-import type { RepomixConfigDefault, RepomixOutputStyle } from './configTypes.js';
+import type { RepomixConfigDefault, RepomixOutputStyle } from './configSchema.js';
 
 export const defaultFilePathMap: Record<RepomixOutputStyle, string> = {
   plain: 'repomix-output.txt',

diff --git a/src/core/file/fileProcess.ts b/src/core/file/fileProcess.ts
@@ -1,5 +1,5 @@
 import pMap from 'p-map';
-import type { RepomixConfigMerged } from '../../config/configTypes.js';
+import type { RepomixConfigMerged } from '../../config/configSchema.js';
 import { getProcessConcurrency } from '../../shared/processConcurrency.js';
 import { getFileManipulator } from './fileManipulate.js';
 import type { ProcessedFile, RawFile } from './fileTypes.js';

diff --git a/src/core/file/fileSearch.ts b/src/core/file/fileSearch.ts
@@ -1,5 +1,5 @@
 import { globby } from 'globby';
-import type { RepomixConfigMerged } from '../../config/configTypes.js';
+import type { RepomixConfigMerged } from '../../config/configSchema.js';
 import { defaultIgnoreList } from '../../config/defaultIgnore.js';
 import { logger } from '../../shared/logger.js';
 import { sortPaths } from './filePathSort.js';

diff --git a/src/core/output/outputGenerate.ts b/src/core/output/outputGenerate.ts
@@ -1,7 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import Handlebars from 'handlebars';
-import type { RepomixConfigMerged } from '../../config/configTypes.js';
+import type { RepomixConfigMerged } from '../../config/configSchema.js';
 import { RepomixError } from '../../shared/errorHandle.js';
 import { generateTreeString } from '../file/fileTreeGenerate.js';
 import type { ProcessedFile } from '../file/fileTypes.js';

diff --git a/src/core/output/outputGeneratorTypes.ts b/src/core/output/outputGeneratorTypes.ts
@@ -1,4 +1,4 @@
-import type { RepomixConfigMerged } from '../../config/configTypes.js';
+import type { RepomixConfigMerged } from '../../config/configSchema.js';
 import type { ProcessedFile } from '../file/fileTypes.js';
 
 export interface OutputGeneratorContext {