chore(utils): extract constants, add unit tests

Author: Tlacenka

packages/utils/src/index.ts

@@ -52,16 +52,18 @@ export {
 export { logMultipleResults } from './lib/log-results';
 export { link } from './lib/logging';
 export { ProgressBar, getProgressBar } from './lib/progress';
-export { TERMINAL_WIDTH } from './lib/reports/constants';
+export {
+  CODE_PUSHUP_DOMAIN,
+  FOOTER_PREFIX,
+  README_LINK,
+  TERMINAL_WIDTH,
+} from './lib/reports/constants';
 export { generateMdReport } from './lib/reports/generate-md-report';
 export { generateStdoutSummary } from './lib/reports/generate-stdout-summary';
 export { scoreReport } from './lib/reports/scoring';
 export { sortReport } from './lib/reports/sorting';
 export { ScoredReport } from './lib/reports/types';
 export {
-  CODE_PUSHUP_DOMAIN,
-  FOOTER_PREFIX,
-  README_LINK,
   calcDuration,
   compareIssueSeverity,
   loadReport,

packages/utils/src/lib/reports/constants.ts

@@ -8,3 +8,39 @@ export const SCORE_COLOR_RANGE = {
   YELLOW_MIN: 0.5,
 };
 /* eslint-enable no-magic-numbers */
+
+export const FOOTER_PREFIX = 'Made with ❤ by'; // replace ❤️ with ❤, because of ❤️ has output issues
+export const CODE_PUSHUP_DOMAIN = 'code-pushup.dev';
+export const README_LINK =
+  'https://github.com/flowup/quality-metrics-cli#readme';
+export const reportHeadlineText = 'Code PushUp Report';
+export const reportOverviewTableHeaders = [
+  '🏷 Category',
+  '⭐ Score',
+  '🛡 Audits',
+];
+export const reportRawOverviewTableHeaders = ['Category', 'Score', 'Audits'];
+export const reportMetaTableHeaders: string[] = [
+  'Commit',
+  'Version',
+  'Duration',
+  'Plugins',
+  'Categories',
+  'Audits',
+];
+
+export const pluginMetaTableHeaders: string[] = [
+  'Plugin',
+  'Audits',
+  'Version',
+  'Duration',
+];
+
+// details headers
+
+export const detailsTableHeaders: string[] = [
+  'Severity',
+  'Message',
+  'Source file',
+  'Line(s)',
+];

packages/utils/src/lib/reports/generate-md-report.ts

@@ -1,7 +1,16 @@
 import { AuditReport, CategoryConfig, Issue } from '@code-pushup/models';
 import { formatDate, formatDuration, slugify } from '../formatting';
 import { CommitData } from '../git';
-import { NEW_LINE } from './constants';
+import {
+  FOOTER_PREFIX,
+  NEW_LINE,
+  README_LINK,
+  detailsTableHeaders,
+  pluginMetaTableHeaders,
+  reportHeadlineText,
+  reportMetaTableHeaders,
+  reportOverviewTableHeaders,
+} from './constants';
 import {
   details,
   h2,
@@ -15,21 +24,14 @@ import {
 } from './md';
 import { ScoredGroup, ScoredReport } from './types';
 import {
-  FOOTER_PREFIX,
-  README_LINK,
   countCategoryAudits,
-  detailsTableHeaders,
   formatReportScore,
   getPluginNameFromSlug,
   getRoundScoreMarker,
   getSeverityIcon,
   getSortableAuditByRef,
   getSortableGroupByRef,
   getSquaredScoreMarker,
-  pluginMetaTableHeaders,
-  reportHeadlineText,
-  reportMetaTableHeaders,
-  reportOverviewTableHeaders,
 } from './utils';
 
 export function generateMdReport(

packages/utils/src/lib/reports/generate-stdout-summary.ts

@@ -1,16 +1,17 @@
 import cliui from '@isaacs/cliui';
 import chalk from 'chalk';
 import CliTable3 from 'cli-table3';
-import { NEW_LINE, SCORE_COLOR_RANGE, TERMINAL_WIDTH } from './constants';
-import { ScoredReport } from './types';
 import {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
-  countCategoryAudits,
-  formatReportScore,
+  NEW_LINE,
+  SCORE_COLOR_RANGE,
+  TERMINAL_WIDTH,
   reportHeadlineText,
   reportRawOverviewTableHeaders,
-} from './utils';
+} from './constants';
+import { ScoredReport } from './types';
+import { countCategoryAudits, formatReportScore } from './utils';
 
 function addLine(line = ''): string {
   return line + NEW_LINE;

packages/utils/src/lib/reports/utils.ts

@@ -18,42 +18,6 @@ import {
 import { SCORE_COLOR_RANGE } from './constants';
 import { ScoredReport, SortableAuditReport, SortableGroup } from './types';
 
-export const FOOTER_PREFIX = 'Made with ❤ by'; // replace ❤️ with ❤, because of ❤️ has output issues
-export const CODE_PUSHUP_DOMAIN = 'code-pushup.dev';
-export const README_LINK =
-  'https://github.com/flowup/quality-metrics-cli#readme';
-export const reportHeadlineText = 'Code PushUp Report';
-export const reportOverviewTableHeaders = [
-  '🏷 Category',
-  '⭐ Score',
-  '🛡 Audits',
-];
-export const reportRawOverviewTableHeaders = ['Category', 'Score', 'Audits'];
-export const reportMetaTableHeaders: string[] = [
-  'Commit',
-  'Version',
-  'Duration',
-  'Plugins',
-  'Categories',
-  'Audits',
-];
-
-export const pluginMetaTableHeaders: string[] = [
-  'Plugin',
-  'Audits',
-  'Version',
-  'Duration',
-];
-
-// details headers
-
-export const detailsTableHeaders: string[] = [
-  'Severity',
-  'Message',
-  'Source file',
-  'Line(s)',
-];
-
 export function formatReportScore(score: number): string {
   return Math.round(score * 100).toString();
 }