Add generated by informations in hook script (#400)

Author: typicode

src/installer/__tests__/__snapshots__/getScript.ts.snap

@@ -3,7 +3,16 @@
 exports[`hookScript should match snapshot (OS X/Linux) 1`] = `
 "#!/bin/sh
 # husky
-# v1.1.4 darwin
+
+# Hook created by Husky
+#   Version: 1.1.4
+#   At: <locale date string>
+#   See: https://github.com/typicode/husky#readme
+
+# From npm package
+#   Name: foo-package
+#   Directory: /home/typicode/projects/foo-package
+#   Homepage: https://github.com/foo/foo-package
 
 scriptPath=\\"node_modules/husky/run.js\\"
 hookName=\`basename \\"$0\\"\`
@@ -30,7 +39,16 @@ fi
 exports[`hookScript should match snapshot (Windows) 1`] = `
 "#!/bin/sh
 # husky
-# v1.1.4 win32
+
+# Hook created by Husky
+#   Version: 1.1.4
+#   At: <locale date string>
+#   See: https://github.com/typicode/husky#readme
+
+# From npm package
+#   Name: foo-package
+#   Directory: /home/typicode/projects/foo-package
+#   Homepage: https://github.com/foo/foo-package
 
 scriptPath=\\"node_modules/husky/run.js\\"
 hookName=\`basename \\"$0\\"\`

src/installer/__tests__/getScript.ts

@@ -1,12 +1,34 @@
 import getScript from '../getScript'
 
+// Mock Date to have deterministic test
+Date.now = jest.fn(() => 1482363367071)
+
 const rootDir = '/home/typicode/project'
 const huskyDir = '/home/typicode/project/node_modules/husky'
 
 // On OS X/Linux runNodePath gets resolved to the following value
 // In order to make the test deterministic on AppVeyor, the value is hardcoded
 const runNodePath = '/home/typicode/project/node_modules/run-node/run-node'
 
+// Faking env variable
+process.env = {
+  ...process.env,
+  PWD: '/home/typicode/projects/foo-package',
+  npm_package_homepage: 'https://github.com/foo/foo-package',
+  npm_package_name: 'foo-package'
+}
+
+// Mock Date.toLocaleString
+global.Date = class extends Date {
+  constructor() {
+    super()
+  }
+
+  public toLocaleString() {
+    return '<locale date string>'
+  }
+} as DateConstructor
+
 describe('hookScript', () => {
   it('should match snapshot (OS X/Linux)', () => {
     const script = getScript(rootDir, huskyDir, runNodePath, 'darwin')

src/installer/getScript.ts

@@ -4,9 +4,14 @@ import * as path from 'path'
 import * as slash from 'slash'
 
 interface IContext {
+  createdAt: string
+  homepage: string
   node: string
+  pkgDirectory?: string
+  pkgHomepage?: string
+  pkgName?: string
   platform: string
-  script: string
+  runScriptPath: string
   version: string
 }
 
@@ -17,11 +22,30 @@ export const huskyIdentifier = '# husky'
 const huskyrc = '~/.huskyrc'
 
 // Render script
-const render = ({ node, platform, script, version }: IContext) => `#!/bin/sh
+const render = ({
+  createdAt,
+  homepage,
+  node,
+  pkgDirectory,
+  pkgHomepage,
+  pkgName,
+  platform,
+  runScriptPath,
+  version
+}: IContext) => `#!/bin/sh
 ${huskyIdentifier}
-# v${version} ${platform}
 
-scriptPath="${script}.js"
+# Hook created by Husky
+#   Version: ${version}
+#   At: ${createdAt}
+#   See: ${homepage}
+
+# From npm package
+#   Name: ${pkgName}
+#   Directory: ${pkgDirectory}
+#   Homepage: ${pkgHomepage}
+
+scriptPath="${runScriptPath}.js"
 hookName=\`basename "$0"\`
 gitParams="$*"
 
@@ -64,11 +88,34 @@ export default function(
   // On Windows do not rely on run-node
   const node = platform === 'win32' ? 'node' : runNodePath
 
-  const { version } = JSON.parse(
+  // Env variable
+  const pkgName = process && process.env && process.env.npm_package_name
+  const pkgHomepage = process && process.env && process.env.npm_package_homepage
+  const pkgDirectory = process && process.env && process.env.PWD
+
+  // Husky package.json
+  const { homepage, version } = JSON.parse(
     fs.readFileSync(path.join(__dirname, '../../package.json'), 'utf-8')
   )
 
-  const script = slash(path.join(path.relative(rootDir, huskyDir), 'run'))
+  // Path to run.js
+  const runScriptPath = slash(
+    path.join(path.relative(rootDir, huskyDir), 'run')
+  )
+
+  // created at
+  const createdAt = new Date().toLocaleString()
 
-  return render({ node, platform, script, version })
+  // Render script
+  return render({
+    createdAt,
+    homepage,
+    node,
+    pkgDirectory,
+    pkgHomepage,
+    pkgName,
+    platform,
+    runScriptPath,
+    version
+  })
 }