Merge pull request #160 from sbonasu/add-enforceAllErrors

feat: add lint-every-commit flag to commitlint function

Author: kellyselden

bin/index.js

@@ -15,10 +15,18 @@ const { argv } = require('yargs')
       default: defaultBranch,
       description: `Use a different branch point other than ${defaultBranch}`,
     },
+    'lint-every-commit': {
+      type: 'boolean',
+      default: false,
+      description: 'lint every commit including normally ignored errors',
+    },
   });
 
 (async () => {
-  let formatted = await commitlint(argv);
+  let formatted = await commitlint({
+    ...argv,
+    shouldLintEveryCommit: argv['lint-every-commit'],
+  });
 
   console.log(formatted);
 })();

src/index.js

@@ -18,7 +18,7 @@ function doesReportMatchErrorSchema(report, schema) {
     && report.errors.every(error => schema.includes(error.name));
 }
 
-async function runCommitLint(commit) {
+async function runCommitLint(commit, { shouldLintEveryCommit }) {
   const { default: load } = await import('@commitlint/load');
   const { default: read } = await import('@commitlint/read');
   const { default: lint } = await import('@commitlint/lint');
@@ -46,7 +46,7 @@ async function runCommitLint(commit) {
     if (report.valid) {
       hasValidReports = true;
       orderedValidAndErrorReports.push(report);
-    } else if (!doesReportMatchErrorSchema(report, IGNORED_ERROR_REPORT_SCHEMA)) {
+    } else if (shouldLintEveryCommit || !doesReportMatchErrorSchema(report, IGNORED_ERROR_REPORT_SCHEMA)) {
       hasErrorReports = true;
       orderedValidAndErrorReports.push(report);
       errorCount++;
@@ -102,9 +102,7 @@ async function succeedWithLatestCommit() {
   });
 }
 
-async function commitlint({
-  defaultBranch,
-}) {
+async function commitlint({ defaultBranch, shouldLintEveryCommit } = {}) {
   let currentBranch = await getCurrentBranch();
   if (currentBranch === defaultBranch) {
     return await succeedWithLatestCommit();
@@ -125,8 +123,7 @@ async function commitlint({
     return await succeedWithLatestCommit();
   }
 
-  let formatted = await runCommitLint(commitSinceBranchPoint);
-
+  let formatted = await runCommitLint(commitSinceBranchPoint, { shouldLintEveryCommit });
   return formatted;
 }
 

test/index-test.js

@@ -71,6 +71,40 @@ describe(function() {
       expect(err.exitCode).to.equal(1);
     });
 
+    it('succeeds when one good commit and one unconventional commit on branch', async function() {
+      await execa('git', ['branch', 'foo'], { cwd: tmpPath });
+      await execa('git', ['checkout', 'foo'], { cwd: tmpPath });
+      await execa('git', ['commit', '--allow-empty', '-m', 'foo'], { cwd: tmpPath });
+      await execa('git', ['commit', '--allow-empty', '-m', 'chore: bar'], { cwd: tmpPath });
+
+      let { stdout } = await execa(bin, { cwd: tmpPath });
+
+      expect(stdout).to.equal(`⧗   input: chore: bar
+✔   found 0 problems, 0 warnings`);
+    });
+
+    it('fails when lint-every-commit is enabled and branch has one good commit and one unconventional commit', async function() {
+      await execa('git', ['branch', 'foo'], { cwd: tmpPath });
+      await execa('git', ['checkout', 'foo'], { cwd: tmpPath });
+      await execa('git', ['commit', '--allow-empty', '-m', 'foo'], { cwd: tmpPath });
+      await execa('git', ['commit', '--allow-empty', '-m', 'chore: bar'], { cwd: tmpPath });
+
+      let err = await execa(bin, ['--lint-every-commit'], {
+        cwd: tmpPath,
+        reject: false,
+      });
+
+      expect(err.stdout.trim()).to.equal(`⧗   input: chore: bar
+✔   found 0 problems, 0 warnings
+⧗   input: foo
+✖   subject may not be empty [subject-empty]
+✖   type may not be empty [type-empty]
+
+✖   found 2 problems, 0 warnings`);
+
+      expect(err.exitCode).to.equal(1);
+    });
+
     // There is no way to actually generate just a `subject-empty` error.
     // `chore:` is always recognized as missing a type with a `type-empty` as well.
     // eslint-disable-next-line mocha/no-skipped-tests