Add ignore dependencies option in config file

lib/cli.js

@@ -19,6 +19,7 @@ async function main(cli, { policyDetails, setupProjectFn }) {
     cli.showHelp(1);
   } else {
     const currentDate = processDate(cli.flags.currentDate) || undefined;
+    let ignoredDependencies = cli.flags.ignoredDependencies || [];
 
     let policies = {
       primary: DEFAULT_PRIMARY_POLICY,
@@ -28,6 +29,7 @@ async function main(cli, { policyDetails, setupProjectFn }) {
       let configuredPolicies = JSON.parse(configFile);
       if (configuredPolicies.primary) {
         policies.primary = configuredPolicies.primary;
+        ignoredDependencies = configuredPolicies.primary.ignoredDependencies || ignoredDependencies;
       }
       if (configuredPolicies.custom) {
         policies.custom = {};
@@ -38,6 +40,11 @@ async function main(cli, { policyDetails, setupProjectFn }) {
                 `The dependency ${dep} was found multiple times in the config file. Please refer Rules section in configuration.md`,
               );
             }
+            if (ignoredDependencies.includes(dep)) {
+              throw new Error(
+                `The dependency ${dep} was found in ignoredDependencies and custom configuration. Please refer Rules section in configuration.md`,
+              );
+            }
             policies.custom[dep] = {
               upgradeBudget: policy.upgradeBudget,
               effectiveReleaseDate:
@@ -52,7 +59,14 @@ async function main(cli, { policyDetails, setupProjectFn }) {
     let result;
     let processed = false;
     try {
-      result = await processPolicies(projectPaths, setupProjectFn, spinner, currentDate, policies);
+      result = await processPolicies(
+        projectPaths,
+        setupProjectFn,
+        spinner,
+        currentDate,
+        policies,
+        ignoredDependencies,
+      );
       if (result.isInSupportWindow === false) {
         process.exitCode = 1;
       }
@@ -121,6 +135,11 @@ async function run(
           type: 'string',
           alias: 'f',
         },
+        ignoredDependencies: {
+          type: 'string',
+          alias: 'i',
+          isMultiple: true,
+        },
       },
     }),
     { policyDetails, setupProjectFn },

lib/help.js

@@ -19,6 +19,7 @@ module.exports = (commandName = 'supported', packageLink = pkg.homepage) => {
     {cyan --csv}              outputs csv file in the project path
     {cyan --current-date, -c} optional current date to use when calculating support
     {cyan --config-file, -f}  optional config file to override the default setup
+    {cyan --ignored-dependencies, -i} optional list of dependencies to be ignored while running the policy, ex: -r 'test','tester'
   {bold Examples}
     {gray $} {cyan  ${commandName} ./path/to/project/}
 `;

lib/project/multiple-projects.js

@@ -10,7 +10,14 @@ const { ProgressLogger } = require('../util');
 const DEFAULT_SETUP_FILE = './setup-project';
 
 module.exports.processPolicies = processPolicies;
-async function processPolicies(projectPaths, setupProjectFn, spinner, today, policies) {
+async function processPolicies(
+  projectPaths,
+  setupProjectFn,
+  spinner,
+  today,
+  policies,
+  ignoredDependencies,
+) {
   const setupProject = setupProjectFn ? setupProjectFn : require(DEFAULT_SETUP_FILE);
   let result = {
     isInSupportWindow: true,
@@ -30,9 +37,15 @@ async function processPolicies(projectPaths, setupProjectFn, spinner, today, pol
     work.push(
       queue.add(async () => {
         let { dependenciesToCheck, pkg } = await setupProject(projectPath);
+        let dependenciesToCheckAfterIgnore = dependenciesToCheck.filter(
+          dep => !ignoredDependencies.includes(dep.name),
+        );
         progressLogger.updateTotalDepCount(dependenciesToCheck.length);
+        progressLogger.updateIgnoredDepCount(
+          dependenciesToCheck.length - dependenciesToCheckAfterIgnore.length,
+        );
         let auditResult = await isInSupportWindow(
-          dependenciesToCheck,
+          dependenciesToCheckAfterIgnore,
           pkg.name,
           {
             progressLogger,

lib/util.js

@@ -91,12 +91,13 @@ function sortLibraries(a, b) {
 }
 
 module.exports.ProgressLogger = class ProgressLogger {
-  constructor(_spinner = { prefixText: '', text: '' }, _isMultipleProduct) {
+  constructor(_spinner = { prefixText: '', text: '' }, _isMultipleProduct = false) {
     this.spinner = _spinner;
     this.totalPackages = 0; // start from `1` as we have node policy tested all the time
     this.processedCount = 0;
     this.semVerLogged = false;
     this.isMultipleProduct = _isMultipleProduct;
+    this.ignoredPackages = 0;
   }
 
   getLoggerPrefixText(name, isSupported, isExpiringSoon) {
@@ -123,6 +124,10 @@ module.exports.ProgressLogger = class ProgressLogger {
     this.totalPackages += count;
   }
 
+  updateIgnoredDepCount(count) {
+    this.ignoredPackages = count;
+  }
+
   updateSpinner(name, isSupported, isExpiringSoon) {
     if (name && !this.isMultipleProduct) {
       if (!this.spinner.prefixText) {
@@ -141,7 +146,9 @@ module.exports.ProgressLogger = class ProgressLogger {
     }
     this.spinner.text = `Total Dependencies: ${this.totalPackages}, Verified: ${
       this.processedCount
-    }, Remaining: ${this.totalPackages - this.processedCount}`;
+    }, Remaining: ${this.totalPackages - this.processedCount - this.ignoredPackages}, Ignored: ${
+      this.ignoredPackages
+    }`;
     if (this.totalPackages > this.processedCount) {
       this.processedCount++;
     }

tests/cli-test.js

@@ -180,6 +180,48 @@ describe('CLI', function () {
     });
   });
 
+  describe(`--ignore-dependencies`, function () {
+    it('check console log', async function () {
+      const child = await runSupportedCmd([
+        `${__dirname}/fixtures/supported-project`,
+        `--ignored-dependencies @stefanpenner/a`,
+        `-i rsvp`,
+      ]);
+
+      expect(child).to.exitGracefully();
+      expect(child.stderr).to.includes(`Ignored: 2`);
+      expect(child.stderr).to.includes('✓ SemVer Policy');
+      expect(child.stdout).to.includes('Congrats!');
+    });
+
+    it('check if verbose do not incude the entry', async function () {
+      const child = await runSupportedCmd([
+        `${__dirname}/fixtures/supported-project`,
+        `--ignored-dependencies @stefanpenner/a`,
+        `-i rsvp`,
+        '--verbose',
+      ]);
+
+      expect(child).to.exitGracefully();
+      expect(child.stderr).to.includes(`Ignored: 2`);
+      expect(child.stderr).to.includes('✓ SemVer Policy');
+      expect(child.stdout).to.includes('Congrats!');
+      expect(child.stdout).not.include(
+        '@stefanpenner/a                    1.0.3                          2.0.0   major',
+      );
+    });
+
+    it('make unsupported to supported project using ignoreDependency config', async function () {
+      const child = await runSupportedCmd([
+        `${__dirname}/fixtures/unsupported-project`,
+        `-f ${__dirname}/fixtures/unsupported-project/config-ignore-dep.json`,
+      ]);
+
+      expect(child).to.exitGracefully();
+      expect(child.stderr).to.includes('✓ SemVer Policy');
+    });
+  });
+
   describe('Filter options like --unsupported/expiring/supported', function () {
     it('works against a unsupported project with --unsupported option', async function () {
       const child = await runSupportedCmd([
@@ -364,6 +406,7 @@ describe('CLI', function () {
       });
     });
   });
+
   describe('--config-file', function () {
     it('make unsupported to supported project using effectiveReleaseDate', async function () {
       const child = await runSupportedCmd([
@@ -374,6 +417,7 @@ describe('CLI', function () {
       expect(child).to.exitGracefully();
       expect(child.stderr).to.includes('✓ SemVer Policy');
     });
+
     it('make unsupported to supported project using upgradeBudget', async function () {
       const child = await runSupportedCmd([
         `${__dirname}/fixtures/unsupported-project`,
@@ -385,16 +429,24 @@ describe('CLI', function () {
     });
 
     it('alert user when there is conflicting custom config', async function () {
-      try {
-        await runSupportedCmd([
-          `${__dirname}/fixtures/unsupported-project`,
-          `-f ${__dirname}/fixtures/unsupported-project/config-conflict.json`,
-        ]);
-      } catch (e) {
-        expect(e).includes(
-          `The dependency es6-promise was found multiple times in the config file. Please refer Rules section in configuration.md`,
-        );
-      }
+      const child = await runSupportedCmd([
+        `${__dirname}/fixtures/unsupported-project`,
+        `-f ${__dirname}/fixtures/unsupported-project/config-conflict.json`,
+      ]);
+      expect(child.stderr).includes(
+        `The dependency es6-promise was found multiple times in the config file. Please refer Rules section in configuration.md`,
+      );
+    });
+
+    it('alert user when there is conflict in custom config and ignoredDependency', async function () {
+      const child = await runSupportedCmd([
+        `${__dirname}/fixtures/unsupported-project`,
+        `-f ${__dirname}/fixtures/unsupported-project/config.json`,
+        `-i es6-promise`,
+      ]);
+      expect(child.stderr).includes(
+        `The dependency es6-promise was found in ignoredDependencies and custom configuration. Please refer Rules section in configuration.md`,
+      );
     });
   });
 });

tests/fixtures/unsupported-project/config-ignore-dep.json

@@ -0,0 +1,5 @@
+{
+  "primary": {
+    "ignoredDependencies": ["es6-promise", "@stefanpenner/a", "rsvp"]
+  }
+}