Merge branch 'MSE99-feat-more-opts#18' into main

Author: jsumners

.github/workflows/ci.yml

@@ -53,7 +53,11 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
+<<<<<<< HEAD
       - uses: fastify/github-action-merge-dependabot@v2.2.0
+=======
+      - uses: fastify/github-action-merge-dependabot@v2.1.1
+>>>>>>> 5e5da89adac942de074e909b4b65a8fcb2e53e72
         if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request' }}
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -2,3 +2,5 @@ node_modules
 npm-debug.log
 coverage
 .tern-port
+.nyc_output
+package-lock.json

README.md

@@ -113,6 +113,23 @@ or as `"pre-commit.{key}` key properties in the `package.json`:
 }
 ```
 
+Configuration can also be defined inside a standalone `.pre-commit.json` config file:
+
+```js
+{
+  "silent": true,
+  "colors": true,
+  "template": "./temp",
+  "run": [
+    "lint",
+    "test"
+  ]
+}
+```
+
+The contents of `.pre-commit.json` will be used in the place of whatever was defined in the `pre-commit` 
+or `precommit` property inside `package.json`.
+
 It's all the same. Different styles so use what matches your project. To learn
 more about the scripts, please read the official `npm` documentation:
 

index.js

@@ -6,6 +6,8 @@ const path = require('path')
 const util = require('util')
 const tty = require('tty')
 
+const fs = require('fs')
+
 /**
  * Representation of a hook runner.
  *
@@ -20,6 +22,7 @@ function Hook (fn, options) {
 
   this.options = options // Used for testing only. Ignore this. Don't touch.
   this.config = {} // pre-commit configuration from the `package.json`.
+  this.configFile = null // Actual contents of `pre-commit.json` if the user created one.
   this.json = {} // Actual content of the `package.json`.
   this.npm = '' // The location of the `npm` binary.
   this.git = '' // The location of the `git` binary.
@@ -77,7 +80,7 @@ Hook.prototype.exec = function exec (bin, args) {
  * @api private
  */
 Hook.prototype.parse = function parse () {
-  const pre = this.json['pre-commit'] || this.json.precommit
+  const pre = this.configFile || this.json['pre-commit'] || this.json.precommit
   const config = !Array.isArray(pre) && typeof pre === 'object' ? pre : {};
 
   ['silent', 'colors', 'template'].forEach(function each (flag) {
@@ -180,6 +183,21 @@ Hook.prototype.initialize = function initialize () {
   this.status = this.status.stdout.toString().trim()
   this.root = this.root.stdout.toString().trim()
 
+  if (fs.existsSync(path.join(this.root, '.pre-commit.json'))) {
+    let configFile
+
+    try {
+      const rawText = fs.readFileSync(path.join(this.root, '.pre-commit.json'), 'utf-8').toString()
+      configFile = JSON.parse(rawText)
+    } catch (e) {
+      return this.log(this.format(Hook.log.preCommitConfig, e.message), 1)
+    }
+
+    if (typeof configFile === 'object' && !Array.isArray(configFile)) {
+      this.configFile = configFile
+    }
+  }
+
   try {
     this.json = require(path.join(this.root, 'package.json'))
     this.parse()
@@ -282,6 +300,14 @@ Hook.log = {
     'Skipping the pre-commit hook.'
   ].join('\n'),
 
+  preCommitConfig: [
+    'Received an error while parsing or locating the `.pre-commit.json` file:',
+    '',
+    '  %s',
+    '',
+    'Skipping the pre-commit hook.'
+  ].join('\n'),
+
   run: [
     'We have nothing pre-commit hooks to run. Either you\'re missing the `scripts`',
     'in your `package.json` or have configured pre-commit to run nothing.',

package.json

@@ -36,6 +36,7 @@
   },
   "devDependencies": {
     "pre-commit": "git://github.com/observing/pre-commit.git",
+    "proxyquire": "^2.1.3",
     "standard": "^16.0.3",
     "tap": "^15.0.9"
   }

test.js

@@ -4,6 +4,8 @@ const Hook = require('./')
 const tty = require('tty')
 const ttySupportColor = tty.isatty(process.stdout.fd)
 
+const proxyquire = require('proxyquire')
+
 t.test('pre-commit', function (t) {
   t.plan(5)
 
@@ -24,7 +26,7 @@ t.test('pre-commit', function (t) {
   })
 
   t.test('#parse', function (t) {
-    t.plan(7)
+    t.plan(9)
 
     let hook
 
@@ -140,6 +142,61 @@ t.test('pre-commit', function (t) {
 
       t.strictSame(typeof hook.config.run, 'undefined')
     })
+
+    t.test('overrides the `pre-commit` config property in package.json with the config inside `.pre-commit.json` if it exists', function (t) {
+      t.plan(1)
+
+      const Hook = proxyquire('.', {
+        fs: {
+          existsSync () {
+            return true
+          },
+          readFileSync () {
+            const rawText = JSON.stringify({ run: ['lint', 'bench'] })
+            return Buffer.from(rawText)
+          }
+        }
+      })
+
+      hook = new Hook(function () {}, { ignorestatus: true })
+
+      // ----
+      t.same(hook.config.run, ['lint', 'bench'])
+    })
+
+    t.test('should properly handle errors while trying to read and parse the contents of `.pre-commit.json`', function (t) {
+      t.plan(4)
+
+      let Hook = proxyquire('.', {
+        fs: {
+          existsSync () {
+            return true
+          },
+          readFileSync () {
+            throw new Error()
+          }
+        }
+      })
+
+      hook = new Hook(exit)
+
+      Hook = proxyquire('.', {
+        fs: {
+          existsSync () { return true },
+          readFileSync () {
+            return Buffer.from('{ "bad": [json }')
+          }
+        }
+      })
+
+      hook = new Hook(exit)
+
+      // *****************
+      function exit (code, lines) {
+        t.not(lines.length, 0)
+        t.equal(code, 1)
+      }
+    })
   })
 
   t.test('#log', function (t) {