feat: add --noBumpWhenEmptyChanges flag (#274)

* feat: skip version bumping if no commits

* feat: simplified not bumping version by copying whatBump function and adding logic inside

* fix: _whatBump also check for fix types to avoid upgrading if there are not patches

* chore: added config flag and linted files. Missing tests

* chore: rename _whatBump, remove unnecessary async, replace chaining with terneray

* test: add mock for git-raw-commits

* test: add tests for --noBumpWhenEmptyChanges flag

* chore: Run formatter

---------

Co-authored-by: Guido Ceraso <gceraso@mrmilu.com>
Co-authored-by: Guido Ceraso <guidoceraso@gmail.com>
Co-authored-by: Timothy Jones <timothy.l.jones@gmail.com>

Author: 4 people

command.js

@@ -138,6 +138,12 @@ const yargs = require('yargs')
     alias: 'c',
     describe: 'Path to a custom configuration file',
   })
+  .option('noBumpWhenEmptyChanges', {
+    type: 'boolean',
+    default: false,
+    describe:
+      'Avoid bumping files and generating changelog if there are no changes.',
+  })
   .check((argv) => {
     if (typeof argv.scripts !== 'object' || Array.isArray(argv.scripts)) {
       throw Error('scripts must be an object');

index.js

@@ -85,6 +85,7 @@ module.exports = async function standardVersion(argv) {
     }
 
     const newVersion = await bump(args, version);
+    if (!newVersion) return;
     await changelog(args, newVersion);
     await commit(args, newVersion);
     await tag(newVersion, pkg ? pkg.private : false, args);

lib/lifecycles/bump.js

@@ -13,9 +13,47 @@ const semver = require('semver');
 const writeFile = require('../write-file');
 const { resolveUpdaterObjectFromArgument } = require('../updaters');
 const gitSemverTags = require('git-semver-tags');
+const addBangNotes = require('conventional-changelog-conventionalcommits/add-bang-notes');
 let configsToUpdate = {};
 const sanitizeQuotesRegex = /['"]+/g;
 
+function noBumpWhenEmptyChanges(config, commits) {
+  let level = 2;
+  let breakings = 0;
+  let features = 0;
+  let fix = 0;
+
+  commits.forEach((commit) => {
+    addBangNotes(commit);
+    if (commit.notes.length > 0) {
+      breakings += commit.notes.length;
+      level = 0;
+    } else if (commit.type === 'feat' || commit.type === 'feature') {
+      features += 1;
+      if (level === 2) {
+        level = 1;
+      }
+    }
+    if (commit.type === 'fix') {
+      fix += 1;
+    }
+  });
+
+  if (config.preMajor && level < 2) {
+    level++;
+  }
+
+  if (!breakings && !features && !fix) return {};
+
+  return {
+    level,
+    reason:
+      breakings === 1
+        ? `There is ${breakings} BREAKING CHANGE and ${features} features`
+        : `There are ${breakings} BREAKING CHANGES and ${features} features`,
+  };
+}
+
 async function Bump(args, version) {
   // reset the cache of updated config files each
   // time we perform the version bump step.
@@ -42,6 +80,7 @@ async function Bump(args, version) {
     const prebumpString = stdout.trim().replace(sanitizeQuotesRegex, '');
     if (semver.valid(prebumpString)) args.releaseAs = prebumpString;
   }
+
   if (!args.firstRelease) {
     if (semver.valid(args.releaseAs)) {
       const releaseAs = new semver.SemVer(args.releaseAs);
@@ -76,6 +115,11 @@ async function Bump(args, version) {
       newVersion = semvarToVersionStr(newVersion, releaseAs.build);
     } else {
       const release = await bumpVersion(args.releaseAs, version, args);
+
+      if (!Object.keys(release).length) {
+        checkpoint(args, 'no commits found, so not bumping version', []);
+        return null;
+      }
       const releaseType = getReleaseType(
         args.prerelease,
         release.releaseType,
@@ -212,6 +256,13 @@ function bumpVersion(releaseAs, currentVersion, args) {
                 ),
               }
             : {}),
+          ...(args.noBumpWhenEmptyChanges
+            ? {
+                whatBump(commits) {
+                  return noBumpWhenEmptyChanges(presetOptions, commits);
+                },
+              }
+            : {}),
         },
         args.parserOpts,
         function (err, release) {

test/core.spec.js

@@ -158,6 +158,7 @@ function mock({
   bump,
   changelog,
   tags,
+  commits,
   existingChangelog,
   testFiles,
   realTestFiles,
@@ -174,6 +175,10 @@ function mock({
     tags,
   });
 
+  mockers.mockGitRawCommits({
+    commits,
+  });
+
   // needs to be set after mockery, but before mock-fs
   standardVersion = require('../index');
 
@@ -913,6 +918,58 @@ describe('cli', function () {
       expect(consoleErrorSpy).not.toHaveBeenCalled();
       expect(consoleInfoSpy).not.toHaveBeenCalled();
     });
+
+    it('bumps using actual recommendedBump when there are no semver relevant changes and --noBumpWhenEmptyChanges flag is not set', async function () {
+      mock({
+        bump: jest.requireActual('conventional-recommended-bump'),
+        changelog: ['chore release\n'],
+        tags: ['v1.0.0'],
+        commits: ['chore: update deps\n\n-hash-\nabc123\n'],
+      });
+
+      await exec();
+
+      verifyPackageVersion({ writeFileSyncSpy, expectedVersion: '1.0.1' });
+    });
+
+    it('bumps using actual recommendedBump when there are semver relevant changes and --noBumpWhenEmptyChanges flag is not set', async function () {
+      mock({
+        bump: jest.requireActual('conventional-recommended-bump'),
+        changelog: ['feat release\n'],
+        tags: ['v1.0.0'],
+        commits: ['feat: shiny new stuff\n\n-hash-\nabc123\n'],
+      });
+
+      await exec();
+
+      verifyPackageVersion({ writeFileSyncSpy, expectedVersion: '1.1.0' });
+    });
+
+    it('does not bump when there are no semver relevant changes and --noBumpWhenEmptyChanges flag is set', async function () {
+      mock({
+        bump: jest.requireActual('conventional-recommended-bump'),
+        changelog: ['chore release\n'],
+        tags: ['v1.0.0'],
+        commits: ['chore: update deps\n\n-hash-\nabc123\n'],
+      });
+
+      await exec('--noBumpWhenEmptyChanges');
+
+      expect(writeFileSyncSpy).not.toHaveBeenCalled();
+    });
+
+    it('bumps when there are semver relevant changes and --noBumpWhenEmptyChanges flag is set', async function () {
+      mock({
+        bump: jest.requireActual('conventional-recommended-bump'),
+        changelog: ['feat release\n'],
+        tags: ['v1.0.0'],
+        commits: ['feat: shiny new stuff\n\n-hash-\nabc123\n'],
+      });
+
+      await exec('--noBumpWhenEmptyChanges');
+
+      verifyPackageVersion({ writeFileSyncSpy, expectedVersion: '1.1.0' });
+    });
   });
 
   describe('commit-and-tag-version', function () {

test/mocks/jest-mocks.js

@@ -1,12 +1,14 @@
 const gitSemverTags = require('git-semver-tags');
 const conventionalChangelog = require('conventional-changelog');
 const conventionalRecommendedBump = require('conventional-recommended-bump');
+const gitRawCommits = require('git-raw-commits');
 
 const { Readable } = require('stream');
 
 jest.mock('conventional-changelog');
 jest.mock('conventional-recommended-bump');
 jest.mock('git-semver-tags');
+jest.mock('git-raw-commits');
 
 const mockGitSemverTags = ({ tags = [] }) => {
   gitSemverTags.mockImplementation((opts, cb) => {
@@ -15,6 +17,21 @@ const mockGitSemverTags = ({ tags = [] }) => {
   });
 };
 
+/**
+ * @param { { commits: string[] } }
+ * a commit should look like  `<rawBody>\n\n-hash-\n<hash>\n`
+ */
+const mockGitRawCommits = ({ commits = [] }) => {
+  gitRawCommits.mockImplementation(() => {
+    return new Readable({
+      read() {
+        commits.forEach((c) => this.push(c));
+        this.push(null);
+      },
+    });
+  });
+};
+
 const mockConventionalChangelog = ({ changelog }) => {
   conventionalChangelog.mockImplementation(
     (opt) =>
@@ -43,6 +60,7 @@ const mockRecommendedBump = ({ bump }) => {
 
 module.exports = {
   mockGitSemverTags,
+  mockGitRawCommits,
   mockConventionalChangelog,
   mockRecommendedBump,
 };