npm - conventional-recommended-bump - Versions diffs - 6.0.12 → 7.0.0 - Mend

conventional-recommended-bump 6.0.12 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -18,6 +18,7 @@ Got the idea from https://github.com/conventional-changelog/conventional-changel
       - [config](#config)
       - [whatBump](#whatbump)
       - [tagPrefix](#tagprefix)
+      - [skipUnstable](#skipunstable)
       - [lernaPackage](#lernapackage)
       - [path](#path)
     - [parserOpts](#parseropts)
@@ -112,6 +113,12 @@ Specify a prefix for the git tag that will be taken into account during the comp
 For instance if your version tag is prefixed by `version/` instead of `v` you would specifying `--tagPrefix=version/` using the CLI, or `version/` as the value of the `tagPrefix` option.
+##### skipUnstable
+**Type:** `boolean`
+If true, unstable tags will be skipped, e.g., x.x.x-alpha.1, x.x.x-rc.2
 ##### lernaPackage
 **Type:** `string`

package/cli.js CHANGED Viewed

@@ -26,6 +26,7 @@ const cli = meow(`
       -l, --lerna-package            Recommend a bump for a specific lerna package (:pkg-name@1.0.0)
       -t, --tag-prefix               Tag prefix to consider when reading the tags
       --commit-path                  Recommend a bump scoped to a specific directory
+      --skip-unstable                If given, unstable tags will be skipped, e.g., x.x.x-alpha.1, x.x.x-rc.2
 `, {
   flags: {
     preset: {
@@ -67,7 +68,8 @@ const cli = meow(`
 const options = {
   path: cli.flags.commitPath,
   lernaPackage: cli.flags.lernaPackage,
-  tagPrefix: cli.flags.tagPrefix
+  tagPrefix: cli.flags.tagPrefix,
+  skipUnstable: cli.flags.skipUnstable
 }
 const flags = cli.flags
 const preset = flags.preset

package/index.js CHANGED Viewed

@@ -16,7 +16,10 @@ function conventionalRecommendedBump (optionsArgument, parserOptsArgument, cbArg
     throw new Error('The \'options\' argument must be an object.')
   }
-  const options = Object.assign({ ignoreReverted: true }, optionsArgument)
+  const options = Object.assign({
+    ignoreReverted: true,
+    gitRawCommitsOpts: {}
+  }, optionsArgument)
   const cb = typeof parserOptsArgument === 'function' ? parserOptsArgument : cbArgument
@@ -63,7 +66,8 @@ function conventionalRecommendedBump (optionsArgument, parserOptsArgument, cbArg
     gitSemverTags({
       lernaTags: !!options.lernaPackage,
       package: options.lernaPackage,
-      tagPrefix: options.tagPrefix
+      tagPrefix: options.tagPrefix,
+      skipUnstable: options.skipUnstable
     }, (err, tags) => {
       if (err) {
         return cb(err)
@@ -72,7 +76,8 @@ function conventionalRecommendedBump (optionsArgument, parserOptsArgument, cbArg
       gitRawCommits({
         format: '%B%n-hash-%n%H',
         from: tags[0] || '',
-        path: options.path
+        path: options.path,
+        ...options.gitRawCommitsOpts
       })
         .pipe(conventionalCommitsParser(parserOpts))
         .pipe(concat(data => {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "conventional-recommended-bump",
-  "version": "6.0.12",
+  "version": "7.0.0",
   "description": "Get a recommended version bump based on conventional commits",
   "bugs": {
     "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
@@ -17,7 +17,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "files": [
     "index.js",
@@ -32,19 +32,18 @@
   ],
   "dependencies": {
     "concat-stream": "^2.0.0",
-    "conventional-changelog-preset-loader": "^2.3.4",
-    "conventional-commits-filter": "^2.0.7",
-    "conventional-commits-parser": "^3.2.0",
-    "git-raw-commits": "^2.0.8",
-    "git-semver-tags": "^4.1.1",
-    "meow": "^8.0.0",
-    "q": "^1.5.1"
-  },
-  "scripts": {
-    "test-windows": "mocha --timeout 30000 ./test/preset-resolver.spec.js"
+    "conventional-changelog-preset-loader": "^3.0.0",
+    "conventional-commits-filter": "^3.0.0",
+    "conventional-commits-parser": "^4.0.0",
+    "git-raw-commits": "^3.0.0",
+    "git-semver-tags": "^5.0.0",
+    "meow": "^8.1.2"
   },
   "bin": "cli.js",
   "devDependencies": {
-    "conventional-changelog-conventionalcommits": "^4.5.0"
+    "conventional-changelog-conventionalcommits": "^5.0.0"
+  },
+  "scripts": {
+    "test-windows": "mocha --timeout 30000 ./test/preset-resolver.spec.js"
   }
-}
+}

package/preset-resolver.js CHANGED Viewed

@@ -1,22 +1,19 @@
 'use strict'
-const Q = require('q')
+const { promisify } = require('util')
 module.exports = presetResolver
-function presetResolver (presetPackage) {
-  // start the chain as a Q.Promise
-  return Q.resolve().then(() => {
-    // handle traditional node-style callbacks
-    if (typeof presetPackage === 'function') {
-      return Q.nfcall(presetPackage)
-    }
+async function presetResolver (presetPackage) {
+  // handle traditional node-style callbacks
+  if (typeof presetPackage === 'function') {
+    return await promisify(presetPackage)()
+  }
-    // handle object literal or Promise instance
-    if (typeof presetPackage === 'object') {
-      return Q(presetPackage)
-    }
+  // handle object literal or Promise instance
+  if (typeof presetPackage === 'object') {
+    return await presetPackage
+  }
-    throw new Error('preset package must be a promise, function, or object')
-  })
+  throw new Error('preset package must be a promise, function, or object')
 }

package/CHANGELOG.md DELETED Viewed

@@ -1,425 +0,0 @@
-# Change Log
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-### [6.0.12](https://www.github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.11...v6.0.12) (2020-12-30)
-### Bug Fixes
-* **deps:** update dependency git-raw-commits to v2.0.8 ([#723](https://www.github.com/conventional-changelog/conventional-changelog/issues/723)) ([9682305](https://www.github.com/conventional-changelog/conventional-changelog/commit/968230536914a680237e830ccc8e125c56b0f0aa))
-## [6.0.11](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.10...conventional-recommended-bump@6.0.11) (2020-11-05)
-**Note:** Version bump only for package conventional-recommended-bump
-## [6.0.10](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.9...conventional-recommended-bump@6.0.10) (2020-08-12)
-**Note:** Version bump only for package conventional-recommended-bump
-## [6.0.9](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.5...conventional-recommended-bump@6.0.9) (2020-05-08)
-### Bug Fixes
-* **deps:** update yargs-parser to move off a flagged-vulnerable version. ([#635](https://github.com/conventional-changelog/conventional-changelog/issues/635)) ([aafc0f0](https://github.com/conventional-changelog/conventional-changelog/commit/aafc0f00412c3e4b23b8418300e5a570a48fe24d))
-## [6.0.5](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.4...conventional-recommended-bump@6.0.5) (2019-11-14)
-**Note:** Version bump only for package conventional-recommended-bump
-## [6.0.4](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.3...conventional-recommended-bump@6.0.4) (2019-11-07)
-### Bug Fixes
-* revertPattern match default git revert format ([#545](https://github.com/conventional-changelog/conventional-changelog/issues/545)) ([fe449f8](https://github.com/conventional-changelog/conventional-changelog/commit/fe449f899567574a36d1819b313e2caa899052ff))
-## [6.0.3](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.2...conventional-recommended-bump@6.0.3) (2019-10-24)
-**Note:** Version bump only for package conventional-recommended-bump
-## [6.0.1](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@6.0.0...conventional-recommended-bump@6.0.1) (2019-10-02)
-**Note:** Version bump only for package conventional-recommended-bump
-# [6.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@5.0.1...conventional-recommended-bump@6.0.0) (2019-07-29)
-* refactor!: modify gitSemverTags to take options first (#390) ([dc8aeda](https://github.com/conventional-changelog/conventional-changelog/commit/dc8aeda)), closes [#390](https://github.com/conventional-changelog/conventional-changelog/issues/390)
-### BREAKING CHANGES
-* gitSemverTags now takes options followed by callback.
-## [5.0.1](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@5.0.0...conventional-recommended-bump@5.0.1) (2019-05-18)
-### Bug Fixes
-* Recommend a patch bump for features when preMajor is enabled ([#452](https://github.com/conventional-changelog/conventional-changelog/issues/452)) ([3d0a520](https://github.com/conventional-changelog/conventional-changelog/commit/3d0a520))
-# [5.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.1.1...conventional-recommended-bump@5.0.0) (2019-05-02)
-### Features
-* ! without BREAKING CHANGE should be treated as major ([#443](https://github.com/conventional-changelog/conventional-changelog/issues/443)) ([cf22d70](https://github.com/conventional-changelog/conventional-changelog/commit/cf22d70))
-### BREAKING CHANGES
-* if ! is in the commit header, it now indicates a BREAKING CHANGE, and the description is used as the body.
-## [4.1.1](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.1.0...conventional-recommended-bump@4.1.1) (2019-04-11)
-### Bug Fixes
-* preset load error message should handle objects ([fb4a8d1](https://github.com/conventional-changelog/conventional-changelog/commit/fb4a8d1))
-# [4.1.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.0.4...conventional-recommended-bump@4.1.0) (2019-04-10)
-### Bug Fixes
-* **deps:** update dependency concat-stream to v2 ([#401](https://github.com/conventional-changelog/conventional-changelog/issues/401)) ([4c09bfc](https://github.com/conventional-changelog/conventional-changelog/commit/4c09bfc))
-### Features
-* conventionalcommits preset, preMajor config option ([#434](https://github.com/conventional-changelog/conventional-changelog/issues/434)) ([dde12fe](https://github.com/conventional-changelog/conventional-changelog/commit/dde12fe))
-* **conventional-recommended-bump:** send options to whatBump ([#409](https://github.com/conventional-changelog/conventional-changelog/issues/409)) ([508d6d6](https://github.com/conventional-changelog/conventional-changelog/commit/508d6d6)), closes [/github.com/lerna/lerna/blob/a6733a2b864cf9d082d080bbd3bfedb04e59b0ab/core/conventional-commits/lib/recommend-version.js#L13-L21](https://github.com//github.com/lerna/lerna/blob/a6733a2b864cf9d082d080bbd3bfedb04e59b0ab/core/conventional-commits/lib/recommend-version.js/issues/L13-L21)
-## [4.0.4](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.0.3...conventional-recommended-bump@4.0.4) (2018-11-01)
-### Bug Fixes
-* fix broken release of conventional-recommended-bump ([d9267e8](https://github.com/conventional-changelog/conventional-changelog/commit/d9267e8))
-## [4.0.3](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.0.2...conventional-recommended-bump@4.0.3) (2018-11-01)
-**Note:** Version bump only for package conventional-recommended-bump
-## [4.0.2](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.0.1...conventional-recommended-bump@4.0.2) (2018-11-01)
-### Bug Fixes
-* Upgrade to Lerna 3, fix Node.js v11 error ([#385](https://github.com/conventional-changelog/conventional-changelog/issues/385)) ([cdef282](https://github.com/conventional-changelog/conventional-changelog/commit/cdef282))
-<a name="4.0.1"></a>
-## [4.0.1](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@4.0.0...conventional-recommended-bump@4.0.1) (2018-08-21)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="4.0.0"></a>
-# [4.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@3.0.0...conventional-recommended-bump@4.0.0) (2018-06-06)
-### Features
-* re-use parser options within each preset ([#335](https://github.com/conventional-changelog/conventional-changelog/issues/335)) ([d3eaacf](https://github.com/conventional-changelog/conventional-changelog/commit/d3eaacf)), closes [#241](https://github.com/conventional-changelog/conventional-changelog/issues/241)
-### BREAKING CHANGES
-* Re-use parser options object between components of a preset. For some
-presets this may change the behavior of `conventional-recommended-bump`
-as the parser options object for the `conventional-recommended-bump` options
-within a preset were different than the parser options object for the
-`conventional-changelog` options within a preset.
-If you are not using `conventional-recommended-bump`, then this is
-**not** a breaking change for you.
-<a name="3.0.0"></a>
-# [3.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.9...conventional-recommended-bump@3.0.0) (2018-05-29)
-### Chores
-* **package:** set Node requirement to oldest supported LTS ([#329](https://github.com/conventional-changelog/conventional-changelog/issues/329)) ([cae2fe0](https://github.com/conventional-changelog/conventional-changelog/commit/cae2fe0))
-### BREAKING CHANGES
-* **package:** Set the package's minimum required Node version to be the oldest LTS
-currently supported by the Node Release working group. At this time,
-that is Node 6 (which is in its Maintenance LTS phase).
-<a name="2.0.9"></a>
-## [2.0.9](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.8...conventional-recommended-bump@2.0.9) (2018-04-16)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.8"></a>
-## [2.0.8](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.7...conventional-recommended-bump@2.0.8) (2018-03-27)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.7"></a>
-## [2.0.7](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.6...conventional-recommended-bump@2.0.7) (2018-03-22)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.6"></a>
-## [2.0.6](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.5...conventional-recommended-bump@2.0.6) (2018-02-24)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.5"></a>
-## [2.0.5](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-recommended-bump@2.0.4...conventional-recommended-bump@2.0.5) (2018-02-20)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.4"></a>
-## [2.0.4](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@2.0.3...conventional-recommended-bump@2.0.4) (2018-02-13)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.3"></a>
-## [2.0.3](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@2.0.2...conventional-recommended-bump@2.0.3) (2018-02-13)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.2"></a>
-## [2.0.2](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@2.0.1...conventional-recommended-bump@2.0.2) (2018-02-13)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="2.0.1"></a>
-## [2.0.1](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@2.0.0...conventional-recommended-bump@2.0.1) (2018-02-12)
-### Bug Fixes
-* **conventional-recommended-bump:** include missing file in publishing ([1481c05](https://github.com/conventional-changelog/conventional-recommended-bump/commit/1481c05))
-<a name="1.2.1"></a>
-## [1.2.1](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@1.2.0...conventional-recommended-bump@1.2.1) (2018-02-05)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="1.2.0"></a>
-# [1.2.0](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@1.1.0...conventional-recommended-bump@1.2.0) (2018-01-29)
-### Features
-* allow to specify a tagPrefix in conventional-recommended-bump ([f60f86f](https://github.com/conventional-changelog/conventional-recommended-bump/commit/f60f86f))
-<a name="1.1.0"></a>
-# [1.1.0](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@1.0.3...conventional-recommended-bump@1.1.0) (2017-12-08)
-### Features
-* **recommended-bump:** add `eslint` preset ([#256](https://github.com/conventional-changelog/conventional-recommended-bump/issues/256)) ([64abf07](https://github.com/conventional-changelog/conventional-recommended-bump/commit/64abf07))
-<a name="1.0.3"></a>
-## [1.0.3](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@1.0.2...conventional-recommended-bump@1.0.3) (2017-11-13)
-**Note:** Version bump only for package conventional-recommended-bump
-<a name="1.0.2"></a>
-## [1.0.2](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@1.0.1...conventional-recommended-bump@1.0.2) (2017-10-01)
-<a name="1.0.1"></a>
-## [1.0.1](https://github.com/conventional-changelog/conventional-recommended-bump/compare/conventional-recommended-bump@1.0.0...conventional-recommended-bump@1.0.1) (2017-07-17)
-<a name="0.3.0"></a>
-# [0.3.0](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.2.1...v0.3.0) (2016-08-13)
-### Code Refactoring
-* **naming:** releaseAs => releaseType ([1476f1e](https://github.com/conventional-changelog/conventional-recommended-bump/commit/1476f1e)), closes [#15](https://github.com/conventional-changelog/conventional-recommended-bump/issues/15)
-### BREAKING CHANGES
-* naming: `releaseAs` => `releaseType`
-<a name="0.2.1"></a>
-## [0.2.1](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.2.0...v0.2.1) (2016-04-16)
-<a name="0.2.0"></a>
-# [0.2.0](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.1.2...v0.2.0) (2016-04-02)
-### Features
-* **config:** custom config file ([aa3747a](https://github.com/conventional-changelog/conventional-recommended-bump/commit/aa3747a)), closes [#6](https://github.com/conventional-changelog/conventional-recommended-bump/issues/6)
-* **verbose:** output details of the bump ([2311c4a](https://github.com/conventional-changelog/conventional-recommended-bump/commit/2311c4a)), closes [#5](https://github.com/conventional-changelog/conventional-recommended-bump/issues/5)
-* **warn:** no new commits since last release ([84f5284](https://github.com/conventional-changelog/conventional-recommended-bump/commit/84f5284)), closes [#4](https://github.com/conventional-changelog/conventional-recommended-bump/issues/4)
-### BREAKING CHANGES
-* verbose: `whatBump` can return an object. `result` is an `object` instead of a `string`.
-<a name="0.1.2"></a>
-## [0.1.2](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.1.1...v0.1.2) (2016-03-10)
-### Bug Fixes
-* **angular:** handle breaking changes after a feature ([6c40400](https://github.com/conventional-changelog/conventional-recommended-bump/commit/6c40400)), closes [#8](https://github.com/conventional-changelog/conventional-recommended-bump/issues/8)
-<a name="0.1.1"></a>
-## [0.1.1](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.1.0...v0.1.1) (2016-02-23)
-<a name="0.1.0"></a>
-# [0.1.0](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.0.3...v0.1.0) (2016-02-08)
-<a name="0.0.3"></a>
-## [0.0.3](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.0.2...v0.0.3) (2015-08-12)
-### Features
-* **deps:** bump and a lot of bugs are fixed ([1abc3af](https://github.com/conventional-changelog/conventional-recommended-bump/commit/1abc3af))
-* **deps:** bump conventional-commits-filter and fix bug ([87639a0](https://github.com/conventional-changelog/conventional-recommended-bump/commit/87639a0))
-* **deps:** modulise conventional-commits-filter ([b1eadb9](https://github.com/conventional-changelog/conventional-recommended-bump/commit/b1eadb9))
-<a name="0.0.2"></a>
-## [0.0.2](https://github.com/conventional-changelog/conventional-recommended-bump/compare/v0.0.1...v0.0.2) (2015-07-03)
-### Features
-* **revert:** ignore reverted commits ([cd87dea](https://github.com/conventional-changelog/conventional-recommended-bump/commit/cd87dea))
-<a name="0.0.1"></a>
-## 0.0.1 (2015-06-22)