@code-pushup/cli 0.8.18 → 0.8.20

package/README.md

@@ -139,7 +139,7 @@ jobs:
 We provide comprehensive documentation on [how to create a custom plugin](./docs/custom-plugins.md).
 
 The repository also maintains a set of plugin examples showcasing different scenarios.  
-Each example is fully tested to give demonstrate best practices for plugin testing.
+Each example is fully tested to demonstrate best practices for plugin testing as well.
 
 **Example for custom plugins:**
 
@@ -170,7 +170,7 @@ Each example is fully tested to give demonstrate best practices for plugin testi
 | **`--onlyPlugins`**         | `string[]`           | `[]`     | Only run the specified plugins. Applicable to all commands except `upload`. |
 
 > [!NOTE]  
-> All common options, expect `--onlyPlugins`, can be specified in the configuration file as well.
+> All common options, except `--onlyPlugins`, can be specified in the configuration file as well.
 > CLI arguments take precedence over configuration file options.
 
 > [!NOTE]
@@ -184,7 +184,7 @@ Usage:
 `code-pushup collect [options]`
 
 Description:
-The command initializes the necessary plugins, runs them, and then collects the results. After collecting the results, it generates a comprehensive report.
+The command initializes and executes the necessary plugins and collects the results. Based on the results it generates a comprehensive report.
 
 Refer to the [Common Command Options](#common-command-options) for the list of available options.
 
@@ -204,7 +204,7 @@ Usage:
 `code-pushup autorun [options]`
 
 Description:
-Run plugins, collect results and upload report to the Code PushUp portal.
+Run plugins, collect results and upload the report to the Code PushUp portal.
 
 Refer to the [Common Command Options](#common-command-options) for the list of available options.
 

package/index.js

@@ -1725,7 +1725,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.8.18";
+var version = "0.8.20";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options2) {
@@ -2059,13 +2059,13 @@ async function coreConfigMiddleware(processArgs) {
 
 // packages/cli/src/lib/implementation/only-plugins.utils.ts
 import chalk8 from "chalk";
-function filterPluginsByOnlyPluginsOption(plugins, { onlyPlugins }) {
+function filterPluginsBySlug(plugins, { onlyPlugins }) {
   if (!onlyPlugins?.length) {
     return plugins;
   }
   return plugins.filter((plugin) => onlyPlugins.includes(plugin.slug));
 }
-function filterCategoryByOnlyPluginsOption(categories, {
+function filterCategoryByPluginSlug(categories, {
   onlyPlugins,
   verbose = false
 }) {
@@ -2107,11 +2107,8 @@ function onlyPluginsMiddleware(processArgs) {
   validateOnlyPluginsOption(cliOptions.plugins, cliOptions);
   const parsedProcessArgs = {
     ...cliOptions,
-    plugins: filterPluginsByOnlyPluginsOption(cliOptions.plugins, cliOptions),
-    categories: filterCategoryByOnlyPluginsOption(
-      cliOptions.categories,
-      cliOptions
-    )
+    plugins: filterPluginsBySlug(cliOptions.plugins, cliOptions),
+    categories: filterCategoryByPluginSlug(cliOptions.categories, cliOptions)
   };
   return parsedProcessArgs;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.8.18",
+  "version": "0.8.20",
   "bin": {
     "code-pushup": "index.js"
   },

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

@@ -1,8 +1,8 @@
 import { CoreConfig } from '@code-pushup/models';
-export declare function filterPluginsByOnlyPluginsOption(plugins: CoreConfig['plugins'], { onlyPlugins }: {
+export declare function filterPluginsBySlug(plugins: CoreConfig['plugins'], { onlyPlugins }: {
     onlyPlugins?: string[];
 }): CoreConfig['plugins'];
-export declare function filterCategoryByOnlyPluginsOption(categories: CoreConfig['categories'], { onlyPlugins, verbose, }: {
+export declare function filterCategoryByPluginSlug(categories: CoreConfig['categories'], { onlyPlugins, verbose, }: {
     onlyPlugins?: string[];
     verbose?: boolean;
 }): CoreConfig['categories'];