Merge pull request #1048 from 06kellyjac/li_cli_offline

feat(experimental): fall back to local spdx data and filter deprecated

Author: JamieSlome

experimental/li-cli/package.json

@@ -10,7 +10,8 @@
     "start": "ts-node src/cli.ts",
     "build": "rimraf dist && tsc --project tsconfig.publish.json && tsc-alias && chmod u+x ./dist/cli.js",
     "type-check": "tsc --noEmit",
-    "test": "jest --forceExit --detectOpenHandles"
+    "test": "jest --forceExit --detectOpenHandles",
+    "update-local-licenses": "wget https://spdx.org/licenses/licenses.json -O src/lib/licenses.json"
   },
   "dependencies": {
     "@inquirer/prompts": "^7.5.3",

experimental/li-cli/src/cli.ts

@@ -2,7 +2,7 @@
 
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import addLicenseCMD from './cmds/add-license';
+import addLicenseCMD from '@/cmds/add-license';
 import process from 'node:process';
 
 yargs(hideBin(process.argv))
@@ -24,12 +24,19 @@ yargs(hideBin(process.argv))
           default: false,
           describe: 'require successful collection of info from Choose A License',
         })
-        .demandOption('li-url'),
+        .option('allow-deprecated', {
+          type: 'boolean',
+          default: false,
+          describe: 'allow for adding depricated licenses',
+        })
+        .demandOption('li-url')
+        .strict(),
     async (argv) => {
       try {
         await addLicenseCMD(argv['li-url'], {
           spdxID: argv.SPDXID,
           requireCal: argv['require-cal'],
+          allowDeprecated: argv['allow-deprecated'],
         });
       } catch (e) {
         process.exit(1);

experimental/li-cli/src/cmds/add-license.ts

@@ -1,8 +1,8 @@
 import { setTimeout } from 'node:timers/promises';
 import { search } from '@inquirer/prompts';
-import { getLicenseList, LicensesMap } from '../lib/spdx';
-import { CalInfo, InventoryLicense, pushLicense } from '../lib/inventory';
-import { getCALData } from '../lib/chooseALicense';
+import { getLicenseList, LicensesMap } from '@/lib/spdx';
+import { CalInfo, InventoryLicense, pushLicense } from '@/lib/inventory';
+import { getCALData } from '@/lib/chooseALicense';
 
 // const answer = await input({ message: 'Enter your name' });
 
@@ -14,6 +14,7 @@ type Option = {
 type AddLicenseCMDOptions = {
   spdxID?: string;
   requireCal?: boolean;
+  allowDeprecated?: boolean;
 };
 
 async function promptForSPDXID(licenseList: LicensesMap): Promise<string> {
@@ -40,7 +41,7 @@ async function promptForSPDXID(licenseList: LicensesMap): Promise<string> {
 // TODO: add multiple licenses at the same time
 async function addLicenseCMD(liURL: string, options?: AddLicenseCMDOptions) {
   console.info('fetching license list from `spdx.org`');
-  const licenseList = await getLicenseList();
+  const licenseList = await getLicenseList(options?.allowDeprecated ?? false);
   console.info('done fetching');
 
   const selectedLicenseID = options?.spdxID ?? (await promptForSPDXID(licenseList));
@@ -58,9 +59,13 @@ async function addLicenseCMD(liURL: string, options?: AddLicenseCMDOptions) {
     const cal = await getCALData(selectedLicense.licenseId.toLowerCase());
     chooseALicenseInfo = cal;
   } catch (e) {
-    console.log('failed to get info from Choose A License');
+    const errMsg = 'failed to get info from Choose A License';
+
     if (options?.requireCal) {
+      console.error(errMsg);
       throw new Error('forced the need for CAL data');
+    } else {
+      console.warn(errMsg + ', continuing...');
     }
   }
 

experimental/li-cli/src/lib/chooseALicense.ts

@@ -8,11 +8,11 @@ const chooseALicenseSchema = z.object({
   permissions: z.string().array(),
 });
 
-type ChooseALicenseData = z.infer<typeof chooseALicenseSchema>;
+export type ChooseALicenseData = z.infer<typeof chooseALicenseSchema>;
 
 function extractPreamble(text: string): string {
   const lines = text.split('\n'); // Split into lines
-  let result: string[] = [];
+  const result: string[] = [];
   let insideBlock = false;
 
   for (const line of lines) {