@code-pushup/cli 0.50.0 → 0.52.0

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.50.0",
+  "version": "0.52.0",
   "license": "MIT",
   "description": "A CLI to run all kinds of code quality measurements to align your team with company goals",
   "bin": {
     "code-pushup": "index.js"
   },
   "dependencies": {
-    "@code-pushup/models": "0.50.0",
-    "@code-pushup/core": "0.50.0",
-    "@code-pushup/utils": "0.50.0",
+    "@code-pushup/models": "0.52.0",
+    "@code-pushup/core": "0.52.0",
+    "@code-pushup/utils": "0.52.0",
     "yargs": "^17.7.2",
     "ansis": "^3.3.0",
     "simple-git": "^3.20.0"
@@ -23,6 +23,9 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/cli"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts"

package/src/lib/implementation/core-config.middleware.d.ts

@@ -1,8 +1,7 @@
 import { type CoreConfig, type Format } from '@code-pushup/models';
 import type { CoreConfigCliOptions } from './core-config.model';
+import type { FilterOptions } from './filter.model';
 import type { GeneralCliOptions } from './global.model';
-import type { OnlyPluginsOptions } from './only-plugins.model';
-import type { SkipPluginsOptions } from './skip-plugins.model';
-export type CoreConfigMiddlewareOptions = GeneralCliOptions & CoreConfigCliOptions & OnlyPluginsOptions & SkipPluginsOptions;
-export declare function coreConfigMiddleware<T extends CoreConfigMiddlewareOptions>(processArgs: T): Promise<GeneralCliOptions & CoreConfig & OnlyPluginsOptions & SkipPluginsOptions>;
+export type CoreConfigMiddlewareOptions = GeneralCliOptions & CoreConfigCliOptions & FilterOptions;
+export declare function coreConfigMiddleware<T extends CoreConfigMiddlewareOptions>(processArgs: T): Promise<GeneralCliOptions & CoreConfig & FilterOptions>;
 export declare const normalizeFormats: (formats?: string[]) => Format[];

package/src/lib/implementation/filter.middleware.d.ts

@@ -0,0 +1,2 @@
+import type { FilterOptions } from './filter.model';
+export declare function filterMiddleware<T extends FilterOptions>(originalProcessArgs: T): T;

package/src/lib/implementation/filter.model.d.ts

@@ -0,0 +1,9 @@
+import type { GlobalOptions } from '@code-pushup/core';
+import type { CategoryConfig, CoreConfig, PluginConfig } from '@code-pushup/models';
+export type FilterOptions = Partial<GlobalOptions> & Pick<CoreConfig, 'categories' | 'plugins'> & FilterCliOptions;
+export type FilterCliOptions = Partial<Record<FilterOptionType, string[]>>;
+export type FilterOptionType = 'skipCategories' | 'onlyCategories' | 'skipPlugins' | 'onlyPlugins';
+export type Filterables = {
+    categories: CategoryConfig[];
+    plugins: PluginConfig[];
+};

package/src/lib/implementation/filter.options.d.ts

@@ -0,0 +1,7 @@
+import type { Options } from 'yargs';
+import type { FilterCliOptions } from './filter.model';
+export declare const skipCategoriesOption: Options;
+export declare const onlyCategoriesOption: Options;
+export declare const skipPluginsOption: Options;
+export declare const onlyPluginsOption: Options;
+export declare function yargsFilterOptionsDefinition(): Record<keyof FilterCliOptions, Options>;

package/src/lib/implementation/validate-filter-options.utils.d.ts

@@ -0,0 +1,13 @@
+import type { CategoryConfig, PluginConfig } from '@code-pushup/models';
+import type { FilterOptionType, Filterables } from './filter.model';
+export declare class OptionValidationError extends Error {
+}
+export declare function validateFilterOption(option: FilterOptionType, { plugins, categories }: Filterables, { itemsToFilter, verbose }: {
+    itemsToFilter: string[];
+    verbose: boolean;
+}): void;
+export declare function validateFinalState(filteredItems: Filterables, originalItems: Filterables): void;
+export declare function isOnlyOption(option: FilterOptionType): boolean;
+export declare function getItemType(option: FilterOptionType, count: number): string;
+export declare function createValidationMessage(option: FilterOptionType, invalidItems: string[], validItems: Pick<PluginConfig | CategoryConfig, 'slug'>[]): string;
+export declare function handleConflictingOptions(type: 'categories' | 'plugins', onlyItems: string[], skipItems: string[]): void;

package/src/lib/options.d.ts

@@ -1,4 +1,6 @@
 export declare const options: {
+    skipCategories: import("yargs").Options;
+    onlyCategories: import("yargs").Options;
     skipPlugins: import("yargs").Options;
     onlyPlugins: import("yargs").Options;
     "persist.outputDir": import("yargs").Options;

package/src/lib/implementation/only-plugins.middleware.d.ts

@@ -1,2 +0,0 @@
-import type { OnlyPluginsOptions } from './only-plugins.model';
-export declare function onlyPluginsMiddleware<T extends OnlyPluginsOptions>(originalProcessArgs: T): T;

package/src/lib/implementation/only-plugins.model.d.ts

@@ -1,6 +0,0 @@
-import type { GlobalOptions } from '@code-pushup/core';
-import type { CoreConfig } from '@code-pushup/models';
-export type OnlyPluginsCliOptions = {
-    onlyPlugins?: string[];
-};
-export type OnlyPluginsOptions = Partial<GlobalOptions> & Pick<CoreConfig, 'categories' | 'plugins'> & OnlyPluginsCliOptions;

package/src/lib/implementation/only-plugins.options.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from 'yargs';
-import type { OnlyPluginsCliOptions } from './only-plugins.model';
-export declare const onlyPluginsOption: Options;
-export declare function yargsOnlyPluginsOptionsDefinition(): Record<keyof OnlyPluginsCliOptions, Options>;

package/src/lib/implementation/skip-plugins.middleware.d.ts

@@ -1,2 +0,0 @@
-import type { SkipPluginsOptions } from './skip-plugins.model';
-export declare function skipPluginsMiddleware<T extends SkipPluginsOptions>(originalProcessArgs: T): T;

package/src/lib/implementation/skip-plugins.model.d.ts

@@ -1,6 +0,0 @@
-import type { GlobalOptions } from '@code-pushup/core';
-import type { CoreConfig } from '@code-pushup/models';
-export type SkipPluginsCliOptions = {
-    skipPlugins?: string[];
-};
-export type SkipPluginsOptions = Partial<GlobalOptions> & Pick<CoreConfig, 'categories' | 'plugins'> & SkipPluginsCliOptions;

package/src/lib/implementation/skip-plugins.options.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from 'yargs';
-import type { SkipPluginsCliOptions } from './skip-plugins.model';
-export declare const skipPluginsOption: Options;
-export declare function yargsSkipPluginsOptionsDefinition(): Record<keyof SkipPluginsCliOptions, Options>;

package/src/lib/implementation/validate-plugin-filter-options.utils.d.ts

@@ -1,8 +0,0 @@
-import type { CategoryConfig, PluginConfig } from '@code-pushup/models';
-export declare function validatePluginFilterOption(filterOption: 'onlyPlugins' | 'skipPlugins', { plugins, categories, }: {
-    plugins: PluginConfig[];
-    categories: CategoryConfig[];
-}, { pluginsToFilter, verbose, }?: {
-    pluginsToFilter?: string[];
-    verbose?: boolean;
-}): void;