Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(cli): rename only-plugins utils #418

Merged
merged 2 commits into from
Jan 16, 2024
+15 −18
Merged

refactor(cli): rename only-plugins utils #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab453d4
refactor(cli): rename only-plugins utils
BioPhoton Jan 15, 2024
8909417
Apply suggestions from code review
BioPhoton Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions packages/cli/src/lib/implementation/only-plugins.middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { CoreConfig } from '@code-pushup/models';
import { GeneralCliOptions } from './global.model';
import { OnlyPluginsOptions } from './only-plugins.model';
import {
filterCategoryByOnlyPluginsOption,
filterPluginsByOnlyPluginsOption,
filterCategoryByPluginSlug,
filterPluginsBySlug,
validateOnlyPluginsOption,
} from './only-plugins.utils';

Expand All @@ -20,11 +20,8 @@ export function onlyPluginsMiddleware<
const parsedProcessArgs: CoreConfig & GeneralCliOptions & OnlyPluginsOptions =
{
...cliOptions,
plugins: filterPluginsByOnlyPluginsOption(cliOptions.plugins, cliOptions),
categories: filterCategoryByOnlyPluginsOption(
cliOptions.categories,
cliOptions,
),
plugins: filterPluginsBySlug(cliOptions.plugins, cliOptions),
categories: filterCategoryByPluginSlug(cliOptions.categories, cliOptions),
};

return parsedProcessArgs;
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/lib/implementation/only-plugins.utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import chalk from 'chalk';
import { CoreConfig } from '@code-pushup/models';

export function filterPluginsByOnlyPluginsOption(
export function filterPluginsBySlug(
plugins: CoreConfig['plugins'],
{ onlyPlugins }: { onlyPlugins?: string[] },
): CoreConfig['plugins'] {
Expand All @@ -13,7 +13,7 @@ export function filterPluginsByOnlyPluginsOption(

// skip the whole category if it has at least one skipped plugin ref
// see https://github.com/code-pushup/cli/pull/246#discussion_r1392274281
export function filterCategoryByOnlyPluginsOption(
export function filterCategoryByPluginSlug(
categories: CoreConfig['categories'],
{
onlyPlugins,
Expand Down
18 changes: 9 additions & 9 deletions packages/cli/src/lib/implementation/only-plugins.utils.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { describe, expect } from 'vitest';
import { CoreConfig } from '@code-pushup/models';
import {
filterCategoryByOnlyPluginsOption,
filterPluginsByOnlyPluginsOption,
filterCategoryByPluginSlug,
filterPluginsBySlug,
validateOnlyPluginsOption,
} from './only-plugins.utils';

describe('filterPluginsByOnlyPluginsOption', () => {
describe('filterPluginsBySlug', () => {
it('should return all plugins if no onlyPlugins option is provided', () => {
expect(
filterPluginsByOnlyPluginsOption(
filterPluginsBySlug(
[
{ slug: 'plugin1' },
{ slug: 'plugin2' },
Expand All @@ -22,7 +22,7 @@ describe('filterPluginsByOnlyPluginsOption', () => {

it('should return only plugins with matching slugs', () => {
expect(
filterPluginsByOnlyPluginsOption(
filterPluginsBySlug(
[
{ slug: 'plugin1' },
{ slug: 'plugin2' },
Expand All @@ -34,10 +34,10 @@ describe('filterPluginsByOnlyPluginsOption', () => {
});
});

describe('filterCategoryByOnlyPluginsOption', () => {
describe('filterCategoryByPluginSlug', () => {
it('should return all categories if no onlyPlugins option', () => {
expect(
filterCategoryByOnlyPluginsOption(
filterCategoryByPluginSlug(
[
{ refs: [{ slug: 'plugin1' }, { slug: 'plugin2' }] },
{ refs: [{ slug: 'plugin3' }] },
Expand All @@ -52,7 +52,7 @@ describe('filterCategoryByOnlyPluginsOption', () => {

it('should return categories containing only defined plugins', () => {
expect(
filterCategoryByOnlyPluginsOption(
filterCategoryByPluginSlug(
[
{ refs: [{ slug: 'plugin1' }, { slug: 'plugin2' }] },
{ refs: [{ slug: 'plugin3' }] },
Expand All @@ -63,7 +63,7 @@ describe('filterCategoryByOnlyPluginsOption', () => {
});

it('should print ignored category and its first violating plugin', () => {
filterCategoryByOnlyPluginsOption(
filterCategoryByPluginSlug(
[
{
title: 'category1',
Expand Down