fix(utils): replace \n to NEW_LINE

code-pushup · Nov 13, 2023 · 733de7b · 733de7b
1 parent 493946b
commit 733de7b
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/packages/core/src/lib/implementation/persist.spec.ts b/packages/core/src/lib/implementation/persist.spec.ts
@@ -12,6 +12,7 @@ import {
 import {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
+  NEW_LINE,
   README_LINK,
 } from '@code-pushup/utils';
 import { mockConsole, unmockConsole } from '../../../test';
@@ -76,7 +77,9 @@ describe('persistReport', () => {
 
   it('should stdout as format by default`', async () => {
     await persistReport(dummyReport, dummyConfig);
-    expect(logs.join('\n')).toContain(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
+    expect(logs.join(NEW_LINE)).toContain(
+      `${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`,
+    );
 
     expect(() => readReport('json')).not.toThrow();
     expect(() => readReport('md')).toThrow('no such file or directory');
@@ -89,7 +92,9 @@ describe('persistReport', () => {
       ...dummyConfig,
       persist,
     });
-    expect(logs.join('\n')).toContain(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
+    expect(logs.join(NEW_LINE)).toContain(
+      `${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`,
+    );
 
     expect(() => readReport('json')).not.toThrow('no such file or directory');
     expect(() => readReport('md')).toThrow('no such file or directory');
@@ -143,7 +148,9 @@ describe('persistReport', () => {
       `${FOOTER_PREFIX} [Code PushUp](${README_LINK})`,
     );
 
-    expect(logs.join('\n')).toContain(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
+    expect(logs.join(NEW_LINE)).toContain(
+      `${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`,
+    );
   });
 
   it('should persist some formats`', async () => {
@@ -162,7 +169,9 @@ describe('persistReport', () => {
       `${FOOTER_PREFIX} [Code PushUp](${README_LINK})`,
     );
 
-    expect(logs.join('\n')).toMatch(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
+    expect(logs.join(NEW_LINE)).toMatch(
+      `${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`,
+    );
   });
 
   // @TODO: should throw PersistDirError

diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -42,3 +42,4 @@ export {
   distinct,
   slugify,
 } from './lib/transformation';
+export { NEW_LINE } from './lib/md';
diff --git a/packages/utils/src/lib/report-to-stdout.spec.ts b/packages/utils/src/lib/report-to-stdout.spec.ts
@@ -6,6 +6,8 @@ import { scoreReport } from './scoring';
 describe('report-to-stdout', () => {
   it('should contain all sections when using the fixture report', () => {
     const logOutput = reportToStdout(scoreReport(report()));
+    // logOutput.replace(/\u001B\[\d+m/g, '') removes all color codes from the output
+    // for snapshot readability
     // eslint-disable-next-line no-control-regex
     expect(logOutput.replace(/\u001B\[\d+m/g, '')).toMatchSnapshot();
   });

diff --git a/packages/utils/src/lib/report-to-stdout.ts b/packages/utils/src/lib/report-to-stdout.ts
@@ -1,6 +1,7 @@
 import chalk from 'chalk';
 import Table from 'cli-table3';
 import cliui from 'cliui';
+import { NEW_LINE } from './md';
 import {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
@@ -12,7 +13,7 @@ import {
 import { ScoredReport } from './scoring';
 
 function addLine(line = ''): string {
-  return line + '\n';
+  return line + NEW_LINE;
 }
 
 export function reportToStdout(report: ScoredReport): string {