feat(husky): warned about usage of legacy hook definitions

.eslintrc.yml

@@ -1,3 +1,8 @@
 extends:
   - '@form8ion'
-  - '@form8ion/mocha'
+  - '@form8ion/mocha'
+
+overrides:
+  - files: example.js
+    rules:
+      import/no-extraneous-dependencies: off

example.js

@@ -1,5 +1,13 @@
+// #### Import
+// remark-usage-ignore-next
+import stubbedFs from 'mock-fs';
 import {patrol} from './lib/index.cjs';
 
+// remark-usage-ignore-next
+stubbedFs();
+
 (async () => {
   await patrol();
+  // remark-usage-ignore-next
+  stubbedFs.restore();
 })();

package.json

@@ -53,6 +53,7 @@
     "husky": "4.2.5",
     "lockfile-lint": "4.2.2",
     "mocha": "7.1.2",
+    "mock-fs": "^4.12.0",
     "npm-run-all": "4.1.5",
     "nyc": "15.0.1",
     "remark-cli": "8.0.0",
@@ -63,5 +64,8 @@
     "rollup-plugin-auto-external": "2.0.0",
     "sinon": "9.0.2",
     "travis-lint": "1.0.0"
+  },
+  "dependencies": {
+    "@travi/cli-messages": "^1.0.4"
   }
 }

src/husky-test.js

@@ -0,0 +1,60 @@
+import {promises as fs} from 'fs';
+import * as cliMessages from '@travi/cli-messages';
+import sinon from 'sinon';
+import {assert} from 'chai';
+import any from '@travi/any';
+import husky from './husky';
+
+suite('husky', () => {
+  let sandbox;
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(fs, 'readFile');
+    sandbox.stub(cliMessages, 'warn');
+  });
+
+  teardown(() => sandbox.restore());
+
+  test('that no problem is reported when the legacy hooks are not used', async () => {
+    const projectRoot = any.string();
+    fs.readFile
+      .withArgs(`${projectRoot}/package.json`, 'utf8')
+      .resolves(JSON.stringify({scripts: any.simpleObject()}));
+
+    await husky(projectRoot);
+
+    assert.notCalled(cliMessages.warn);
+  });
+
+  test('that a warning is provided if a legacy `precommit` hook is defined', async () => {
+    const projectRoot = any.string();
+    fs.readFile
+      .withArgs(`${projectRoot}/package.json`, 'utf8')
+      .resolves(JSON.stringify({scripts: {precommit: any.sentence()}}));
+
+    await husky(projectRoot);
+
+    assert.calledWith(cliMessages.warn, '`precommit` npm script found. This approach has been deprecated by `husky`');
+    assert.neverCalledWith(
+      cliMessages.warn,
+      '`commitmsg` npm script found. This approach has been deprecated by `husky`'
+    );
+  });
+
+  test('that a warning is provided if a legacy `commitmsg` hook is defined', async () => {
+    const projectRoot = any.string();
+    fs.readFile
+      .withArgs(`${projectRoot}/package.json`, 'utf8')
+      .resolves(JSON.stringify({scripts: {commitmsg: any.sentence()}}));
+
+    await husky(projectRoot);
+
+    assert.neverCalledWith(
+      cliMessages.warn,
+      '`precommit` npm script found. This approach has been deprecated by `husky`'
+    );
+    assert.calledWith(cliMessages.warn, '`commitmsg` npm script found. This approach has been deprecated by `husky`');
+  });
+});

src/husky.js

@@ -1,3 +1,9 @@
-export default function () {
+import {promises as fs} from 'fs';
+import {warn} from '@travi/cli-messages';
 
+export default async function (projectRoot) {
+  const {scripts} = JSON.parse(await fs.readFile(`${projectRoot}/package.json`, 'utf8'));
+
+  if (scripts.precommit) warn('`precommit` npm script found. This approach has been deprecated by `husky`');
+  if (scripts.commitmsg) warn('`commitmsg` npm script found. This approach has been deprecated by `husky`');
 }