SCP-140 Adds UX into copyleft policy report

scanoss · Feb 26, 2024 · 9a5bed2 · 9a5bed2
1 parent e15c5a9
commit 9a5bed2
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 12 deletions.
diff --git a/__tests__/result-service.test.ts b/__tests__/result-service.test.ts
@@ -66,13 +66,9 @@ describe('Test components service', () => {
   it(`test c`, () => {
     const scannerResults = JSON.parse(t.content) as ScannerResults;
     const components = getComponents(scannerResults);
-    const util = require('util');
-    // console.log(util.inspect(compoments, {showHidden: false, depth: null, colors: true}))
 
     const componentsWithCopyleft = components.filter(component =>
       component.licenses.some(license => !!license.copyleft)
     );
-
-    console.log(util.inspect(componentsWithCopyleft, { showHidden: false, depth: null, colors: true }));
   });
 });
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/policies/copyleft-policy-check.ts b/src/policies/copyleft-policy-check.ts
@@ -2,7 +2,7 @@ import { ScannerResults } from '../services/result.interfaces';
 import { CHECK_NAME } from '../app.config';
 import { PolicyCheck } from './policy-check';
 import { Component, getComponents, getLicenses } from '../services/result.service';
-import { generateTable } from 'src/utils/markdown.util';
+import { generateTable } from '../utils/markdown.utils';
 
 export class CopyleftPolicyCheck extends PolicyCheck {
   constructor() {
@@ -30,8 +30,8 @@ export class CopyleftPolicyCheck extends PolicyCheck {
 
   private getSummary(components: Component[]): string {
     return components.length === 0
-      ? '### :white_check_mark: Policy Pass \n ' + '#### ' + 'Not copyleft components were found'
-      : '### :x: Policy Fail \n' + '#### ' + components.length + ' component(s) with copyleft licenses were found';
+      ? '### :white_check_mark: Policy Pass \n #### Not copyleft components were found'
+      : `### :x: Policy Fail \n #### ${components.length} component(s) with copyleft licenses were found. \n See details for more information.`;
   }
 
   private getDetails(components: Component[]): string {

diff --git a/src/utils/markdown.util.ts → src/utils/markdown.utils.ts b/src/utils/markdown.util.ts → src/utils/markdown.utils.ts