fix: Ensures provided packageFiles arguments are merged with `bumpF…

…iles` when no `bumpFiles` argument is specified (default).

- Merges `packageFiles` with `defaults.bumpFiles` before merging in arguments when a `packageFile` argument is present.
- Adds some simple "validation" to updaters and improves error messaging.
- Adds a test case covering #533

closes #533

index.js

@@ -37,11 +37,19 @@ module.exports = function standardVersion (argv) {
     throw Error(`custom changelog header must not match ${changelog.START_OF_LAST_RELEASE_PATTERN}`)
   }
 
+  /**
+   * If an argument for `packageFiles` provided, we include it as a "default" `bumpFile`.
+   */
+  if (argv.packageFiles) {
+    defaults.bumpFiles = defaults.bumpFiles.concat(argv.packageFiles)
+  }
+
   const args = Object.assign({}, defaults, argv)
   let pkg
   args.packageFiles.forEach((packageFile) => {
     if (pkg) return
     const updater = resolveUpdaterObjectFromArgument(packageFile)
+    if (!updater) return
     const pkgPath = path.resolve(process.cwd(), updater.filename)
     try {
       const contents = fs.readFileSync(pkgPath, 'utf8')

lib/updaters/index.js

@@ -22,36 +22,49 @@ function getUpdaterByFilename (filename) {
   )
 }
 
-function getCustomUpdater (updater) {
+function getCustomUpdaterFromPath (updater) {
   return require(path.resolve(process.cwd(), updater))
 }
 
+/**
+ * Simple check to determine if the object provided is a compatible updater.
+ */
+function isValidUpdater (obj) {
+  return (
+    typeof obj.readVersion === 'function' &&
+    typeof obj.writeVersion === 'function'
+  )
+}
+
 module.exports.resolveUpdaterObjectFromArgument = function (arg) {
   /**
    * If an Object was not provided, we assume it's the path/filename
    * of the updater.
    */
   let updater = arg
+  if (isValidUpdater(updater)) {
+    return updater
+  }
   if (typeof updater !== 'object') {
     updater = {
       filename: arg
     }
   }
   try {
-    if (updater.updater) {
-      updater.updater = getCustomUpdater(updater.updater)
+    if (typeof updater.updater === 'string') {
+      updater.updater = getCustomUpdaterFromPath(updater.updater)
     } else if (updater.type) {
       updater.updater = getUpdaterByType(updater.type)
     } else {
       updater.updater = getUpdaterByFilename(updater.filename)
     }
   } catch (err) {
-    if (err.code !== 'ENOENT') console.warn(err.message)
+    if (err.code !== 'ENOENT') console.warn(`Unable to obtain updater for: ${JSON.stringify(arg)}\n - Error: ${err.message}\n - Skipping...`)
   }
   /**
    * We weren't able to resolve an updater for the argument.
    */
-  if (!updater.updater) {
+  if (!isValidUpdater(updater.updater)) {
     return false
   }
 

test.js

@@ -988,6 +988,28 @@ describe('standard-version', function () {
           fs.readFileSync('VERSION_TRACKER.txt', 'utf-8').should.equal('6.4.0')
         })
     })
+
+    it('`packageFiles` are bumped along with `bumpFiles` defaults [standard-version#533]', function () {
+      fs.writeFileSync('.gitignore', '', 'utf-8')
+      fs.mkdirSync('./dist')
+      fs.copyFileSync('../test/mocks/manifest-6.3.1.json', './dist/manifest.json')
+      writePackageLockJson('1.0.0')
+      commit('feat: yet another commit')
+      return require('./index')({
+        silent: true,
+        packageFiles: [
+          {
+            filename: './dist/manifest.json',
+            type: 'json'
+          }
+        ]
+      })
+        .then(() => {
+          JSON.parse(fs.readFileSync('./dist/manifest.json', 'utf-8')).version.should.equal('6.4.0')
+          JSON.parse(fs.readFileSync('package.json', 'utf-8')).version.should.equal('6.4.0')
+          JSON.parse(fs.readFileSync('package-lock.json', 'utf-8')).version.should.equal('6.4.0')
+        })
+    })
   })
 
   describe('npm-shrinkwrap.json support', function () {

test/mocks/manifest-6.3.1.json

@@ -0,0 +1,3 @@
+{
+  "version": "6.3.1"
+}