Allow CSV export option

Author: sparshithNR

bin/supported

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 'use strict';
 const ora = require('ora');
+const { writeFileSync } = require('fs');
 const { displayResult } = require('../lib/output/cli-output');
+const { writeToCsv } = require('../lib/output/csv-output');
 
 (async function main(cli) {
   if (cli.input.length === 0) {
@@ -31,6 +33,11 @@ const { displayResult } = require('../lib/output/cli-output');
           2,
         ),
       );
+    } else if(cli.flags.csv && result) {
+      let fileName = `${result.projectName}-support-audit.csv`;
+      let filePath = `${projectPath}/${fileName}`;
+      writeFileSync(filePath, writeToCsv(result), 'utf-8' );
+      console.log(`Report created at ${filePath}`);
     } else {
       displayResult(result, cli.flags);
     }

lib/help.js

@@ -9,9 +9,10 @@ module.exports = chalk`
   {bold Usage}
     {gray $} {cyan supported <input-file>}
   {bold Options}
-    {cyan --help, -h} this output
-    {cyan --json, -j} output as json
-    {cyan --verbose, -v} outputs detailed report of support audit
+    {cyan --help, -h}     this output
+    {cyan --json, -j}     output as json
+    {cyan --verbose, -v}  outputs detailed report of support audit
+    {cyan --csv}          outputs csv file in the project path
   {bold Examples}
     {gray $} {cyan  supported ./path/to/project/}
 `;

lib/output/cli-output.js

@@ -225,18 +225,28 @@ function getViolationsDetail(supportChecks) {
   };
 }
 
-function displayResult(supportResult, flags, message) {
-  const title = supportResult.projectName;
+function generateMessages(supportResult) {
   const isInSupportWindow = supportResult.isInSupportWindow;
-  const currentPolicy = message ? message : DEFAULT_SUPPORT_MESSAGE();
   let voilationDetails = getViolationsDetail(supportResult.supportChecks);
   let { violationCount, policyCount } = getPolicyViolationData(voilationDetails.violations);
+  return {
+    violationMessages: !isInSupportWindow ? getViolations(voilationDetails) : '',
+    violationCount,
+    policyCount
+  }
+}
+
+function displayResult(supportResult, flags, policyDetails) {
+  const title = supportResult.projectName;
+  const isInSupportWindow = supportResult.isInSupportWindow;
+  const currentPolicy = policyDetails ? policyDetails : DEFAULT_SUPPORT_MESSAGE();
   let body = getBodyContent(supportResult.supportChecks);
+  let { violationMessages, violationCount, policyCount } = generateMessages(supportResult);
   console.log(
     makeConsoleReport({
       title,
       isInSupportWindow,
-      violationMessages: !isInSupportWindow ? getViolations(voilationDetails) : '',
+      violationMessages,
       violationCount,
       policyCount,
       body: flags.verbose ? body : '',
@@ -250,4 +260,5 @@ module.exports = {
   getBodyContent,
   generateViolationMessage,
   getViolations,
+  generateMessages,
 };

lib/output/csv-output.js

@@ -0,0 +1,46 @@
+'use strict';
+
+const { Parser } = require('json2csv');
+const stripAnsi = require('strip-ansi');
+const { generateMessages, generateViolationMessage } =  require('./cli-output');
+const { LOG_TITLE, DEFAULT_SUPPORT_MESSAGE } = require('./messages');
+const MILLSINQUARTER = 91 * 24 * 60 * 60 * 1000;
+
+module.exports = {
+  writeToCsv
+}
+function writeToCsv(result, policyDetails) {
+  const fields = [{
+      label: 'Name',
+      value: 'name'
+    },{
+      label: 'Supported',
+      value: 'isSupported'
+    }, {
+      label: 'Violation Type',
+      value: 'type',
+      default: 'up-to-date'
+    }, {
+      label: 'How old?',
+      value: (row) => row['duration'] ? `${Math.ceil(row['duration']/MILLSINQUARTER)}qtrs` : '-',
+    }, {
+      label: 'Resolved Version',
+      value: 'resolvedVersion'
+    }, {
+      label: 'Latest Version',
+      value: 'latestVersion'
+    }
+  ];
+
+  const json2csvParser = new Parser({ fields });
+  const csv = json2csvParser.parse(result.supportChecks);
+  const { violationMessages } = generateMessages(result);
+  const title = LOG_TITLE(result.isInSupportWindow);
+  const fileContent = `${stripAnsi(title)}
+  ${!result.isInSupportWindow ? stripAnsi(generateViolationMessage(violationMessages)) : ''}
+  ${policyDetails ? stripAnsi(policyDetails) : stripAnsi(DEFAULT_SUPPORT_MESSAGE())}
+
+  ${csv}
+  `
+  return fileContent;
+}

package.json

@@ -39,13 +39,13 @@
   },
   "dependencies": {
     "@yarnpkg/lockfile": "^1.1.0",
-    "boxen": "^5.0.0",
     "camelcase-keys": "^6.2.2",
     "chalk": "^4.1.0",
     "cli-table": "^0.3.4",
     "debug": "^4.3.1",
     "execa": "^5.0.0",
     "ini": "^1.3.7",
+    "json2csv": "^5.0.6",
     "meow": "^8.0.0",
     "minipass-fetch": "^1.3.2",
     "moment": "^2.29.1",
@@ -57,9 +57,9 @@
     "parse-package-name": "^0.1.0",
     "promise.allsettled": "^1.0.4",
     "semver": "^7.3.4",
+    "strip-ansi": "^6.0.0",
     "term-size": "^2.2.1",
-    "terminal-link": "^2.1.1",
-    "wordwrap": "^1.0.0"
+    "terminal-link": "^2.1.1"
   },
   "files": [
     "lib",

tests/cli-test.js

@@ -2,6 +2,7 @@
 
 const { expect } = require('chai');
 const execa = require('execa');
+const fs = require('fs');
 const { getBinPath } = require('get-bin-path');
 const registries = require('./registries');
 
@@ -87,6 +88,27 @@ describe('CLI', function () {
     });
   });
 
+  describe('--csv', function () {
+    afterEach(() => {
+      let filePath = `${__dirname}/fixtures/unsupported-project/example-support-audit.csv`;
+      if (fs.existsSync(filePath))
+      fs.unlinkSync(filePath);
+    });
+    it('works against a unsupported project', async function () {
+      const child = await execa(
+        await getBinPath(),
+        [`${__dirname}/fixtures/unsupported-project`, '--csv'],
+        {
+          shell: true,
+          reject: false,
+        },
+      );
+      expect(child.exitCode).to.eql(1);
+      expect(child.stderr).to.eql('- working');
+      expect(child.stdout).to.includes(`Report created at ${__dirname}/fixtures/unsupported-project`);
+    });
+  });
+
   describe('--json', function () {
     it('works against a fully supported project', async function () {
       const child = await execa(

tests/csv-output-test.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const { expect } = require('chai');
+const { writeToCsv } = require('../lib/output/csv-output');
+
+describe('csv', function () {
+  it('supported project', () => {
+    let supportResult = {
+      projectName: 'example',
+      isInSupportWindow: true,
+      supportChecks: [
+        {
+          isSupported: true,
+          latestVersion: '4.8.5',
+          name: 'rsvp',
+          resolvedVersion: '4.8.5',
+        },
+        {
+          isSupported: true,
+          name: 'node',
+          resolvedVersion: '15.3.0',
+          latestVersion: '>=14.*',
+          message: '',
+        }
+      ],
+    }
+    let result = writeToCsv(supportResult);
+    expect(result).to.includes(`  ✓ Congrats!
+  Your project is using only supported versions of libraries. No action is required.`);
+  });
+  it('unsupported project', () => {
+    let supportResult = {
+      projectName: 'example',
+      isInSupportWindow: false,
+      supportChecks: [
+        {
+          isSupported: false,
+          latestVersion: '4.8.5',
+          name: 'rsvp',
+          resolvedVersion: '4.5.5',
+        },
+        {
+          isSupported: true,
+          name: 'node',
+          resolvedVersion: '15.3.0',
+          latestVersion: '>=14.*',
+          message: '',
+        }
+      ],
+    }
+    let result = writeToCsv(supportResult);
+    expect(result).to.includes(`Support Policy Problem Detected!
+  Please upgrade your dependencies!
+  Your project is not within the support policy window because of outdated dependencies.`);
+  });
+});