feat(cli): handle skipped audits and groups in filter middleware

Author: hanna-skryl

packages/cli/src/lib/implementation/filter.middleware.ts

@@ -1,18 +1,25 @@
-import type { CoreConfig } from '@code-pushup/models';
+import type {
+  CategoryConfig,
+  CoreConfig,
+  PluginConfig,
+} from '@code-pushup/models';
 import { filterItemRefsBy } from '@code-pushup/utils';
 import type { FilterOptions, Filterables } from './filter.model.js';
 import {
   handleConflictingOptions,
+  isValidCategoryRef,
   validateFilterOption,
+  validateFilteredCategories,
   validateFinalState,
 } from './validate-filter-options.utils.js';
 
+// eslint-disable-next-line max-lines-per-function
 export function filterMiddleware<T extends FilterOptions>(
   originalProcessArgs: T,
 ): T {
   const {
-    plugins,
-    categories,
+    categories: rcCategories,
+    plugins: rcPlugins,
     skipCategories = [],
     onlyCategories = [],
     skipPlugins = [],
@@ -32,6 +39,13 @@ export function filterMiddleware<T extends FilterOptions>(
   handleConflictingOptions('categories', onlyCategories, skipCategories);
   handleConflictingOptions('plugins', onlyPlugins, skipPlugins);
 
+  const plugins = processPlugins(rcPlugins);
+  const categories = filterSkippedCategories(rcCategories, plugins);
+
+  if (rcCategories && categories && verbose) {
+    validateFilteredCategories(rcCategories, categories);
+  }
+
   const filteredCategories = applyCategoryFilters(
     { categories, plugins },
     skipCategories,
@@ -52,7 +66,7 @@ export function filterMiddleware<T extends FilterOptions>(
 
   validateFinalState(
     { categories: finalCategories, plugins: filteredPlugins },
-    { categories, plugins },
+    { categories: rcCategories, plugins: rcPlugins },
   );
 
   return {
@@ -141,3 +155,51 @@ function filterPluginsFromCategories({
   );
   return plugins.filter(plugin => validPluginSlugs.has(plugin.slug));
 }
+
+function filterSkippedItems<T extends { isSkipped?: boolean }>(
+  items: T[] | undefined,
+): T[] {
+  return (items ?? []).filter(({ isSkipped }) => isSkipped !== true);
+}
+
+export function filterSkippedGroups(
+  groups: PluginConfig['groups'],
+  audits: PluginConfig['audits'],
+): PluginConfig['groups'] {
+  if (!groups) {
+    return groups;
+  }
+  return filterItemRefsBy(groups, ref =>
+    audits.some(audit => audit.slug === ref.slug && audit.isSkipped !== true),
+  );
+}
+
+export function processPlugins(plugins: PluginConfig[]): PluginConfig[] {
+  return plugins.map((plugin: PluginConfig) => ({
+    ...plugin,
+    ...(plugin.groups && {
+      groups: filterSkippedGroups(
+        filterSkippedItems(plugin.groups),
+        filterSkippedItems(plugin.audits),
+      ),
+    }),
+    audits: filterSkippedItems(plugin.audits),
+  }));
+}
+
+export function filterSkippedCategories(
+  categories: CoreConfig['categories'],
+  plugins: CoreConfig['plugins'],
+): CoreConfig['categories'] {
+  if (!categories || categories.length === 0) {
+    return categories;
+  }
+  return categories
+    .map(category => {
+      const validRefs = category.refs.filter(ref =>
+        isValidCategoryRef(ref, plugins),
+      );
+      return validRefs.length > 0 ? { ...category, refs: validRefs } : null;
+    })
+    .filter((category): category is CategoryConfig => category != null);
+}