refactor(models): add global options (#76)

This PR includes a small refactoring to align with #73

packages/cli/src/index.ts

@@ -1,13 +1,17 @@
 import { yargsCli } from './lib/cli';
-import { yargsGlobalOptionsDefinition } from './lib/options';
+import { options } from './lib/options';
 import { middlewares } from './lib/middlewares';
 import { commands } from './lib/commands';
 
+export { options } from './lib/options';
+export { middlewares } from './lib/middlewares';
+export { commands } from './lib/commands';
+
 export const cli = (args: string[]) =>
   yargsCli(args, {
     usageMessage: 'Code PushUp CLI',
     scriptName: 'code-pushup',
-    options: yargsGlobalOptionsDefinition(),
+    options,
     middlewares,
     commands,
   });

packages/cli/src/lib/cli.spec.ts

@@ -1,16 +1,16 @@
 import { join } from 'path';
 import { describe, expect, it } from 'vitest';
 import { yargsCli } from './cli';
-import { CommandBase } from './implementation/base-command-config';
 import { getDirname } from './implementation/utils';
 import { middlewares } from './middlewares';
-import { yargsGlobalOptionsDefinition } from './options';
+import { options as defaultOptions } from './options';
+import { CommandBase } from './implementation/model';
 
 const __dirname = getDirname(import.meta.url);
 const withDirName = (path: string) => join(__dirname, path);
 const validConfigPath = withDirName('implementation/mock/cli-config.mock.js');
 
-const options = yargsGlobalOptionsDefinition();
+const options = defaultOptions;
 const demandCommand: [number, string] = [0, 'no command required'];
 
 describe('CLI arguments parsing', () => {

packages/cli/src/lib/collect/command-object.spec.ts

@@ -6,7 +6,7 @@ import { join } from 'node:path';
 import { yargsCli } from '../cli';
 import { getDirname, logErrorBeforeThrow } from '../implementation/utils';
 import { middlewares } from '../middlewares';
-import { yargsGlobalOptionsDefinition } from '../options';
+import { yargsGlobalOptionsDefinition } from '../implementation/global-options';
 import { yargsCollectCommandObject } from './command-object';
 
 const command = {

packages/cli/src/lib/implementation/config-middleware.ts

@@ -1,8 +1,7 @@
 import { bundleRequire } from 'bundle-require';
 import { stat } from 'fs/promises';
-
-import { GlobalCliArgs, globalCliArgsSchema } from '@quality-metrics/models';
-import { CommandBase, commandBaseSchema } from './base-command-config';
+import { GlobalOptions, globalOptionsSchema } from '../model';
+import { CommandBase, commandBaseSchema } from './model';
 
 export class ConfigParseError extends Error {
   constructor(configPath: string) {
@@ -13,7 +12,7 @@ export class ConfigParseError extends Error {
 export async function configMiddleware<T = unknown>(
   processArgs: T,
 ): Promise<CommandBase> {
-  const globalCfg: GlobalCliArgs = globalCliArgsSchema.parse(processArgs);
+  const globalCfg: GlobalOptions = globalOptionsSchema.parse(processArgs);
   const { configPath } = globalCfg;
   try {
     const stats = await stat(configPath);

packages/cli/src/lib/implementation/global-options.ts

@@ -0,0 +1,26 @@
+import { GlobalOptions } from '../model';
+import { Options } from 'yargs';
+
+export function yargsGlobalOptionsDefinition(): Record<
+  keyof GlobalOptions,
+  Options
+> {
+  return {
+    interactive: {
+      describe: 'When false disables interactive input prompts for options.',
+      type: 'boolean',
+      default: true,
+    },
+    verbose: {
+      describe:
+        'When true creates more verbose output. This is helpful when debugging.',
+      type: 'boolean',
+      default: false,
+    },
+    configPath: {
+      describe: 'Path the the config file, e.g. code-pushup.config.js',
+      type: 'string',
+      default: 'code-pushup.config.js',
+    },
+  };
+}

packages/cli/src/lib/implementation/model.ts

@@ -0,0 +1,24 @@
+import {
+  globalOptionsSchema as coreGlobalOptionsSchema,
+  refineCoreConfig,
+  unrefinedCoreConfigSchema,
+} from '@quality-metrics/models';
+import { z } from 'zod';
+
+export const globalOptionsSchema = coreGlobalOptionsSchema.merge(
+  z.object({
+    interactive: z
+      .boolean({
+        description:
+          'flag if interactivity should be considered. Useful for CI runs.',
+      })
+      .default(true),
+  }),
+);
+
+export type GlobalOptions = z.infer<typeof globalOptionsSchema>;
+
+export const commandBaseSchema = refineCoreConfig(
+  globalOptionsSchema.merge(unrefinedCoreConfigSchema),
+);
+export type CommandBase = z.infer<typeof commandBaseSchema>;

packages/cli/src/lib/model.ts

@@ -0,0 +1,15 @@
+import { globalOptionsSchema as coreGlobalOptionsSchema } from '@quality-metrics/models';
+import { z } from 'zod';
+
+export const globalOptionsSchema = coreGlobalOptionsSchema.merge(
+  z.object({
+    interactive: z
+      .boolean({
+        description:
+          'flag if interactivity should be considered. Useful for CI runs.',
+      })
+      .default(true),
+  }),
+);
+
+export type GlobalOptions = z.infer<typeof globalOptionsSchema>;

packages/cli/src/lib/options.ts

@@ -1,22 +1,5 @@
-import { Options } from 'yargs';
+import { yargsGlobalOptionsDefinition } from './implementation/global-options';
 
-export function yargsGlobalOptionsDefinition(): Record<string, Options> {
-  return {
-    interactive: {
-      describe: 'When false disables interactive input prompts for options.',
-      type: 'boolean',
-      default: true,
-    },
-    verbose: {
-      describe:
-        'When true creates more verbose output. This is helpful when debugging.',
-      type: 'boolean',
-      default: false,
-    },
-    configPath: {
-      describe: 'Path the the config file, e.g. code-pushup.config.js',
-      type: 'string',
-      default: 'code-pushup.config.js',
-    },
-  };
-}
+export const options = {
+  ...yargsGlobalOptionsDefinition(),
+};

packages/models/src/index.ts

@@ -1,5 +1,5 @@
 export { CategoryConfig, categoryConfigSchema } from './lib/category-config';
-export { GlobalCliArgs, globalCliArgsSchema } from './lib/global-cli-options';
+export { GlobalOptions, globalOptionsSchema } from './lib/global-options';
 export {
   CoreConfig,
   coreConfigSchema,

packages/models/src/lib/global-cli-options.ts → packages/models/src/lib/global-options.ts

@@ -1,13 +1,7 @@
 import { z } from 'zod';
 import { generalFilePathSchema } from './implementation/schemas';
 
-export const globalCliArgsSchema = z.object({
-  interactive: z
-    .boolean({
-      description:
-        'flag if interactivity should be considered. Useful for CI runs.',
-    })
-    .default(true),
+export const globalOptionsSchema = z.object({
   verbose: z
     .boolean({
       description: 'Outputs additional information for a run',
@@ -20,4 +14,4 @@ export const globalCliArgsSchema = z.object({
     .default('code-pushup.config.js'),
 });
 
-export type GlobalCliArgs = z.infer<typeof globalCliArgsSchema>;
+export type GlobalOptions = z.infer<typeof globalOptionsSchema>;

packages/utils/src/lib/collect/index.ts

@@ -1,4 +1,4 @@
-import { CoreConfig, GlobalCliArgs, Report } from '@quality-metrics/models';
+import { CoreConfig, GlobalOptions, Report } from '@quality-metrics/models';
 import { executePlugins } from './implementation/execute-plugin';
 import { calcDuration } from './implementation/utils';
 
@@ -17,7 +17,7 @@ export class CollectOutputError extends Error {
   }
 }
 
-export type CollectOptions = GlobalCliArgs & CoreConfig;
+export type CollectOptions = GlobalOptions & CoreConfig;
 
 /**
  * Run audits, collect plugin output and aggregate it into a JSON object