Merge pull request #5 from rambler-digital-solutions/exclude

feat: support option to exclude licenses by the list

README.md

@@ -32,6 +32,7 @@ licenselint --help
     --summary       Output a summary of the license usage
     --deny          Fail on an occurrence of the licenses of the deny list
     --allow         Fail on an occurrence of the licenses not in the allow list
+    --exclude       Exclude modules which licenses are in the list
     --extends       Use custom configuration file
 
   Examples

src/cli.ts

@@ -20,6 +20,7 @@ const cli = meow<any>(
     --summary       Output a summary of the license usage
     --deny          Fail on an occurrence of the licenses of the deny list
     --allow         Fail on an occurrence of the licenses not in the allow list
+    --exclude       Exclude modules which licenses are in the list
     --extends       Use custom configuration file
 
   Examples
@@ -54,6 +55,11 @@ const cli = meow<any>(
         type: 'string',
         default: defaultArray,
         isMultiple: true
+      },
+      exclude: {
+        type: 'string',
+        default: defaultArray,
+        isMultiple: true
       }
     }
   }

src/lint.test.ts

@@ -36,3 +36,12 @@ test('lint licenses with allow list', async () => {
   expect(errors.map((result) => result.licenses)).not.toContain('MIT')
   expect(errors.map((result) => result.licenses)).not.toContain('ISC')
 })
+
+test('lint licenses with exclude list', async () => {
+  const options = {
+    production: true,
+    exclude: ['Apache-2.0']
+  }
+  const results = await lint(entry, options)
+  expect(results.map((result) => result.licenses)).not.toContain('Apache-2.0')
+})

src/lint.ts

@@ -15,12 +15,20 @@ export const lint = (
   options: Options
 ): Promise<LicenseResult[]> =>
   new Promise<LicenseResult[]>((resolve, reject) => {
-    const {production, development, deny = [], allow = []} = options
+    const {
+      production,
+      development,
+      deny = [],
+      allow = [],
+      exclude = []
+    } = options
 
     const checkerOptions: InitOpts = {
       start: entry,
       production,
-      development
+      development,
+      // NOTE fix wrong `exclude` type
+      exclude: exclude.toString() as unknown as string[]
     }
 
     licenseChecker.init(checkerOptions, (error: Error, modulesInfo) => {

src/options.ts

@@ -7,14 +7,16 @@ export interface Options {
   summary?: boolean
   deny?: string[]
   allow?: string[]
+  exclude?: string[]
 }
 
 export const defaultOptions: Partial<Options> = {
   production: false,
   development: false,
   summary: false,
   deny: [],
-  allow: []
+  allow: [],
+  exclude: []
 }
 
 const defaultOptionsFileName = '.licenserc.json'