0.14 (#142)

0.14

Author: typicode

CHANGELOG.md

@@ -1,10 +1,12 @@
 # CHANGELOG
 
-## Unreleased
+## 0.14.0
 
-* Add Git worktree support
-* Drop Node 0.12 support
-* Don't reload nvm if it's already in PATH
+* Fix `npm@5` `Error: Cannot find module` warning when uninstalling
+* Drop `Node 0.12` support
+* Don't reload `nvm` if it's already in `PATH`
+* Add Git worktree support [#114](https://github.com/typicode/husky/pull/114)
+* Hide irrelevant `--no-verify` message for `prepare-commit-msg` [#137](https://github.com/typicode/husky/issues/137)
 
 ## 0.13.4
 

README.md

@@ -74,15 +74,15 @@ Git params can be found in `GIT_PARAMS` environment variable.
 
 ### Setting a different log level
 
-By default, husky will run scripts using `--silent` to make the output more readable. If you want to override this, simply pass a different log level to your scripts: 
+By default, husky will run scripts using `--silent` to make the output more readable. If you want to override this, simply pass a different log level to your scripts:
 
 ```json
 "precommit": "npm run some-script -q"
 ```
 
 _`-q/--quiet` is equivalent to `--loglevel warn` which is npm default log level._
 
-### Git submodule support
+### Git submodule and subtree support
 
 Yes
 
@@ -102,4 +102,4 @@ Please use `yarn` `v0.24+`
 
 ## License
 
-MIT - [Typicode :cactus:](https://github.com/typicode)
+MIT - [Typicode :cactus:](https://github.com/typicode) - [Patreon](https://www.patreon.com/typicode)

__tests__/index.js

@@ -0,0 +1,160 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+const mock = require('mock-fs')
+const installFrom = require('../src/install')
+const uninstallFrom = require('../src/uninstall')
+
+const gitDir = '/.git'
+
+function readHook(hookPath) {
+  return fs.readFileSync(path.join(gitDir, hookPath), 'utf-8')
+}
+
+function exists(hookPath) {
+  return fs.existsSync(path.join(gitDir, hookPath))
+}
+
+describe('husky', function() {
+  afterEach(function() {
+    mock.restore()
+  })
+
+  it('should support basic layout', function() {
+    mock({
+      '/.git/hooks': {},
+      '/node_modules/husky': {}
+    })
+
+    installFrom('/node_modules/husky')
+    const hook = readHook('hooks/pre-commit')
+
+    expect(hook).toMatch('#husky')
+    expect(hook).toMatch('cd .')
+    expect(hook).toMatch('npm run -s precommit')
+    expect(hook).toMatch('--no-verify')
+
+    const prepareCommitMsg = readHook('hooks/prepare-commit-msg')
+    expect(prepareCommitMsg).toMatch('cannot be bypassed')
+
+    uninstallFrom('/node_modules/husky')
+    expect(exists('hooks/pre-push')).toBeFalsy()
+  })
+
+  it('should support project installed in sub directory', function() {
+    mock({
+      '/.git/hooks': {},
+      '/A/B/node_modules/husky': {}
+    })
+
+    installFrom('/A/B/node_modules/husky')
+    const hook = readHook('hooks/pre-commit')
+
+    expect(hook).toMatch('cd A/B')
+
+    uninstallFrom('/A/B/node_modules/husky')
+    expect(exists('hooks/pre-push')).toBeFalsy()
+  })
+
+  it('should support git submodule', function() {
+    mock({
+      '/.git/modules/A/B': {},
+      '/A/B/.git': 'git: ../../.git/modules/A/B',
+      '/A/B/node_modules/husky': {}
+    })
+
+    installFrom('/A/B/node_modules/husky')
+    const hook = readHook('modules/A/B/hooks/pre-commit')
+
+    expect(hook).toMatch('cd .')
+
+    uninstallFrom('/A/B/node_modules/husky')
+    expect(exists('hooks/pre-push')).toBeFalsy()
+  })
+
+  it('should support git submodule and sub directory', function() {
+    mock({
+      '/.git/modules/A/B': {},
+      '/A/B/.git': 'git: ../../.git/modules/A/B',
+      '/A/B/C/node_modules/husky': {}
+    })
+
+    installFrom('/A/B/C/node_modules/husky')
+    const hook = readHook('modules/A/B/hooks/pre-commit')
+
+    expect(hook).toMatch('cd C')
+
+    uninstallFrom('/A/B/app/node_modules/husky')
+    expect(exists('hooks/pre-push')).toBeFalsy()
+  })
+
+  it('should support git worktrees', function() {
+    mock({
+      '/.git/worktrees/B': {},
+      '/A/B/.git': 'git: /.git/worktrees/B',
+      '/A/B/node_modules/husky': {}
+    })
+
+    installFrom('/A/B/node_modules/husky')
+    const hook = readHook('worktrees/B/hooks/pre-commit')
+
+    expect(hook).toMatch('cd .')
+
+    uninstallFrom('/A/B/node_modules/husky')
+    expect(exists('hooks/pre-commit')).toBeFalsy()
+  })
+
+  it('should not modify user hooks', function() {
+    mock({
+      '/.git/hooks': {},
+      '/.git/hooks/pre-push': 'foo',
+      '/node_modules/husky': {}
+    })
+
+    // Verify that it's not overwritten
+    installFrom('/node_modules/husky')
+    const hook = readHook('hooks/pre-push')
+    expect(hook).toBe('foo')
+
+    uninstallFrom('/node_modules/husky')
+    expect(exists('hooks/pre-push')).toBeTruthy()
+  })
+
+  it('should not install from /node_modules/A/node_modules', function() {
+    mock({
+      '/.git/hooks': {},
+      '/node_modules/A/node_modules/husky': {}
+    })
+
+    installFrom('/node_modules/A/node_modules/husky')
+    expect(exists('hooks/pre-push')).toBeFalsy()
+  })
+
+  it("should not crash if there's no .git directory", function() {
+    mock({
+      '/node_modules/husky': {}
+    })
+
+    expect(function() {
+      installFrom('/node_modules/husky')
+    }).not.toThrow()
+
+    expect(function() {
+      uninstallFrom('/node_modules/husky')
+    }).not.toThrow()
+  })
+
+  it('should migrate ghooks scripts', function() {
+    mock({
+      '/.git/hooks/pre-commit':
+        '// Generated by ghooks. Do not edit this file.',
+      '/node_modules/husky': {}
+    })
+
+    installFrom('/node_modules/husky')
+    const hook = readHook('hooks/pre-commit')
+    expect(hook).toMatch('husky')
+    expect(hook).not.toMatch('ghooks')
+  })
+})

appveyor.yml

@@ -0,0 +1,21 @@
+# Test against the latest version of this Node.js version
+environment:
+  nodejs_version: "8"
+
+# Install scripts. (runs after repo cloning)
+install:
+  # Get the latest stable version of Node.js or io.js
+  - ps: Install-Product node $env:nodejs_version
+  # install modules
+  - npm install
+
+# Post-install test scripts.
+test_script:
+  # Output useful info for debugging.
+  - node --version
+  - npm --version
+  # run tests
+  - npm test
+
+# Don't actually build.
+build: off

bin/install.js

@@ -1,17 +1,18 @@
+'use strict'
+
 // Run when package is installed
-var path = require('path')
-var chalk = require('chalk')
-var isCI = require('is-ci')
-var husky = require('../src/')
+const path = require('path')
+const isCI = require('is-ci')
+const installFrom = require('../src/install')
 
-console.log(chalk.cyan.underline('husky'))
+console.log('husky')
 
 if (isCI) {
   console.log('CI detected, skipping Git hooks installation')
   process.exit(0)
 }
 
-console.log('setting up hooks')
+console.log('setting up Git hooks')
 
-var huskyDir = path.join(__dirname, '..')
-husky.installFrom(huskyDir)
+const huskyDir = path.join(__dirname, '..')
+installFrom(huskyDir)

bin/uninstall.js

@@ -1,10 +1,11 @@
+'use strict'
+
 // Run when package is uninstalled
-var path = require('path')
-var chalk = require('chalk')
-var husky = require('../src/')
+const path = require('path')
+const uninstallFrom = require('../src/uninstall')
 
-console.log(chalk.cyan.underline('husky'))
-console.log('uninstalling')
+console.log('husky')
+console.log('uninstalling Git hooks')
 
-var huskyDir = path.join(__dirname, '..')
-husky.uninstallFrom(huskyDir)
+const huskyDir = path.join(__dirname, '..')
+uninstallFrom(huskyDir)

package.json

@@ -1,12 +1,13 @@
 {
   "name": "husky",
-  "version": "0.13.4",
+  "version": "0.14.0-1",
   "description": "Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...)",
-  "main": "./src/index.js",
+  "engines": {
+    "node": ">=4"
+  },
   "scripts": {
-    "test": "mocha && standard",
-    "precommit": "npm test",
-    "prepublish": "pkg-ok",
+    "test": "jest",
+    "format": "prettier --single-quote --no-semi --write **/*.js",
     "install": "node ./bin/install.js",
     "uninstall": "node ./bin/uninstall.js"
   },
@@ -35,22 +36,19 @@
   },
   "homepage": "https://github.com/typicode/husky",
   "devDependencies": {
-    "expect": "^1.20.2",
-    "mocha": "^3.2.0",
+    "jest": "^20.0.4",
     "mock-fs": "^4.4.1",
-    "pkg-ok": "^1.0.1",
-    "rimraf": "^2.2.8",
-    "standard": "^8.6.0"
+    "prettier": "^1.4.4",
+    "rimraf": "^2.2.8"
   },
   "dependencies": {
-    "chalk": "^1.1.3",
-    "find-parent-dir": "^0.3.0",
-    "is-ci": "^1.0.9",
-    "normalize-path": "^1.0.0"
+    "is-ci": "^1.0.10",
+    "normalize-path": "^1.0.0",
+    "strip-indent": "^2.0.0"
   },
   "standard": {
     "env": {
-      "mocha": true
+      "jest": true
     }
   }
 }