conventional-recommended-bump 7.0.1 → 9.0.0

package/README.md

@@ -38,11 +38,11 @@ npm install conventional-recommended-bump
 ```javascript
 const conventionalRecommendedBump = require(`conventional-recommended-bump`);
 
-conventionalRecommendedBump({
+const recommendation = await conventionalRecommendedBump({
   preset: `angular`
-}, (error, recommendation) => {
-  console.log(recommendation.releaseType); // 'major'
 });
+
+console.log(recommendation.releaseType); // 'major'
 ```
 
 ```bash

package/{cli.js → cli.mjs}

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
+import { resolve } from 'path'
+import { pathToFileURL } from 'url'
+import meow from 'meow'
+import conventionalRecommendedBump from './index.js'
 
-'use strict'
-
-const meow = require('meow')
-const conventionalRecommendedBump = require('./')
-const path = require('path')
+function relativeResolve (filePath) {
+  return pathToFileURL(resolve(process.cwd(), filePath))
+}
 
 const cli = meow(`
     Usage
@@ -28,39 +30,43 @@ const cli = meow(`
       --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
 `, {
+  importMeta: import.meta,
   flags: {
     preset: {
-      alias: 'p'
+      shortFlag: 'p'
     },
     config: {
-      alias: 'g'
+      shortFlag: 'g'
     },
-    'header-pattern': {
-      alias: 'h'
+    headerPattern: {
+      shortFlag: 'h'
     },
-    'header-correspondence': {
-      alias: 'c'
+    headerCorrespondence: {
+      shortFlag: 'c'
     },
-    'reference-actions': {
-      alias: 'r'
+    referenceActions: {
+      shortFlag: 'r'
     },
-    'issue-prefixes': {
-      alias: 'i'
+    issuePrefixes: {
+      shortFlag: 'i'
     },
-    'note-keywords': {
-      alias: 'n'
+    noteKeywords: {
+      shortFlag: 'n'
     },
-    'field-pattern': {
-      alias: 'f'
+    fieldPattern: {
+      shortFlag: 'f'
     },
     verbose: {
-      alias: 'v'
+      shortFlag: 'v'
+    },
+    lernaPackage: {
+      shortFlag: 'l'
     },
-    'lerna-package': {
-      alias: 'l'
+    tagPrefix: {
+      shortFlag: 't'
     },
-    'tag-prefix': {
-      alias: 't'
+    skipUnstable: {
+      type: 'boolean'
     }
   }
 })
@@ -79,7 +85,7 @@ if (preset) {
   options.preset = preset
   delete flags.preset
 } else if (config) {
-  options.config = require(path.resolve(process.cwd(), config))
+  options.config = (await import(relativeResolve(config))).default
   delete flags.config
 }
 
@@ -87,17 +93,12 @@ if (flags.verbose) {
   options.warn = console.warn.bind(console)
 }
 
-conventionalRecommendedBump(options, flags, function (err, data) {
-  if (err) {
-    console.error(err.toString())
-    process.exit(1)
-  }
+const data = await conventionalRecommendedBump(options, flags)
 
-  if (data.releaseType) {
-    console.log(data.releaseType)
-  }
+if (data.releaseType) {
+  console.log(data.releaseType)
+}
 
-  if (flags.verbose && data.reason) {
-    console.log(`Reason: ${data.reason}`)
-  }
-})
+if (flags.verbose && data.reason) {
+  console.log(`Reason: ${data.reason}`)
+}

package/index.js

@@ -1,17 +1,15 @@
 'use strict'
-const concat = require('concat-stream')
 const conventionalCommitsFilter = require('conventional-commits-filter')
 const conventionalCommitsParser = require('conventional-commits-parser')
-const conventionalChangelogPresetLoader = require('conventional-changelog-preset-loader')
+const { loadPreset } = require('conventional-changelog-preset-loader')
 const gitSemverTags = require('git-semver-tags')
 const gitRawCommits = require('git-raw-commits')
-const presetResolver = require('./preset-resolver')
 
 const VERSIONS = ['major', 'minor', 'patch']
 
-module.exports = conventionalRecommendedBump
+function noop () {}
 
-function conventionalRecommendedBump (optionsArgument, parserOptsArgument, cbArgument) {
+async function conventionalRecommendedBump (optionsArgument, parserOptsArgument) {
   if (typeof optionsArgument !== 'object') {
     throw new Error('The \'options\' argument must be an object.')
   }
@@ -21,84 +19,68 @@ function conventionalRecommendedBump (optionsArgument, parserOptsArgument, cbArg
     gitRawCommitsOpts: {}
   }, optionsArgument)
 
-  const cb = typeof parserOptsArgument === 'function' ? parserOptsArgument : cbArgument
+  let config = options.config || {}
+  if (options.preset) {
+    config = await loadPreset(options.preset)
+  }
 
-  if (typeof cb !== 'function') {
-    throw new Error('You must provide a callback function.')
+  const whatBump = options.whatBump ||
+    ((config.recommendedBumpOpts && config.recommendedBumpOpts.whatBump)
+      ? config.recommendedBumpOpts.whatBump
+      : noop)
+
+  if (typeof whatBump !== 'function') {
+    throw Error('whatBump must be a function')
   }
 
-  let presetPackage = options.config || {}
-  if (options.preset) {
-    try {
-      presetPackage = conventionalChangelogPresetLoader(options.preset)
-    } catch (err) {
-      if (err.message === 'does not exist') {
-        const preset = typeof options.preset === 'object' ? options.preset.name : options.preset
-        return cb(new Error(`Unable to load the "${preset}" preset package. Please make sure it's installed.`))
-      } else {
-        return cb(err)
-      }
-    }
+  // TODO: For now we defer to `config.recommendedBumpOpts.parserOpts` if it exists, as our initial refactor
+  // efforts created a `parserOpts` object under the `recommendedBumpOpts` object in each preset package.
+  // In the future we want to merge differences found in `recommendedBumpOpts.parserOpts` into the top-level
+  // `parserOpts` object and remove `recommendedBumpOpts.parserOpts` from each preset package if it exists.
+  const parserOpts = Object.assign({},
+    config.recommendedBumpOpts && config.recommendedBumpOpts.parserOpts
+      ? config.recommendedBumpOpts.parserOpts
+      : config.parserOpts,
+    parserOptsArgument)
+
+  const warn = typeof parserOpts.warn === 'function' ? parserOpts.warn : noop
+  const tags = await gitSemverTags({
+    lernaTags: !!options.lernaPackage,
+    package: options.lernaPackage,
+    tagPrefix: options.tagPrefix,
+    skipUnstable: options.skipUnstable,
+    cwd: options.cwd
+  })
+  const commitsStream = gitRawCommits({
+    format: '%B%n-hash-%n%H',
+    from: tags[0] || '',
+    path: options.path,
+    ...options.gitRawCommitsOpts
+  }, {
+    cwd: options.cwd
+  })
+    .pipe(conventionalCommitsParser(parserOpts))
+  let commits = []
+
+  for await (const commit of commitsStream) {
+    commits.push(commit)
+  }
+
+  commits = options.ignoreReverted ? conventionalCommitsFilter(commits) : commits
+
+  if (!commits || !commits.length) {
+    warn('No commits since last release')
   }
 
-  presetResolver(presetPackage).then(config => {
-    const whatBump = options.whatBump ||
-      ((config.recommendedBumpOpts && config.recommendedBumpOpts.whatBump)
-        ? config.recommendedBumpOpts.whatBump
-        : noop)
-
-    if (typeof whatBump !== 'function') {
-      throw Error('whatBump must be a function')
-    }
-
-    // TODO: For now we defer to `config.recommendedBumpOpts.parserOpts` if it exists, as our initial refactor
-    // efforts created a `parserOpts` object under the `recommendedBumpOpts` object in each preset package.
-    // In the future we want to merge differences found in `recommendedBumpOpts.parserOpts` into the top-level
-    // `parserOpts` object and remove `recommendedBumpOpts.parserOpts` from each preset package if it exists.
-    const parserOpts = Object.assign({},
-      config.recommendedBumpOpts && config.recommendedBumpOpts.parserOpts
-        ? config.recommendedBumpOpts.parserOpts
-        : config.parserOpts,
-      parserOptsArgument)
-
-    const warn = typeof parserOpts.warn === 'function' ? parserOpts.warn : noop
-
-    gitSemverTags({
-      lernaTags: !!options.lernaPackage,
-      package: options.lernaPackage,
-      tagPrefix: options.tagPrefix,
-      skipUnstable: options.skipUnstable
-    }, (err, tags) => {
-      if (err) {
-        return cb(err)
-      }
-
-      gitRawCommits({
-        format: '%B%n-hash-%n%H',
-        from: tags[0] || '',
-        path: options.path,
-        ...options.gitRawCommitsOpts
-      })
-        .pipe(conventionalCommitsParser(parserOpts))
-        .pipe(concat(data => {
-          const commits = options.ignoreReverted ? conventionalCommitsFilter(data) : data
-
-          if (!commits || !commits.length) {
-            warn('No commits since last release')
-          }
-
-          let result = whatBump(commits, options)
-
-          if (result && result.level != null) {
-            result.releaseType = VERSIONS[result.level]
-          } else if (result == null) {
-            result = {}
-          }
-
-          cb(null, result)
-        }))
-    })
-  }).catch(err => cb(err))
+  let result = whatBump(commits, options)
+
+  if (result && result.level != null) {
+    result.releaseType = VERSIONS[result.level]
+  } else if (result == null) {
+    result = {}
+  }
+
+  return result
 }
 
-function noop () {}
+module.exports = conventionalRecommendedBump

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conventional-recommended-bump",
-  "version": "7.0.1",
+  "version": "9.0.0",
   "description": "Get a recommended version bump based on conventional commits",
   "bugs": {
     "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
@@ -17,12 +17,11 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "files": [
     "index.js",
-    "cli.js",
-    "preset-resolver.js"
+    "cli.mjs"
   ],
   "keywords": [
     "conventional-recommended-bump",
@@ -31,19 +30,15 @@
     "bump"
   ],
   "dependencies": {
-    "concat-stream": "^2.0.0",
-    "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"
+    "meow": "^12.0.1",
+    "conventional-changelog-preset-loader": "^4.1.0",
+    "conventional-commits-filter": "^4.0.0",
+    "conventional-commits-parser": "^5.0.0",
+    "git-raw-commits": "^4.0.0",
+    "git-semver-tags": "^7.0.0"
   },
-  "bin": "cli.js",
+  "bin": "cli.mjs",
   "devDependencies": {
-    "conventional-changelog-conventionalcommits": "^6.0.0"
-  },
-  "scripts": {
-    "test-windows": "mocha --timeout 30000 ./test/preset-resolver.spec.js"
+    "conventional-changelog-conventionalcommits": "^7.0.2"
   }
 }

package/preset-resolver.js

@@ -1,19 +0,0 @@
-'use strict'
-
-const { promisify } = require('util')
-
-module.exports = presetResolver
-
-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 await presetPackage
-  }
-
-  throw new Error('preset package must be a promise, function, or object')
-}