@code-pushup/cli 0.47.0 → 0.48.0

package/README.md

@@ -198,9 +198,10 @@ Each example is fully tested to demonstrate best practices for plugin testing as
 | **`--upload.server`**       | `string`             | n/a      | URL to your portal server.                                                  |
 | **`--upload.apiKey`**       | `string`             | n/a      | API key for the portal server.                                              |
 | **`--onlyPlugins`**         | `string[]`           | `[]`     | Only run the specified plugins. Applicable to all commands except `upload`. |
+| **`--skipPlugins`**         | `string[]`           | `[]`     | Skip the specified plugins. Applicable to all commands except `upload`.     |
 
 > [!NOTE]  
-> All common options, except `--onlyPlugins`, can be specified in the configuration file as well.
+> All common options, except `--onlyPlugins` and `--skipPlugins`, can be specified in the configuration file as well.
 > CLI arguments take precedence over configuration file options.
 
 > [!NOTE]  

package/index.js

@@ -2139,8 +2139,8 @@ function formatDiffCategoriesSection(diff) {
   }
   const columns = [
     { key: "category", label: "\u{1F3F7}\uFE0F Category", align: "left" },
-    { key: "before", label: "\u2B50 Previous score" },
-    { key: "after", label: hasChanges ? "\u2B50 Current score" : "\u2B50 Score" },
+    { key: "before", label: hasChanges ? "\u2B50 Previous score" : "\u2B50 Score" },
+    { key: "after", label: "\u2B50 Current score" },
     { key: "change", label: "\u{1F504} Score change" }
   ];
   return lines5(
@@ -2169,7 +2169,7 @@ function formatDiffCategoriesSection(diff) {
           change: "\u2013"
         }))
       ].map(
-        (row) => hasChanges ? row : { category: row.category, after: row.after }
+        (row) => hasChanges ? row : { category: row.category, before: row.before }
       )
     }),
     added.length > 0 && section5(italicMd("(\\*) New category."))
@@ -2578,7 +2578,7 @@ var verboseUtils = (verbose = false) => ({
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.47.0";
+var version = "0.48.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk5 from "chalk";
@@ -3469,6 +3469,19 @@ function yargsOnlyPluginsOptionsDefinition() {
   };
 }
 
+// packages/cli/src/lib/implementation/skip-plugins.options.ts
+var skipPluginsOption = {
+  describe: "List of plugins to skip. If not set all plugins are run.",
+  type: "array",
+  default: [],
+  coerce: coerceArray
+};
+function yargsSkipPluginsOptionsDefinition() {
+  return {
+    skipPlugins: skipPluginsOption
+  };
+}
+
 // packages/cli/src/lib/history/history.options.ts
 function yargsHistoryOptionsDefinition() {
   return {
@@ -3579,7 +3592,8 @@ function yargsHistoryCommandObject() {
     builder: (yargs2) => {
       yargs2.options({
         ...yargsHistoryOptionsDefinition(),
-        ...yargsOnlyPluginsOptionsDefinition()
+        ...yargsOnlyPluginsOptionsDefinition(),
+        ...yargsSkipPluginsOptionsDefinition()
       });
       yargs2.group(
         Object.keys(yargsHistoryOptionsDefinition()),
@@ -3674,35 +3688,37 @@ async function coreConfigMiddleware(processArgs) {
   };
 }
 
-// packages/cli/src/lib/implementation/only-plugins.utils.ts
+// packages/cli/src/lib/implementation/validate-plugin-filter-options.utils.ts
 import chalk12 from "chalk";
-function validateOnlyPluginsOption({
+function validatePluginFilterOption(filterOption, {
   plugins,
   categories
 }, {
-  onlyPlugins = [],
+  pluginsToFilter = [],
   verbose = false
 } = {}) {
-  const onlyPluginsSet = new Set(onlyPlugins);
-  const missingPlugins = onlyPlugins.filter(
+  const pluginsToFilterSet = new Set(pluginsToFilter);
+  const missingPlugins = pluginsToFilter.filter(
     (plugin) => !plugins.some(({ slug }) => slug === plugin)
   );
+  const isSkipOption = filterOption === "skipPlugins";
+  const filterFunction = (plugin) => isSkipOption ? pluginsToFilterSet.has(plugin) : !pluginsToFilterSet.has(plugin);
   if (missingPlugins.length > 0 && verbose) {
     ui().logger.info(
       `${chalk12.yellow(
         "\u26A0"
-      )} The --onlyPlugin argument references plugins with "${missingPlugins.join(
+      )} The --${filterOption} argument references plugins with "${missingPlugins.join(
         '", "'
       )}" slugs, but no such plugins are present in the configuration. Expected one of the following plugin slugs: "${plugins.map(({ slug }) => slug).join('", "')}".`
     );
   }
-  if (categories.length > 0) {
-    const removedCategorieSlugs = filterItemRefsBy(
+  if (categories.length > 0 && verbose) {
+    const removedCategorySlugs = filterItemRefsBy(
       categories,
-      ({ plugin }) => !onlyPluginsSet.has(plugin)
+      ({ plugin }) => filterFunction(plugin)
     ).map(({ slug }) => slug);
     ui().logger.info(
-      `The --onlyPlugin argument removed categories with "${removedCategorieSlugs.join(
+      `The --${filterOption} argument removed categories with "${removedCategorySlugs.join(
         '", "'
       )}" slugs.
     `
@@ -3715,9 +3731,10 @@ function onlyPluginsMiddleware(originalProcessArgs) {
   const { categories = [], onlyPlugins: originalOnlyPlugins } = originalProcessArgs;
   if (originalOnlyPlugins && originalOnlyPlugins.length > 0) {
     const { verbose, plugins, onlyPlugins = [] } = originalProcessArgs;
-    validateOnlyPluginsOption(
+    validatePluginFilterOption(
+      "onlyPlugins",
       { plugins, categories },
-      { onlyPlugins, verbose }
+      { pluginsToFilter: onlyPlugins, verbose }
     );
     const validOnlyPlugins = onlyPlugins.filter(
       (oP) => plugins.find((p) => p.slug === oP)
@@ -3739,6 +3756,36 @@ function onlyPluginsMiddleware(originalProcessArgs) {
   };
 }
 
+// packages/cli/src/lib/implementation/skip-plugins.middleware.ts
+function skipPluginsMiddleware(originalProcessArgs) {
+  const { categories = [], skipPlugins: originalSkipPlugins } = originalProcessArgs;
+  if (originalSkipPlugins && originalSkipPlugins.length > 0) {
+    const { verbose, plugins, skipPlugins = [] } = originalProcessArgs;
+    validatePluginFilterOption(
+      "skipPlugins",
+      { plugins, categories },
+      { pluginsToFilter: skipPlugins, verbose }
+    );
+    const validSkipPlugins = skipPlugins.filter(
+      (sP) => plugins.find((p) => p.slug === sP)
+    );
+    const skipPluginsSet = new Set(validSkipPlugins);
+    return {
+      ...originalProcessArgs,
+      plugins: skipPluginsSet.size > 0 ? plugins.filter(({ slug }) => !skipPluginsSet.has(slug)) : plugins,
+      categories: skipPluginsSet.size > 0 ? filterItemRefsBy(
+        categories,
+        ({ plugin }) => !skipPluginsSet.has(plugin)
+      ) : categories
+    };
+  }
+  return {
+    ...originalProcessArgs,
+    // if undefined fill categories with empty array
+    categories
+  };
+}
+
 // packages/cli/src/lib/middlewares.ts
 var middlewares = [
   {
@@ -3748,6 +3795,10 @@ var middlewares = [
   {
     middlewareFunction: onlyPluginsMiddleware,
     applyBeforeValidation: false
+  },
+  {
+    middlewareFunction: skipPluginsMiddleware,
+    applyBeforeValidation: false
   }
 ];
 
@@ -3823,12 +3874,14 @@ function yargsGlobalOptionsDefinition() {
 var options = {
   ...yargsGlobalOptionsDefinition(),
   ...yargsCoreConfigOptionsDefinition(),
-  ...yargsOnlyPluginsOptionsDefinition()
+  ...yargsOnlyPluginsOptionsDefinition(),
+  ...yargsSkipPluginsOptionsDefinition()
 };
 var groups = {
   "Global Options:": [
     ...Object.keys(yargsGlobalOptionsDefinition()),
-    ...Object.keys(yargsOnlyPluginsOptionsDefinition())
+    ...Object.keys(yargsOnlyPluginsOptionsDefinition()),
+    ...Object.keys(yargsSkipPluginsOptionsDefinition())
   ],
   "Persist Options:": Object.keys(yargsPersistConfigOptionsDefinition()),
   "Upload Options:": Object.keys(yargsUploadConfigOptionsDefinition())
@@ -3920,6 +3973,10 @@ var cli = (args) => yargsCli(args, {
       "code-pushup collect --onlyPlugins=coverage",
       "Run collect with only coverage plugin, other plugins from config file will be skipped."
     ],
+    [
+      "code-pushup collect --skipPlugins=coverage",
+      "Run collect skiping the coverage plugin, other plugins from config file will be included."
+    ],
     [
       "code-pushup upload --persist.outputDir=dist --persist.filename=cp-report --upload.apiKey=$CP_API_KEY",
       "Upload dist/cp-report.json to portal using API key from environment variable"

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.47.0",
+  "version": "0.48.0",
   "license": "MIT",
   "bin": {
     "code-pushup": "index.js"
   },
   "dependencies": {
-    "@code-pushup/models": "0.47.0",
-    "@code-pushup/core": "0.47.0",
-    "@code-pushup/utils": "0.47.0",
+    "@code-pushup/models": "0.48.0",
+    "@code-pushup/core": "0.48.0",
+    "@code-pushup/utils": "0.48.0",
     "yargs": "^17.7.2",
     "chalk": "^5.3.0",
     "simple-git": "^3.20.0"

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

@@ -2,4 +2,5 @@ import { CoreConfig } from '@code-pushup/models';
 import { CoreConfigCliOptions } from './core-config.model';
 import { GeneralCliOptions } from './global.model';
 import { OnlyPluginsOptions } from './only-plugins.model';
-export declare function coreConfigMiddleware<T extends GeneralCliOptions & CoreConfigCliOptions & OnlyPluginsOptions>(processArgs: T): Promise<GeneralCliOptions & CoreConfig & OnlyPluginsOptions>;
+import { SkipPluginsOptions } from './skip-plugins.model';
+export declare function coreConfigMiddleware<T extends GeneralCliOptions & CoreConfigCliOptions & OnlyPluginsOptions & SkipPluginsOptions>(processArgs: T): Promise<GeneralCliOptions & CoreConfig & OnlyPluginsOptions & SkipPluginsOptions>;

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

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

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

@@ -0,0 +1,6 @@
+import { GlobalOptions } from '@code-pushup/core';
+import { 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

@@ -0,0 +1,3 @@
+import { Options } from 'yargs';
+export declare const skipPluginsOption: Options;
+export declare function yargsSkipPluginsOptionsDefinition(): Record<'skipPlugins', Options>;

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

@@ -0,0 +1,8 @@
+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;

package/src/lib/options.d.ts

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

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

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