From 8882100643160ec81cfaeb0a8737ba4fcf2b9a35 Mon Sep 17 00:00:00 2001 From: Katerina Pilatova Date: Fri, 12 Jan 2024 13:38:51 +0100 Subject: [PATCH 1/3] chore: fix remaining test file ESLint issues --- .../generators/configuration/generator.integration.test.ts | 2 +- packages/utils/src/lib/formatting.unit.test.ts | 2 +- packages/utils/src/lib/log-results.unit.test.ts | 4 ++-- packages/utils/src/lib/progress.integration.test.ts | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/nx-plugin/src/generators/configuration/generator.integration.test.ts b/packages/nx-plugin/src/generators/configuration/generator.integration.test.ts index aeb972e81..7d4104365 100644 --- a/packages/nx-plugin/src/generators/configuration/generator.integration.test.ts +++ b/packages/nx-plugin/src/generators/configuration/generator.integration.test.ts @@ -4,7 +4,7 @@ import { readProjectConfiguration, } from '@nx/devkit'; import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing'; -import { join } from 'path'; +import { join } from 'node:path'; import { describe, expect, it } from 'vitest'; import { addToProjectGenerator } from './generator'; diff --git a/packages/utils/src/lib/formatting.unit.test.ts b/packages/utils/src/lib/formatting.unit.test.ts index ca176c3c1..f9bec2635 100644 --- a/packages/utils/src/lib/formatting.unit.test.ts +++ b/packages/utils/src/lib/formatting.unit.test.ts @@ -35,7 +35,7 @@ describe('pluralize', () => { describe('formatBytes', () => { it.each([ [0, '0 B'], - [1_000, '1000 B'], + [1000, '1000 B'], [10_000, '9.77 kB'], [10_000_000, '9.54 MB'], [10_000_000_000, '9.31 GB'], diff --git a/packages/utils/src/lib/log-results.unit.test.ts b/packages/utils/src/lib/log-results.unit.test.ts index 25eae7bc9..407d6b9d8 100644 --- a/packages/utils/src/lib/log-results.unit.test.ts +++ b/packages/utils/src/lib/log-results.unit.test.ts @@ -11,7 +11,7 @@ describe('logMultipleResults', () => { [ { status: 'fulfilled', - value: ['out.json', 10000], + value: ['out.json', 10_000], } as PromiseFulfilledResult, ], 'Generated reports', @@ -40,7 +40,7 @@ describe('logMultipleResults', () => { [ { status: 'fulfilled', - value: ['out.json', 10000], + value: ['out.json', 10_000], } as PromiseFulfilledResult, { status: 'rejected', reason: 'fail' } as PromiseRejectedResult, ], diff --git a/packages/utils/src/lib/progress.integration.test.ts b/packages/utils/src/lib/progress.integration.test.ts index 98a90a130..28412110b 100644 --- a/packages/utils/src/lib/progress.integration.test.ts +++ b/packages/utils/src/lib/progress.integration.test.ts @@ -28,7 +28,7 @@ describe('getSingletonMultiProgressBars', () => { const taskAName = 'a'; const bars = getSingletonProgressBars({ progressWidth: 1 }); const tasks = bars['tasks']; -const progressBuffer = bars['logger'].progressBuffer; +const progressBuffer: string[] = bars['logger'].progressBuffer; describe('getProgressBar', () => { it('should init task', () => { From b82ffb7cffea3a4efb900d76a6fe02588e6d7fc1 Mon Sep 17 00:00:00 2001 From: Katerina Pilatova Date: Fri, 12 Jan 2024 13:57:28 +0100 Subject: [PATCH 2/3] chore(utils): group reports related entities in a separate folder --- packages/utils/perf/score-report/index.ts | 2 +- .../utils/perf/score-report/optimized0.ts | 2 +- packages/utils/src/index.ts | 11 +++++----- packages/utils/src/lib/execute-process.ts | 2 +- packages/utils/src/lib/md/constants.ts | 1 - .../report-to-md.integration.test.ts.snap | 0 .../report-to-stdout.integration.test.ts.snap | 0 .../sorting.integration.test.ts.snap} | 0 .../utils/src/lib/{ => reports}/constants.ts | 2 ++ .../utils/src/lib/{ => reports}/md/details.ts | 0 .../src/lib/{ => reports}/md/font-style.ts | 0 .../{ => reports}/md/font-style.unit.test.ts | 0 .../src/lib/{ => reports}/md/headline.ts | 0 .../{ => reports}/md/headline.unit.test.ts | 0 .../utils/src/lib/{ => reports}/md/index.ts | 5 ++--- .../utils/src/lib/{ => reports}/md/link.ts | 0 .../lib/{ => reports}/md/link.unit.test.ts | 0 .../utils/src/lib/{ => reports}/md/list.ts | 0 .../lib/{ => reports}/md/list.unit.test.ts | 0 .../utils/src/lib/{ => reports}/md/table.ts | 2 +- .../lib/{ => reports}/md/table.unit.test.ts | 2 +- .../report-to-md.integration.test.ts | 2 +- .../src/lib/{ => reports}/report-to-md.ts | 20 +++++++++---------- .../report-to-stdout.integration.test.ts | 2 +- .../src/lib/{ => reports}/report-to-stdout.ts | 7 +++---- .../utils/src/lib/{ => reports}/scoring.ts | 2 +- .../lib/{ => reports}/scoring.unit.test.ts | 0 .../sorting.integration.test.ts} | 2 +- .../{sort-report.ts => reports/sorting.ts} | 12 +++++------ .../src/lib/{report.ts => reports/utils.ts} | 4 ++-- .../utils.unit.test.ts} | 12 +++++------ 31 files changed, 45 insertions(+), 47 deletions(-) delete mode 100644 packages/utils/src/lib/md/constants.ts rename packages/utils/src/lib/{ => reports}/__snapshots__/report-to-md.integration.test.ts.snap (100%) rename packages/utils/src/lib/{ => reports}/__snapshots__/report-to-stdout.integration.test.ts.snap (100%) rename packages/utils/src/lib/{__snapshots__/sort-report.integration.test.ts.snap => reports/__snapshots__/sorting.integration.test.ts.snap} (100%) rename packages/utils/src/lib/{ => reports}/constants.ts (70%) rename packages/utils/src/lib/{ => reports}/md/details.ts (100%) rename packages/utils/src/lib/{ => reports}/md/font-style.ts (100%) rename packages/utils/src/lib/{ => reports}/md/font-style.unit.test.ts (100%) rename packages/utils/src/lib/{ => reports}/md/headline.ts (100%) rename packages/utils/src/lib/{ => reports}/md/headline.unit.test.ts (100%) rename packages/utils/src/lib/{ => reports}/md/index.ts (84%) rename packages/utils/src/lib/{ => reports}/md/link.ts (100%) rename packages/utils/src/lib/{ => reports}/md/link.unit.test.ts (100%) rename packages/utils/src/lib/{ => reports}/md/list.ts (100%) rename packages/utils/src/lib/{ => reports}/md/list.unit.test.ts (100%) rename packages/utils/src/lib/{ => reports}/md/table.ts (96%) rename packages/utils/src/lib/{ => reports}/md/table.unit.test.ts (97%) rename packages/utils/src/lib/{ => reports}/report-to-md.integration.test.ts (95%) rename packages/utils/src/lib/{ => reports}/report-to-md.ts (98%) rename packages/utils/src/lib/{ => reports}/report-to-stdout.integration.test.ts (93%) rename packages/utils/src/lib/{ => reports}/report-to-stdout.ts (96%) rename packages/utils/src/lib/{ => reports}/scoring.ts (98%) rename packages/utils/src/lib/{ => reports}/scoring.unit.test.ts (100%) rename packages/utils/src/lib/{sort-report.integration.test.ts => reports/sorting.integration.test.ts} (97%) rename packages/utils/src/lib/{sort-report.ts => reports/sorting.ts} (98%) rename packages/utils/src/lib/{report.ts => reports/utils.ts} (99%) rename packages/utils/src/lib/{report.unit.test.ts => reports/utils.unit.test.ts} (99%) diff --git a/packages/utils/perf/score-report/index.ts b/packages/utils/perf/score-report/index.ts index cac389ff4..44b3d13e2 100644 --- a/packages/utils/perf/score-report/index.ts +++ b/packages/utils/perf/score-report/index.ts @@ -1,6 +1,6 @@ import * as Benchmark from 'benchmark'; import { Report } from '@code-pushup/models'; -import { scoreReport } from '../../src/lib/scoring'; +import { scoreReport } from '../../src/lib/reports/scoring'; import { scoreReportOptimized0 } from './optimized0'; import { scoreReportOptimized1 } from './optimized1'; import { scoreReportOptimized2 } from './optimized2'; diff --git a/packages/utils/perf/score-report/optimized0.ts b/packages/utils/perf/score-report/optimized0.ts index 66c450afa..1a4f10aec 100644 --- a/packages/utils/perf/score-report/optimized0.ts +++ b/packages/utils/perf/score-report/optimized0.ts @@ -3,7 +3,7 @@ import { ScoredReport } from '../../src'; import { EnrichedAuditReport, EnrichedScoredGroup, -} from '../../src/lib/scoring'; +} from '../../src/lib/reports/scoring'; function groupRefToScore(audits: EnrichedAuditReport[]) { return (ref: GroupRef) => { diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts index 8195c9b67..3764ef471 100644 --- a/packages/utils/src/index.ts +++ b/packages/utils/src/index.ts @@ -37,8 +37,11 @@ export { isPromiseRejectedResult, } from './lib/guards'; export { logMultipleResults } from './lib/log-results'; -export { NEW_LINE } from './lib/md'; export { ProgressBar, getProgressBar } from './lib/progress'; +export { reportToMd } from './lib/reports/report-to-md'; +export { reportToStdout } from './lib/reports/report-to-stdout'; +export { ScoredReport, scoreReport } from './lib/reports/scoring'; +export { sortReport } from './lib/reports/sorting'; export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, @@ -46,10 +49,7 @@ export { calcDuration, compareIssueSeverity, loadReport, -} from './lib/report'; -export { reportToMd } from './lib/report-to-md'; -export { reportToStdout } from './lib/report-to-stdout'; -export { ScoredReport, scoreReport } from './lib/scoring'; +} from './lib/reports/utils'; export { CliArgsObject, countOccurrences, @@ -62,4 +62,3 @@ export { toUnixPath, } from './lib/transform'; export { verboseUtils } from './lib/verbose-utils'; -export { sortReport } from './lib/sort-report'; diff --git a/packages/utils/src/lib/execute-process.ts b/packages/utils/src/lib/execute-process.ts index 46a267d87..4123742c9 100644 --- a/packages/utils/src/lib/execute-process.ts +++ b/packages/utils/src/lib/execute-process.ts @@ -1,5 +1,5 @@ import { spawn } from 'node:child_process'; -import { calcDuration } from './report'; +import { calcDuration } from './reports/utils'; /** * Represents the process result. diff --git a/packages/utils/src/lib/md/constants.ts b/packages/utils/src/lib/md/constants.ts deleted file mode 100644 index a8d9b32fa..000000000 --- a/packages/utils/src/lib/md/constants.ts +++ /dev/null @@ -1 +0,0 @@ -export const NEW_LINE = '\n'; diff --git a/packages/utils/src/lib/__snapshots__/report-to-md.integration.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/report-to-md.integration.test.ts.snap similarity index 100% rename from packages/utils/src/lib/__snapshots__/report-to-md.integration.test.ts.snap rename to packages/utils/src/lib/reports/__snapshots__/report-to-md.integration.test.ts.snap diff --git a/packages/utils/src/lib/__snapshots__/report-to-stdout.integration.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/report-to-stdout.integration.test.ts.snap similarity index 100% rename from packages/utils/src/lib/__snapshots__/report-to-stdout.integration.test.ts.snap rename to packages/utils/src/lib/reports/__snapshots__/report-to-stdout.integration.test.ts.snap diff --git a/packages/utils/src/lib/__snapshots__/sort-report.integration.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/sorting.integration.test.ts.snap similarity index 100% rename from packages/utils/src/lib/__snapshots__/sort-report.integration.test.ts.snap rename to packages/utils/src/lib/reports/__snapshots__/sorting.integration.test.ts.snap diff --git a/packages/utils/src/lib/constants.ts b/packages/utils/src/lib/reports/constants.ts similarity index 70% rename from packages/utils/src/lib/constants.ts rename to packages/utils/src/lib/reports/constants.ts index 6afbfce61..42a17ed14 100644 --- a/packages/utils/src/lib/constants.ts +++ b/packages/utils/src/lib/reports/constants.ts @@ -1,3 +1,5 @@ +export const NEW_LINE = '\n'; + export const SCORE_COLOR_RANGE = { GREEN_MIN: 0.9, YELLOW_MIN: 0.5, diff --git a/packages/utils/src/lib/md/details.ts b/packages/utils/src/lib/reports/md/details.ts similarity index 100% rename from packages/utils/src/lib/md/details.ts rename to packages/utils/src/lib/reports/md/details.ts diff --git a/packages/utils/src/lib/md/font-style.ts b/packages/utils/src/lib/reports/md/font-style.ts similarity index 100% rename from packages/utils/src/lib/md/font-style.ts rename to packages/utils/src/lib/reports/md/font-style.ts diff --git a/packages/utils/src/lib/md/font-style.unit.test.ts b/packages/utils/src/lib/reports/md/font-style.unit.test.ts similarity index 100% rename from packages/utils/src/lib/md/font-style.unit.test.ts rename to packages/utils/src/lib/reports/md/font-style.unit.test.ts diff --git a/packages/utils/src/lib/md/headline.ts b/packages/utils/src/lib/reports/md/headline.ts similarity index 100% rename from packages/utils/src/lib/md/headline.ts rename to packages/utils/src/lib/reports/md/headline.ts diff --git a/packages/utils/src/lib/md/headline.unit.test.ts b/packages/utils/src/lib/reports/md/headline.unit.test.ts similarity index 100% rename from packages/utils/src/lib/md/headline.unit.test.ts rename to packages/utils/src/lib/reports/md/headline.unit.test.ts diff --git a/packages/utils/src/lib/md/index.ts b/packages/utils/src/lib/reports/md/index.ts similarity index 84% rename from packages/utils/src/lib/md/index.ts rename to packages/utils/src/lib/reports/md/index.ts index 27d0de9c2..0356451b1 100644 --- a/packages/utils/src/lib/md/index.ts +++ b/packages/utils/src/lib/reports/md/index.ts @@ -1,7 +1,6 @@ export * from './details'; -export * from './headline'; -export * from './table'; -export * from './constants'; export * from './font-style'; +export * from './headline'; export * from './link'; export * from './list'; +export * from './table'; diff --git a/packages/utils/src/lib/md/link.ts b/packages/utils/src/lib/reports/md/link.ts similarity index 100% rename from packages/utils/src/lib/md/link.ts rename to packages/utils/src/lib/reports/md/link.ts diff --git a/packages/utils/src/lib/md/link.unit.test.ts b/packages/utils/src/lib/reports/md/link.unit.test.ts similarity index 100% rename from packages/utils/src/lib/md/link.unit.test.ts rename to packages/utils/src/lib/reports/md/link.unit.test.ts diff --git a/packages/utils/src/lib/md/list.ts b/packages/utils/src/lib/reports/md/list.ts similarity index 100% rename from packages/utils/src/lib/md/list.ts rename to packages/utils/src/lib/reports/md/list.ts diff --git a/packages/utils/src/lib/md/list.unit.test.ts b/packages/utils/src/lib/reports/md/list.unit.test.ts similarity index 100% rename from packages/utils/src/lib/md/list.unit.test.ts rename to packages/utils/src/lib/reports/md/list.unit.test.ts diff --git a/packages/utils/src/lib/md/table.ts b/packages/utils/src/lib/reports/md/table.ts similarity index 96% rename from packages/utils/src/lib/md/table.ts rename to packages/utils/src/lib/reports/md/table.ts index 83256b327..8fc932045 100644 --- a/packages/utils/src/lib/md/table.ts +++ b/packages/utils/src/lib/reports/md/table.ts @@ -1,4 +1,4 @@ -import { NEW_LINE } from './constants'; +import { NEW_LINE } from '../constants'; export type Alignment = 'l' | 'c' | 'r'; const alignString = new Map([ diff --git a/packages/utils/src/lib/md/table.unit.test.ts b/packages/utils/src/lib/reports/md/table.unit.test.ts similarity index 97% rename from packages/utils/src/lib/md/table.unit.test.ts rename to packages/utils/src/lib/reports/md/table.unit.test.ts index 44eeccca6..8143364cb 100644 --- a/packages/utils/src/lib/md/table.unit.test.ts +++ b/packages/utils/src/lib/reports/md/table.unit.test.ts @@ -1,4 +1,4 @@ -import { NEW_LINE } from './constants'; +import { NEW_LINE } from '../constants'; import { Alignment, tableMd } from './table'; describe('table function', () => { diff --git a/packages/utils/src/lib/report-to-md.integration.test.ts b/packages/utils/src/lib/reports/report-to-md.integration.test.ts similarity index 95% rename from packages/utils/src/lib/report-to-md.integration.test.ts rename to packages/utils/src/lib/reports/report-to-md.integration.test.ts index 9b024a57d..3c91c9c4d 100644 --- a/packages/utils/src/lib/report-to-md.integration.test.ts +++ b/packages/utils/src/lib/reports/report-to-md.integration.test.ts @@ -2,7 +2,7 @@ import { describe } from 'vitest'; import { reportMock } from '@code-pushup/testing-utils'; import { reportToMd } from './report-to-md'; import { scoreReport } from './scoring'; -import { sortReport } from './sort-report'; +import { sortReport } from './sorting'; describe('report-to-md', () => { beforeEach(() => { diff --git a/packages/utils/src/lib/report-to-md.ts b/packages/utils/src/lib/reports/report-to-md.ts similarity index 98% rename from packages/utils/src/lib/report-to-md.ts rename to packages/utils/src/lib/reports/report-to-md.ts index 07316f5aa..d3909fab9 100644 --- a/packages/utils/src/lib/report-to-md.ts +++ b/packages/utils/src/lib/reports/report-to-md.ts @@ -1,8 +1,8 @@ import { AuditReport, CategoryConfig, Issue } from '@code-pushup/models'; -import { formatDuration, slugify } from './formatting'; -import { CommitData } from './git'; +import { formatDuration, slugify } from '../formatting'; +import { CommitData } from '../git'; +import { NEW_LINE } from './constants'; import { - NEW_LINE, details, h2, h3, @@ -12,7 +12,12 @@ import { style, tableHtml, tableMd, -} from './md/'; +} from './md'; +import { + EnrichedScoredGroupWithAudits, + ScoredReport, + WeighedAuditReport, +} from './scoring'; import { FOOTER_PREFIX, README_LINK, @@ -29,12 +34,7 @@ import { reportHeadlineText, reportMetaTableHeaders, reportOverviewTableHeaders, -} from './report'; -import { - EnrichedScoredGroupWithAudits, - ScoredReport, - WeighedAuditReport, -} from './scoring'; +} from './utils'; export function reportToMd( report: ScoredReport, diff --git a/packages/utils/src/lib/report-to-stdout.integration.test.ts b/packages/utils/src/lib/reports/report-to-stdout.integration.test.ts similarity index 93% rename from packages/utils/src/lib/report-to-stdout.integration.test.ts rename to packages/utils/src/lib/reports/report-to-stdout.integration.test.ts index 5d7498b85..ff70fac16 100644 --- a/packages/utils/src/lib/report-to-stdout.integration.test.ts +++ b/packages/utils/src/lib/reports/report-to-stdout.integration.test.ts @@ -2,7 +2,7 @@ import { describe } from 'vitest'; import { reportMock } from '@code-pushup/testing-utils'; import { reportToStdout } from './report-to-stdout'; import { scoreReport } from './scoring'; -import { sortReport } from './sort-report'; +import { sortReport } from './sorting'; describe('report-to-stdout', () => { it('should contain all sections when using the fixture report', () => { diff --git a/packages/utils/src/lib/report-to-stdout.ts b/packages/utils/src/lib/reports/report-to-stdout.ts similarity index 96% rename from packages/utils/src/lib/report-to-stdout.ts rename to packages/utils/src/lib/reports/report-to-stdout.ts index 122a3ec5c..864c6f056 100644 --- a/packages/utils/src/lib/report-to-stdout.ts +++ b/packages/utils/src/lib/reports/report-to-stdout.ts @@ -1,8 +1,8 @@ import cliui from '@isaacs/cliui'; import chalk from 'chalk'; import Table from 'cli-table3'; -import { SCORE_COLOR_RANGE } from './constants'; -import { NEW_LINE } from './md'; +import { NEW_LINE, SCORE_COLOR_RANGE } from './constants'; +import { ScoredReport } from './scoring'; import { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, @@ -10,8 +10,7 @@ import { formatReportScore, reportHeadlineText, reportRawOverviewTableHeaders, -} from './report'; -import { ScoredReport } from './scoring'; +} from './utils'; function addLine(line = ''): string { return line + NEW_LINE; diff --git a/packages/utils/src/lib/scoring.ts b/packages/utils/src/lib/reports/scoring.ts similarity index 98% rename from packages/utils/src/lib/scoring.ts rename to packages/utils/src/lib/reports/scoring.ts index ca778d92d..b34df0340 100644 --- a/packages/utils/src/lib/scoring.ts +++ b/packages/utils/src/lib/reports/scoring.ts @@ -7,7 +7,7 @@ import { PluginReport, Report, } from '@code-pushup/models'; -import { deepClone } from './transform'; +import { deepClone } from '../transform'; export type EnrichedAuditReport = AuditReport & { plugin: string }; export type WeighedAuditReport = EnrichedAuditReport & { weight: number }; diff --git a/packages/utils/src/lib/scoring.unit.test.ts b/packages/utils/src/lib/reports/scoring.unit.test.ts similarity index 100% rename from packages/utils/src/lib/scoring.unit.test.ts rename to packages/utils/src/lib/reports/scoring.unit.test.ts diff --git a/packages/utils/src/lib/sort-report.integration.test.ts b/packages/utils/src/lib/reports/sorting.integration.test.ts similarity index 97% rename from packages/utils/src/lib/sort-report.integration.test.ts rename to packages/utils/src/lib/reports/sorting.integration.test.ts index 76eda45be..650cbf5ba 100644 --- a/packages/utils/src/lib/sort-report.integration.test.ts +++ b/packages/utils/src/lib/reports/sorting.integration.test.ts @@ -1,6 +1,6 @@ import { REPORT_MOCK } from '@code-pushup/testing-utils'; import { scoreReport } from './scoring'; -import { sortReport } from './sort-report'; +import { sortReport } from './sorting'; describe('sortReport', () => { it('should sort the audits and audit groups in categories, plugin audits and audit issues', () => { diff --git a/packages/utils/src/lib/sort-report.ts b/packages/utils/src/lib/reports/sorting.ts similarity index 98% rename from packages/utils/src/lib/sort-report.ts rename to packages/utils/src/lib/reports/sorting.ts index a837f7586..81b4e00a9 100644 --- a/packages/utils/src/lib/sort-report.ts +++ b/packages/utils/src/lib/reports/sorting.ts @@ -1,16 +1,16 @@ import { CategoryRef } from '@code-pushup/models'; +import { + EnrichedScoredGroupWithAudits, + ScoredReport, + WeighedAuditReport, +} from './scoring'; import { compareAudits, compareCategoryAudits, compareIssues, getAuditByRef, getGroupWithAudits, -} from './report'; -import { - EnrichedScoredGroupWithAudits, - ScoredReport, - WeighedAuditReport, -} from './scoring'; +} from './utils'; export function sortReport(report: ScoredReport): ScoredReport { const { categories, plugins } = report; diff --git a/packages/utils/src/lib/report.ts b/packages/utils/src/lib/reports/utils.ts similarity index 99% rename from packages/utils/src/lib/report.ts rename to packages/utils/src/lib/reports/utils.ts index 9e858fa0f..b880952cf 100644 --- a/packages/utils/src/lib/report.ts +++ b/packages/utils/src/lib/reports/utils.ts @@ -9,12 +9,12 @@ import { Report, reportSchema, } from '@code-pushup/models'; -import { SCORE_COLOR_RANGE } from './constants'; import { ensureDirectoryExists, readJsonFile, readTextFile, -} from './file-system'; +} from '../file-system'; +import { SCORE_COLOR_RANGE } from './constants'; import { EnrichedAuditReport, EnrichedScoredGroupWithAudits, diff --git a/packages/utils/src/lib/report.unit.test.ts b/packages/utils/src/lib/reports/utils.unit.test.ts similarity index 99% rename from packages/utils/src/lib/report.unit.test.ts rename to packages/utils/src/lib/reports/utils.unit.test.ts index b5a594a71..6e3f2d35f 100644 --- a/packages/utils/src/lib/report.unit.test.ts +++ b/packages/utils/src/lib/reports/utils.unit.test.ts @@ -6,6 +6,11 @@ import { REPORT_MOCK, reportMock, } from '@code-pushup/testing-utils'; +import { + EnrichedAuditReport, + ScoredReport, + WeighedAuditReport, +} from './scoring'; import { calcDuration, compareAudits, @@ -15,12 +20,7 @@ import { countWeightedRefs, getPluginNameFromSlug, loadReport, -} from './report'; -import { - EnrichedAuditReport, - ScoredReport, - WeighedAuditReport, -} from './scoring'; +} from './utils'; describe('calcDuration', () => { it('should calculate the duration correctly if start and stop are given', () => { From c4472dd26e975f8caa4f2a8b08bf4b4113d62209 Mon Sep 17 00:00:00 2001 From: Katerina Pilatova Date: Fri, 12 Jan 2024 14:02:17 +0100 Subject: [PATCH 3/3] chore: improve naming of report generate functions --- packages/core/src/lib/implementation/persist.ts | 8 ++++---- packages/utils/src/index.ts | 4 ++-- ...s.snap => generate-md-report.integration.test.ts.snap} | 0 ...p => generate-stdout-summary.integration.test.ts.snap} | 0 ...ion.test.ts => generate-md-report.integration.test.ts} | 7 +++++-- .../reports/{report-to-md.ts => generate-md-report.ts} | 2 +- ...est.ts => generate-stdout-summary.integration.test.ts} | 6 ++++-- .../{report-to-stdout.ts => generate-stdout-summary.ts} | 2 +- 8 files changed, 17 insertions(+), 12 deletions(-) rename packages/utils/src/lib/reports/__snapshots__/{report-to-md.integration.test.ts.snap => generate-md-report.integration.test.ts.snap} (100%) rename packages/utils/src/lib/reports/__snapshots__/{report-to-stdout.integration.test.ts.snap => generate-stdout-summary.integration.test.ts.snap} (100%) rename packages/utils/src/lib/reports/{report-to-md.integration.test.ts => generate-md-report.integration.test.ts} (83%) rename packages/utils/src/lib/reports/{report-to-md.ts => generate-md-report.ts} (99%) rename packages/utils/src/lib/reports/{report-to-stdout.integration.test.ts => generate-stdout-summary.integration.test.ts} (76%) rename packages/utils/src/lib/reports/{report-to-stdout.ts => generate-stdout-summary.ts} (97%) diff --git a/packages/core/src/lib/implementation/persist.ts b/packages/core/src/lib/implementation/persist.ts index 17be1b5b2..00060ef68 100644 --- a/packages/core/src/lib/implementation/persist.ts +++ b/packages/core/src/lib/implementation/persist.ts @@ -4,10 +4,10 @@ import { join } from 'node:path'; import { PersistConfig, Report } from '@code-pushup/models'; import { MultipleFileResults, + generateMdReport, + generateStdoutSummary, getLatestCommit, logMultipleFileResults, - reportToMd, - reportToStdout, scoreReport, sortReport, } from '@code-pushup/utils'; @@ -31,7 +31,7 @@ export async function persistReport( const { outputDir, filename, format } = options; const sortedScoredReport = sortReport(scoreReport(report)); - console.info(reportToStdout(sortedScoredReport)); + console.info(generateStdoutSummary(sortedScoredReport)); // collect physical format outputs const results: { format: string; content: string }[] = []; @@ -49,7 +49,7 @@ export async function persistReport( results.push({ format: 'md', - content: reportToMd(sortedScoredReport, commitData), + content: generateMdReport(sortedScoredReport, commitData), }); } diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts index 3764ef471..bdc86fe70 100644 --- a/packages/utils/src/index.ts +++ b/packages/utils/src/index.ts @@ -38,8 +38,8 @@ export { } from './lib/guards'; export { logMultipleResults } from './lib/log-results'; export { ProgressBar, getProgressBar } from './lib/progress'; -export { reportToMd } from './lib/reports/report-to-md'; -export { reportToStdout } from './lib/reports/report-to-stdout'; +export { generateMdReport } from './lib/reports/generate-md-report'; +export { generateStdoutSummary } from './lib/reports/generate-stdout-summary'; export { ScoredReport, scoreReport } from './lib/reports/scoring'; export { sortReport } from './lib/reports/sorting'; export { diff --git a/packages/utils/src/lib/reports/__snapshots__/report-to-md.integration.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/generate-md-report.integration.test.ts.snap similarity index 100% rename from packages/utils/src/lib/reports/__snapshots__/report-to-md.integration.test.ts.snap rename to packages/utils/src/lib/reports/__snapshots__/generate-md-report.integration.test.ts.snap diff --git a/packages/utils/src/lib/reports/__snapshots__/report-to-stdout.integration.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/generate-stdout-summary.integration.test.ts.snap similarity index 100% rename from packages/utils/src/lib/reports/__snapshots__/report-to-stdout.integration.test.ts.snap rename to packages/utils/src/lib/reports/__snapshots__/generate-stdout-summary.integration.test.ts.snap diff --git a/packages/utils/src/lib/reports/report-to-md.integration.test.ts b/packages/utils/src/lib/reports/generate-md-report.integration.test.ts similarity index 83% rename from packages/utils/src/lib/reports/report-to-md.integration.test.ts rename to packages/utils/src/lib/reports/generate-md-report.integration.test.ts index 3c91c9c4d..8d58ce703 100644 --- a/packages/utils/src/lib/reports/report-to-md.integration.test.ts +++ b/packages/utils/src/lib/reports/generate-md-report.integration.test.ts @@ -1,6 +1,6 @@ import { describe } from 'vitest'; import { reportMock } from '@code-pushup/testing-utils'; -import { reportToMd } from './report-to-md'; +import { generateMdReport } from './generate-md-report'; import { scoreReport } from './scoring'; import { sortReport } from './sorting'; @@ -22,7 +22,10 @@ describe('report-to-md', () => { author: 'BioPhoton', date: 'Sat Sep 10 12:00:00 2021 +0200', }; - const mdReport = reportToMd(sortReport(scoreReport(reportMock())), commit); + const mdReport = generateMdReport( + sortReport(scoreReport(reportMock())), + commit, + ); expect(mdReport).toContain( `${commit.message} (${commit.hash.slice(0, 7)})`, ); diff --git a/packages/utils/src/lib/reports/report-to-md.ts b/packages/utils/src/lib/reports/generate-md-report.ts similarity index 99% rename from packages/utils/src/lib/reports/report-to-md.ts rename to packages/utils/src/lib/reports/generate-md-report.ts index d3909fab9..c836b3c1c 100644 --- a/packages/utils/src/lib/reports/report-to-md.ts +++ b/packages/utils/src/lib/reports/generate-md-report.ts @@ -36,7 +36,7 @@ import { reportOverviewTableHeaders, } from './utils'; -export function reportToMd( +export function generateMdReport( report: ScoredReport, commitData: CommitData | null, ): string { diff --git a/packages/utils/src/lib/reports/report-to-stdout.integration.test.ts b/packages/utils/src/lib/reports/generate-stdout-summary.integration.test.ts similarity index 76% rename from packages/utils/src/lib/reports/report-to-stdout.integration.test.ts rename to packages/utils/src/lib/reports/generate-stdout-summary.integration.test.ts index ff70fac16..87b6f672b 100644 --- a/packages/utils/src/lib/reports/report-to-stdout.integration.test.ts +++ b/packages/utils/src/lib/reports/generate-stdout-summary.integration.test.ts @@ -1,12 +1,14 @@ import { describe } from 'vitest'; import { reportMock } from '@code-pushup/testing-utils'; -import { reportToStdout } from './report-to-stdout'; +import { generateStdoutSummary } from './generate-stdout-summary'; import { scoreReport } from './scoring'; import { sortReport } from './sorting'; describe('report-to-stdout', () => { it('should contain all sections when using the fixture report', () => { - const logOutput = reportToStdout(sortReport(scoreReport(reportMock()))); + const logOutput = generateStdoutSummary( + sortReport(scoreReport(reportMock())), + ); // logOutput.replace(/\u001B\[\d+m/g, '') removes all color codes from the output // for snapshot readability // eslint-disable-next-line no-control-regex diff --git a/packages/utils/src/lib/reports/report-to-stdout.ts b/packages/utils/src/lib/reports/generate-stdout-summary.ts similarity index 97% rename from packages/utils/src/lib/reports/report-to-stdout.ts rename to packages/utils/src/lib/reports/generate-stdout-summary.ts index 864c6f056..e107a53af 100644 --- a/packages/utils/src/lib/reports/report-to-stdout.ts +++ b/packages/utils/src/lib/reports/generate-stdout-summary.ts @@ -16,7 +16,7 @@ function addLine(line = ''): string { return line + NEW_LINE; } -export function reportToStdout(report: ScoredReport): string { +export function generateStdoutSummary(report: ScoredReport): string { let output = ''; output += addLine(reportToHeaderSection(report));