Merge pull request #6 from snyk-tech-services/feat/introduce-yargs-an…

…d-json

feat: json report + cli args

package.json

@@ -37,12 +37,14 @@
     "axios": "^0.19.2",
     "cheerio": "1.0.0-rc.3",
     "debug": "4.1.1",
+    "handlebars": "4.7.6",
     "lodash": "4.17.20",
     "node-fetch": "2.6.0",
     "snyk-api-ts-client": "1.5.0",
     "snyk-config": "^3.0.0",
     "source-map-support": "^0.5.16",
-    "tslib": "2.0.1"
+    "tslib": "2.0.1",
+    "yargs": "16.0.2"
   },
   "devDependencies": {
     "@types/jest": "26.0.13",

src/cmds/json.ts

@@ -0,0 +1,25 @@
+import { getApiToken } from '../lib/get-api-token';
+import { generateOrgLicensesReport } from '../lib/generate-org-license-report';
+
+export const command = 'json';
+export const desc = 'Generate org licenses & dependencies data in JSON format';
+export const builder = {
+  orgPublicId: {
+    required: true,
+    default: undefined,
+  },
+};
+export const aliases = ['j'];
+
+export async function handler(argv: { orgPublicId: string }) {
+  try {
+    // check SNYK_TOKEN is set as the sdk uses it
+    getApiToken();
+    // TODO: define and pass options to help filter the response
+    // based on filters available in API
+    const data = await generateOrgLicensesReport(argv.orgPublicId, {});
+    console.log(JSON.stringify(data));
+  } catch (e) {
+    console.error(e);
+  }
+}

src/index.ts

@@ -1,10 +1,8 @@
-import { generateOrgLicensesReport, getApiToken } from './lib';
+#!/usr/bin/env node
+import * as yargs from 'yargs';
 
-export async function main() {
-  // check SNYK_TOKEN is set as the sdk uses it
-  getApiToken();
-  // check CLI properties passed in
-  const orgPublicId = 'blah';
-  const options = {};
-  await generateOrgLicensesReport(orgPublicId, options);
-}
+yargs
+  .commandDir('cmds')
+  .demandCommand()
+  .help()
+  .argv

src/lib/index.ts → src/lib/generate-org-license-report.ts

@@ -5,7 +5,7 @@ export * from './license-text';
 export * from './get-api-token';
 import { getLicenseDataForOrg, getDependenciesDataForOrg } from './api/org';
 import { fetchSpdxLicenseTextAndUrl, fetchNonSpdxLicenseTextAndUrl } from './license-text';
-import { LicenseReportDataEntry } from './types';
+import { LicenseReportDataEntry, EnrichedDependency, Dependency } from './types';
 
 const debug = debugLib('generateOrgLicensesReport');
 
@@ -75,13 +75,6 @@ export async function generateLicenseData(
   }
 }
 
-interface Dependency {
-  id: string; // example: pako@1.0.11
-  name: string;
-  version: string;
-  packageManager: string;
-}
-interface EnrichedDependency extends Dependency {}
 
 function enrichDependencies(
   dependencies: Dependency[],

src/lib/types.ts

@@ -1,3 +1,12 @@
+export interface Dependency {
+  id: string; // example: pako@1.0.11
+  name: string;
+  version: string;
+  packageManager: string;
+}
+//TODO: finish the type
+export interface EnrichedDependency extends Dependency {}
+
 export interface LicenseReportDataEntry {
   // TODO: what if it is a dual license?
   /**

test/lib/fecth-non-spdx-license-text.test.ts

@@ -1,7 +1,9 @@
-import { fetchNonSpdxLicenseTextAndUrl } from '../../src/lib';
+import { fetchNonSpdxLicenseTextAndUrl } from '../../src/lib/license-text';
 
 test('ASPSecurityKit-Khosla-Tech license fetched locally as expected', async () => {
-  const licenseText = await fetchNonSpdxLicenseTextAndUrl('ASPSecurityKit-Khosla-Tech');
+  const licenseText = await fetchNonSpdxLicenseTextAndUrl(
+    'ASPSecurityKit-Khosla-Tech',
+  );
   expect(licenseText).toMatchSnapshot();
 });
 

test/lib/fetch-spdx-license.test.ts

@@ -1,4 +1,4 @@
-import { fetchSpdxLicenseTextAndUrl } from '../../src/lib';
+import { fetchSpdxLicenseTextAndUrl } from '../../src/lib/generate-org-license-report';
 
 test('AFL-1.1 license is as expected', async () => {
   const licenseText = await fetchSpdxLicenseTextAndUrl('AFL-1.1');

test/lib/generate-license-report-data.test.ts

@@ -1,4 +1,4 @@
-import { generateLicenseData } from '../../src/lib';
+import { generateLicenseData } from '../../src/lib/generate-org-license-report';
 
 describe('Get org licenses', () => {
   const OLD_ENV = process.env;

tsconfig.json

@@ -6,5 +6,5 @@
     "sourceMap": true,
     "declaration": true
   },
-  "include": ["./src/lib/**/*"]
+  "include": ["./src/lib/**/*", "./src/**/*", "./src/cmds"]
 }