feat: include private self dependency

mjeanroy · mjeanroy · commit 1401f5d7d2aa · 2024-06-21T14:18:39.000+02:00
diff --git a/src/dependency.js b/src/dependency.js
@@ -34,9 +34,12 @@ export class Dependency {
    * Create new dependency from package description.
    *
    * @param {Object} pkg Package description.
+   * @param {boolean} self If the package is the "self" package.
    * @constructor
    */
-  constructor(pkg) {
+  constructor(pkg, self) {
+    this.self = self || false;
+
     this.name = pkg.name || null;
     this.maintainers = pkg.maintainers || [];
     this.version = pkg.version || null;
diff --git a/src/license-plugin.js b/src/license-plugin.js
@@ -162,7 +162,8 @@ class LicensePlugin {
     this.debug(`iterative over directory tree, starting with: ${dir}`);
 
     while (dir) {
-      if (!includeSelf && dir === this._cwd) {
+      const isSelf = dir === this._cwd;
+      if (isSelf && !includeSelf) {
         // No need to scan "self" if it's not explicitly allowed.
         break;
       }
@@ -172,7 +173,7 @@ class LicensePlugin {
         pkg = this._cache.get(dir);
         if (pkg) {
           this.debug(`found package.json in cache (package: ${pkg.name})`);
-          this.addDependency(pkg);
+          this.addDependency(pkg, isSelf);
         }
 
         break;
@@ -215,14 +216,14 @@ class LicensePlugin {
           }
 
           // Add the new dependency to the set of third-party dependencies.
-          this.addDependency(pkg);
+          this.addDependency(pkg, isSelf);
 
           // We can stop now.
           break;
         }
       }
 
-      if (dir === this._cwd) {
+      if (isSelf) {
         // If "self" has been scanned, no need to go up in the directory tree.
         break;
       }
@@ -295,9 +296,10 @@ class LicensePlugin {
    * Add new dependency to the bundle descriptor.
    *
    * @param {Object} pkg Dependency package information.
+   * @param {boolean} self If the package is the "self" package.
    * @return {void}
    */
-  addDependency(pkg) {
+  addDependency(pkg, self) {
     const name = pkg.name || '';
     if (!name) {
       this.warn('Trying to add dependency without any name, skipping it.');
@@ -307,7 +309,7 @@ class LicensePlugin {
     const version = pkg.version || '';
     const key = this._options.thirdParty?.multipleVersions ? `${name}@${version}` : name;
     if (!this._dependencies.has(key)) {
-      this._dependencies.set(key, new Dependency(pkg));
+      this._dependencies.set(key, new Dependency(pkg, self));
     }
   }
 
@@ -325,9 +327,18 @@ class LicensePlugin {
     }
 
     const includePrivate = thirdParty.includePrivate || false;
-    const outputDependencies = [...this._dependencies.values()].filter((dependency) => (
-      includePrivate || !dependency.private
-    ));
+    const includeSelf = thirdParty.includeSelf || false;
+    const outputDependencies = [...this._dependencies.values()].filter((dependency) => {
+      if (dependency.self && includeSelf) {
+        return true;
+      }
+
+      if (!dependency.private) {
+        return true;
+      }
+
+      return includePrivate;
+    });
 
     if (_.isFunction(thirdParty)) {
       thirdParty(outputDependencies);
@@ -459,7 +470,7 @@ class LicensePlugin {
   /**
    * Scan for dependency violations and print a warning if some violations are found.
    *
-   * @param {Array<Object>} outputDependencies The dependencies to scan.
+   * @param {Array<Dependency>} outputDependencies The dependencies to scan.
    * @param {string} allow The allowed licenses as a SPDX pattern.
    * @return {void}
    */
@@ -472,11 +483,18 @@ class LicensePlugin {
   /**
    * Scan dependency for a dependency violation.
    *
-   * @param {Object} dependency The dependency to scan.
+   * @param {Dependency} dependency The dependency to scan.
    * @param {string|function|object} allow The allowed licenses as a SPDX pattern, or a validator function.
    * @return {void}
    */
   _scanLicenseViolation(dependency, allow) {
+    if (dependency.self) {
+      // Do not validate license for the "self" package.
+      // It's likely this package will use a private/proprietary license, and we only want to detect
+      // violations for third party dependencies.
+      return;
+    }
+
     const testFn = _.isString(allow) || _.isFunction(allow) ? allow : allow.test;
     const isValid = _.isFunction(testFn) ? testFn(dependency) : licenseValidator.isValid(dependency, testFn);
     if (!isValid) {
diff --git a/test/dependency.spec.js b/test/dependency.spec.js
@@ -27,6 +27,7 @@ import { join } from './utils/join';
 
 describe('Dependency', () => {
   it('should extract package fields', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -52,9 +53,10 @@ describe('Dependency', () => {
       ],
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency).toEqual({
+      self: false,
       name: 'foo',
       version: '1.0.0',
       license: 'MIT',
@@ -89,6 +91,7 @@ describe('Dependency', () => {
   });
 
   it('should parse author field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -97,7 +100,7 @@ describe('Dependency', () => {
       author: 'Mickael Jeanroy <mickael.jeanroy@gmail.com> (https://mjeanroy.com)',
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.author).toEqual({
       name: 'Mickael Jeanroy',
@@ -107,6 +110,7 @@ describe('Dependency', () => {
   });
 
   it('should parse contributors field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -117,7 +121,7 @@ describe('Dependency', () => {
       ],
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.contributors.length).toBe(1);
     expect(dependency.contributors[0]).toEqual({
@@ -128,6 +132,7 @@ describe('Dependency', () => {
   });
 
   it('should parse deprecated licenses field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -138,20 +143,21 @@ describe('Dependency', () => {
       ],
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.licenses).not.toBeDefined();
     expect(dependency.license).toBe('(MIT OR Apache 2.0)');
   });
 
   it('should format dependency with name, version, and license fields', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
       license: 'MIT',
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -162,14 +168,15 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with optional description fied', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
       license: 'MIT',
       description: 'Desc',
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -181,6 +188,7 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with optional author field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -191,7 +199,7 @@ describe('Dependency', () => {
       },
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -203,6 +211,7 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with optional repository field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -213,7 +222,7 @@ describe('Dependency', () => {
       },
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -225,14 +234,15 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with optional homepage field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
       license: 'MIT',
       homepage: 'https://github.com/mjeanroy',
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -244,6 +254,7 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with optional contributors field', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -254,7 +265,7 @@ describe('Dependency', () => {
       ],
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -268,6 +279,7 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with all optional fields', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -282,7 +294,7 @@ describe('Dependency', () => {
       ],
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -300,6 +312,7 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with license text', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -326,7 +339,7 @@ describe('Dependency', () => {
       ],
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
@@ -348,6 +361,7 @@ describe('Dependency', () => {
   });
 
   it('should format dependency with notice text', () => {
+    const self = false;
     const pkg = {
       name: 'foo',
       version: '1.0.0',
@@ -358,7 +372,7 @@ describe('Dependency', () => {
       homepage: 'https://github.com/mjeanroy',
     };
 
-    const dependency = new Dependency(pkg);
+    const dependency = new Dependency(pkg, self);
 
     expect(dependency.text()).toEqual(join([
       `Name: ${pkg.name}`,
diff --git a/test/license-plugin.spec.js b/test/license-plugin.spec.js
