feat(plugin-eslint): validate initializer params with Zod

Author: matejchalk

package-lock.json

@@ -16,7 +16,7 @@
     "chalk": "^5.3.0",
     "cliui": "^8.0.1",
     "yargs": "^17.7.2",
-    "zod": "^3.22.1"
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",

package.json

@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "dependencies": {
     "eslint": "~8.46.0",
+    "zod": "^3.22.4",
     "@code-pushup/models": "*",
     "@code-pushup/utils": "*"
   }

packages/plugin-eslint/package.json

@@ -2,4 +2,4 @@ import { eslintPlugin } from './lib/eslint-plugin';
 
 export default eslintPlugin;
 
-export type { ESLintPluginConfig } from './lib/eslint-plugin';
+export type { ESLintPluginConfig } from './lib/config';

packages/plugin-eslint/src/index.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+
+export const eslintPluginConfigSchema = z.object({
+  eslintrc: z.string({
+    description: 'Path to .eslintrc.* config file',
+  }),
+  patterns: z.union([z.string(), z.array(z.string()).min(1)], {
+    description:
+      'Lint target files. May contain file paths, directory paths, or glob patterns',
+  }),
+});
+
+export type ESLintPluginConfig = z.infer<typeof eslintPluginConfigSchema>;

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

@@ -41,4 +41,11 @@ describe('eslintPlugin', () => {
       }),
     ).resolves.toMatchSnapshot();
   });
+
+  it('should throw when invalid parameters provided', async () => {
+    await expect(
+      // @ts-expect-error simulating invalid non-TS config
+      eslintPlugin({ eslintrc: '.eslintrc.json' }),
+    ).rejects.toThrowError('patterns');
+  });
 });

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

@@ -2,17 +2,14 @@ import { PluginConfig } from '@quality-metrics/models';
 import { toArray } from '@quality-metrics/utils';
 import { ESLint } from 'eslint';
 import { name, version } from '../../package.json';
+import { ESLintPluginConfig, eslintPluginConfigSchema } from './config';
 import { listAudits } from './meta/audits';
 
-export type ESLintPluginConfig = {
-  eslintrc: string;
-  patterns: string | string[];
-};
+export async function eslintPlugin(
+  config: ESLintPluginConfig,
+): Promise<PluginConfig> {
+  const { eslintrc, patterns } = eslintPluginConfigSchema.parse(config);
 
-export async function eslintPlugin({
-  eslintrc,
-  patterns,
-}: ESLintPluginConfig): Promise<PluginConfig> {
   const eslint = new ESLint({
     useEslintrc: false,
     baseConfig: { extends: eslintrc },