Added Metalsmith CLI support for loading a .(c)js config. Reads from metalsmith.js as second default after metalsmith.json

Author: webketje

bin/metalsmith

@@ -7,7 +7,7 @@ const readFileSync = require('fs').readFileSync
 const Metalsmith = require('..')
 const { Command } = require('commander')
 const program = new Command()
-const { resolve, isAbsolute, dirname } = require('path')
+const { resolve, isAbsolute, dirname, extname } = require('path')
 const { isString, isObject } = require('../lib/helpers')
 
 const color = {
@@ -51,21 +51,38 @@ program.parse(process.argv)
 
 function buildCommand({ config, ...options }) {
   const dir = process.cwd()
-  const path = isAbsolute(config) ? config : resolve(dir, config)
+  let path = isAbsolute(config) ? config : resolve(dir, config)
 
   // Important addition of 2.5.x. Given local plugins with a relative path are written with __dirname in mind,
   // having a config-relative dir path makes sure the CLI runs properly
   // when the command is executed from a subfolder or outside of the ms directory
   const confRelativeDir = dirname(path)
-  if (!exists(path)) fatal(`could not find a ${config} configuration file.`)
+  if (!exists(path)) {
+    // commander only supports a single default, so we must set default manually here
+    if (exists(resolve(confRelativeDir, 'metalsmith.js'))) {
+      path = resolve(confRelativeDir, 'metalsmith.js')
+    } else {
+      fatal(`could not find a ${config} configuration file.`)
+    }
+  }
+
+  const format = extname(path).slice(1)
 
   let json
   try {
-    // requiring json is incompatible with ESM, however given the metalsmith CLI is not meant to be "imported" or used in an ESM flow,
-    // it is ok to keep it here for now
-    json = JSON.parse(readFileSync(path, 'utf-8'))
+    if (format === 'js' || format === 'cjs') {
+      json = require(path)
+      // when a JS file is required that forgets to export using exports or module.exports,
+      // node instead returns an empty object. Though Metalsmith should in theory consider this a valid config
+      // for a simple copy -> paste it is highly likely that this was not the user's intension
+      if (isObject(json) && Object.keys(json).length === 0) {
+        fatal(`it seems like ${config} is empty. Make sure it exports a metalsmith config object.`)
+      }
+    } else {
+      json = JSON.parse(readFileSync(path, 'utf-8'))
+    }
   } catch (e) {
-    fatal(`it seems like ${config} is malformed.`)
+    fatal(`it seems like ${config} is malformed or unsupported (ESM).`)
   }
 
   /**

test/fixtures/cli-js/config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  "source": "source",
+  "destination": "destination"
+}

test/fixtures/cli-js/config.mjs

@@ -0,0 +1,5 @@
+const config = {
+  "source": "source",
+  "destination": "destination"
+}
+export default config

test/fixtures/cli-js/destination/index.md

@@ -0,0 +1 @@
+body

test/fixtures/cli-js/expected/index.md

@@ -0,0 +1 @@
+body

test/fixtures/cli-js/metalsmith.js

@@ -0,0 +1,4 @@
+module.exports = {
+  "source": "source",
+  "destination": "destination"
+}

test/fixtures/cli-js/other-config.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  "source": "source",
+  "destination": "destination"
+}

test/fixtures/cli-js/overriden/index.md

@@ -0,0 +1 @@
+body

test/fixtures/cli-js/source/index.md

@@ -0,0 +1 @@
+body

test/index.js

@@ -1261,6 +1261,34 @@ describe('CLI', function () {
       })
     })
 
+    it('should grab config from <configname>.(c)js', function (done) {
+      let doneCounter = 0
+      exec(bin, { cwd: fixture('cli-js') }, function (err, stdout) {
+        if (err) return done(err)
+        equal(fixture('cli-js/destination'), fixture('cli-js/expected'))
+        assert(~stdout.indexOf('successfully built to '))
+        assert(~stdout.indexOf(fixture('cli-js/destination')))
+        if (doneCounter === 2) done()
+        else doneCounter += 1
+      })
+      exec(bin + ' -c config.cjs', { cwd: fixture('cli-js') }, function (err, stdout) {
+        if (err) return done(err)
+        equal(fixture('cli-js/destination'), fixture('cli-js/expected'))
+        assert(~stdout.indexOf('successfully built to '))
+        assert(~stdout.indexOf(fixture('cli-js/destination')))
+        if (doneCounter === 2) done()
+        else doneCounter += 1
+      })
+      exec(bin + ' -c other-config.cjs', { cwd: fixture('cli-js') }, function (err, stdout) {
+        if (err) return done(err)
+        equal(fixture('cli-js/destination'), fixture('cli-js/expected'))
+        assert(~stdout.indexOf('successfully built to '))
+        assert(~stdout.indexOf(fixture('cli-js/destination')))
+        if (doneCounter === 2) done()
+        else doneCounter += 1
+      })
+    })
+
     it('should require a plugin', function (done) {
       exec(bin, { cwd: fixture('cli-plugin-object') }, function (err, stdout) {
         if (err) return done(err)