feat: add commit-msg script

Author: jrolfs

package.json

@@ -20,7 +20,8 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "node src pre-commit"
+      "pre-commit": "node src pre-commit",
+      "commit-msg": "node src commit-msg"
     }
   },
   "files": [
@@ -47,6 +48,7 @@
     "@babel/preset-flow": "^7.8.3",
     "@babel/preset-react": "^7.8.3",
     "@babel/runtime": "^7.8.3",
+    "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "@commitlint/prompt": "^8.3.5",
     "@typescript-eslint/eslint-plugin": "^2.16.0",

src/__tests__/__snapshots__/index.js.snap

@@ -29,6 +29,7 @@ Usage: ../ [script] [--flags]
 Available Scripts:
   build
   ci-after-success
+  commit-msg
   commit
   format
   lint

src/scripts/__tests__/__snapshots__/commit-msg.js.snap

@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`commit-msg adds env flag with HUSKY_GIT_PARAMS when available 1`] = `commitlint --env HUSKY_GIT_PARAMS --config ./src/config/commitlint.config.js`;
+
+exports[`commit-msg calls @commitlint/cli with default args 1`] = `commitlint --config ./src/config/commitlint.config.js`;
+
+exports[`commit-msg does not use built-in config with --config 1`] = `commitlint`;
+
+exports[`commit-msg does not use built-in config with commitlint.config.js file 1`] = `commitlint`;
+
+exports[`commit-msg forwards args 1`] = `commitlint --config ./src/config/commitlint.config.js`;

src/scripts/__tests__/commit-msg.js

@@ -0,0 +1,66 @@
+import cases from 'jest-in-case'
+import {unquoteSerializer, winPathSerializer} from './helpers/serializers'
+
+expect.addSnapshotSerializer(unquoteSerializer)
+expect.addSnapshotSerializer(winPathSerializer)
+
+cases(
+  'commit-msg',
+  ({
+    args = [],
+    utils = require('../../utils'),
+    hasFile = () => false,
+    env = {},
+  }) => {
+    // beforeEach
+    const {sync: crossSpawnSyncMock} = require('cross-spawn')
+    const originalArgv = process.argv
+    const originalExit = process.exit
+    const originalEnv = process.env
+
+    Object.assign(utils, {
+      hasFile,
+      resolveBin: (modName, {executable = modName} = {}) => executable,
+    })
+
+    process.exit = jest.fn()
+    process.argv = ['node', '../commit-msg', ...args]
+    process.env = env
+
+    try {
+      // tests
+      require('../commit-msg')
+
+      expect(crossSpawnSyncMock).toHaveBeenCalledTimes(1)
+
+      const [call] = crossSpawnSyncMock.mock.calls
+      const [script, calledArgs] = call
+
+      expect([script, ...calledArgs].join(' ')).toMatchSnapshot()
+    } catch (error) {
+      throw error
+    } finally {
+      // afterEach
+      process.exit = originalExit
+      process.argv = originalArgv
+      process.env = originalEnv
+
+      jest.resetModules()
+    }
+  },
+  {
+    'calls @commitlint/cli with default args': {},
+    'does not use built-in config with --config': {
+      args: ['--config', './custom-config.js'],
+    },
+    'does not use built-in config with commitlint.config.js file': {
+      hasFile: filename => filename === 'commitlint.config.js',
+    },
+    'forwards args': {
+      args: ['--verbose'],
+    },
+    'adds env flag with HUSKY_GIT_PARAMS when available': {
+      env: {HUSKY_GIT_PARAMS: 'husky-git-params'},
+    },
+  },
+)

src/scripts/commit-msg.js

@@ -0,0 +1,30 @@
+const path = require('path')
+const spawn = require('cross-spawn')
+const {hasFile, resolveBin} = require('../utils')
+
+const args = process.argv.slice(2)
+const huskyGitParams = process.env.HUSKY_GIT_PARAMS
+
+const here = p => path.join(__dirname, p)
+const hereRelative = p => here(p).replace(process.cwd(), '.')
+
+const useBuiltinConfig =
+  !args.includes('--config') &&
+  !args.includes('-g') &&
+  !hasFile('commitlint.config.js')
+
+const env = huskyGitParams ? ['--env', 'HUSKY_GIT_PARAMS'] : []
+
+const config = useBuiltinConfig
+  ? ['--config', hereRelative('../config/commitlint.config.js')]
+  : []
+
+const result = spawn.sync(
+  resolveBin('@commitlint/cli', {executable: 'commitlint'}),
+  [...env, ...config],
+  {
+    stdio: 'inherit',
+  },
+)
+
+process.exit(result.status)