feat: detect if a release is necessary

command.js

@@ -86,6 +86,11 @@ const yargs = require('yargs')
     default: defaults.gitTagFallback,
     describe: 'fallback to git tags for version, if no meta-information file is found (e.g., package.json)'
   })
+  .option('detect-release', {
+    type: 'boolean',
+    default: defaults.detectRelease,
+    describe: 'Detect if a release is necessary'
+  })
   .option('path', {
     type: 'string',
     describe: 'Only populate commits made under this path'

defaults.js

@@ -12,6 +12,7 @@ const defaults = {
   skip: {},
   dryRun: false,
   gitTagFallback: true,
+  detectRelease: false,
   preset: require.resolve('conventional-changelog-conventionalcommits')
 }
 

lib/checkpoint.js

@@ -3,7 +3,7 @@ const figures = require('figures')
 const util = require('util')
 
 module.exports = function (argv, msg, args, figure) {
-  const defaultFigure = args.dryRun ? chalk.yellow(figures.tick) : chalk.green(figures.tick)
+  const defaultFigure = argv.dryRun ? chalk.yellow(figures.tick) : chalk.green(figures.tick)
   if (!argv.silent) {
     console.info((figure || defaultFigure) + ' ' + util.format.apply(util, [msg].concat(args.map(function (arg) {
       return chalk.bold(arg)

lib/lifecycles/bump.js

@@ -26,6 +26,10 @@ async function Bump (args, version) {
   if (stdout && stdout.trim().length) args.releaseAs = stdout.trim()
   const release = await bumpVersion(args.releaseAs, version, args)
   if (!args.firstRelease) {
+    if (args.detectRelease && !release.releaseType) {
+      checkpoint(args, release.reason, [])
+      process.exit()
+    }
     const releaseType = getReleaseType(args.prerelease, release.releaseType, version)
     newVersion = semver.valid(releaseType) || semver.inc(version, releaseType, args.prerelease)
     updateConfigs(args, newVersion)
@@ -77,7 +81,12 @@ function isInPrerelease (version) {
   return Array.isArray(semver.prerelease(version))
 }
 
-const TypeList = ['major', 'minor', 'patch'].reverse()
+const MAJOR = 'major'
+const MINOR = 'minor'
+const PATCH = 'patch'
+const VERSIONS = [MAJOR, MINOR, PATCH]
+
+const TypeList = [...VERSIONS].reverse()
 
 /**
  * extract the in-pre-release type in target version
@@ -106,6 +115,8 @@ function getTypePriority (type) {
 }
 
 function bumpVersion (releaseAs, currentVersion, args) {
+  const releaseTypes = args.types.reduce((acc, current) => (!current.hidden ? [...acc, current.type] : acc), [])
+
   return new Promise((resolve, reject) => {
     if (releaseAs) {
       return resolve({
@@ -120,7 +131,34 @@ function bumpVersion (releaseAs, currentVersion, args) {
         debug: args.verbose && console.info.bind(console, 'conventional-recommended-bump'),
         preset: presetOptions,
         path: args.path,
-        tagPrefix: args.tagPrefix
+        tagPrefix: args.tagPrefix,
+        whatBump: (commits) => {
+          let level = PATCH
+          let breakings = 0
+          let features = 0
+
+          commits.forEach(commit => {
+            if (commit.notes.length > 0) {
+              breakings += commit.notes.length
+              level = MAJOR
+            } else if (releaseTypes.includes(commit.type)) {
+              features += 1
+
+              level = level === PATCH ? MINOR : level
+            }
+          })
+
+          if (breakings + features === 0) {
+            return {
+              level: null,
+              reason: `No commits found for types: [${releaseTypes.join(', ')}], skipping release stage.`
+            }
+          }
+
+          return {
+            level: VERSIONS.indexOf(level)
+          }
+        }
       }, function (err, release) {
         if (err) return reject(err)
         else return resolve(release)
@@ -169,3 +207,4 @@ function updateConfigs (args, newVersion) {
 }
 
 module.exports = Bump
+module.exports.bumpVersion = bumpVersion

test/bump.spec.js

@@ -0,0 +1,86 @@
+/* global describe it beforeEach afterEach */
+
+'use strict'
+
+const { bumpVersion } = require('../lib/lifecycles/bump')
+const shell = require('shelljs')
+const chai = require('chai')
+const { expect } = chai
+
+describe('bumpVersion', () => {
+  const args = {
+    types: [
+      { type: 'feat', section: 'Features' },
+      { type: 'test', section: 'Tests', hidden: true }
+    ]
+  }
+
+  beforeEach(() => {
+    shell.rm('-rf', 'tmp')
+    shell.config.silent = true
+    shell.mkdir('tmp')
+    shell.cd('tmp')
+    shell.exec('git init')
+    shell.exec('git config commit.gpgSign false')
+    shell.exec('git config core.autocrlf false')
+  })
+
+  afterEach(() => {
+    shell.cd('../')
+    shell.rm('-rf', 'tmp')
+  })
+
+  describe('when a tag is avaialble', () => {
+    let result
+
+    beforeEach(async () => {
+      shell.exec('git commit --allow-empty -m "first-commit"')
+      shell.exec('git tag 1.2.3')
+    })
+
+    describe('and release commits are present', () => {
+      beforeEach(async () => {
+        shell.exec('git commit --allow-empty -m "feat: second-commit"')
+
+        result = await bumpVersion(null, '1.2.3', args)
+      })
+
+      it('should return a release recommendation', async () => {
+        expect(result).to.include({ level: 1, releaseType: 'minor' })
+      })
+    })
+
+    describe('and no release commits are present', () => {
+      beforeEach(async () => {
+        shell.exec('git commit --allow-empty -m "test: second-commit"')
+
+        result = await bumpVersion(null, '1.2.3', args)
+      })
+
+      it('should return no release', async () => {
+        expect(result).to.include({
+          level: null,
+          reason: 'No commits found for types: [feat], skipping release stage.'
+        })
+      })
+    })
+  })
+
+  describe('when no tag is found', () => {
+    let result
+
+    beforeEach(async () => {
+      shell.exec('git commit --allow-empty -m "first-commit"')
+      shell.exec('git commit --allow-empty -m "second-commit"')
+
+      result = await bumpVersion(null, '1.2.3', args)
+    })
+
+    it('should return no release', async () => {
+      expect(result).to.include({
+        level: null,
+        reason: 'No commits found for types: [feat], skipping release stage.'
+      })
+    })
+  })
+})