/
index.ts
193 lines (163 loc) · 4.95 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
import fs from 'fs'
import path from 'path'
import pkgDir from 'pkg-dir'
import getConf from '../getConf'
import getScript from './getScript'
import { isGhooks, isHusky, isPreCommit, isYorkie } from './is'
const hookList = [
'applypatch-msg',
'pre-applypatch',
'post-applypatch',
'pre-commit',
'prepare-commit-msg',
'commit-msg',
'post-commit',
'pre-rebase',
'post-checkout',
'post-merge',
'pre-push',
'pre-receive',
'update',
'post-receive',
'post-update',
'push-to-checkout',
'pre-auto-gc',
'post-rewrite',
'sendemail-validate'
]
function writeHook(filename: string, script: string): void {
fs.writeFileSync(filename, script, 'utf-8')
fs.chmodSync(filename, 0o0755)
}
function createHook(filename: string, script: string): void {
// Get name, used for logging
const name = path.basename(filename)
// Check if hook exist
if (fs.existsSync(filename)) {
const hook = fs.readFileSync(filename, 'utf-8')
// Migrate
if (isGhooks(hook)) {
console.log(`migrating existing ghooks script: ${name}`)
return writeHook(filename, script)
}
// Migrate
if (isPreCommit(hook)) {
console.log(`migrating existing pre-commit script: ${name}`)
return writeHook(filename, script)
}
// Update
if (isHusky(hook) || isYorkie(hook)) {
return writeHook(filename, script)
}
// Skip
console.log(`skipping existing user hook: ${name}`)
return
}
// Create hook if it doesn't exist
writeHook(filename, script)
}
function createHooks(filenames: string[], script: string): void {
filenames.forEach((filename: string): void => createHook(filename, script))
}
function canRemove(filename: string): boolean {
if (fs.existsSync(filename)) {
const data = fs.readFileSync(filename, 'utf-8')
return isHusky(data)
}
return false
}
function removeHook(filename: string): void {
fs.unlinkSync(filename)
}
function removeHooks(filenames: string[]): void {
filenames.filter(canRemove).forEach(removeHook)
}
// This prevents the case where someone would want to debug a node_module that has
// husky as devDependency and run npm install from node_modules directory
function isInNodeModules(dir: string): boolean {
// INIT_CWD holds the full path you were in when you ran npm install (supported also by yarn and pnpm)
// See https://docs.npmjs.com/cli/run-script
if (process.env.INIT_CWD) {
return process.env.INIT_CWD.indexOf('node_modules') !== -1
}
// Old technique
return (dir.match(/node_modules/g) || []).length > 1
}
function getHooks(gitDir: string): string[] {
const gitHooksDir = path.join(gitDir, 'hooks')
return hookList.map((hookName: string): string =>
path.join(gitHooksDir, hookName)
)
}
/**
* @param topLevel - as returned by git --rev-parse
* @param gitDir - as returned by git --rev-parse
* @param huskyDir - e.g. /home/typicode/project/node_modules/husky/
* @param isCI - true if running in CI
* @param requireRunNodePath - path to run-node resolved by require e.g. /home/typicode/project/node_modules/run-node/run-node
*/
// eslint-disable-next-line max-params
export function install(
topLevel: string,
gitDir: string,
huskyDir: string,
isCI: boolean,
requireRunNodePath = require.resolve('run-node/run-node')
): void {
// First directory containing user's package.json
const userPkgDir = pkgDir.sync(path.join(huskyDir, '..'))
if (userPkgDir === undefined) {
console.log("Can't find package.json, skipping Git hooks installation.")
console.log(
'Please check that your project has a package.json or create it and reinstall husky.'
)
return
}
// Get conf from package.json or .huskyrc
const conf = getConf(userPkgDir)
// Checks
if (['1', 'true'].includes(process.env.HUSKY_SKIP_INSTALL || '')) {
console.log(
"HUSKY_SKIP_INSTALL environment variable is set to 'true',",
'skipping Git hooks installation.'
)
return
}
if (isCI && conf.skipCI) {
console.log('CI detected, skipping Git hooks installation.')
return
}
if (isInNodeModules(huskyDir)) {
console.log(
'Trying to install from node_modules directory, skipping Git hooks installation.'
)
return
}
// Create hooks directory if it doesn't exist
const gitHooksDir = path.join(gitDir, 'hooks')
if (!fs.existsSync(gitHooksDir)) {
fs.mkdirSync(gitHooksDir)
}
const hooks = getHooks(gitDir)
const script = getScript(topLevel, huskyDir, requireRunNodePath)
createHooks(hooks, script)
console.log(`husky > Done`)
}
export function uninstall(gitDir: string, huskyDir: string): void {
if (gitDir === null) {
console.log(
"Can't find resolved .git directory, skipping Git hooks uninstallation."
)
return
}
if (isInNodeModules(huskyDir)) {
console.log(
'Trying to uninstall from node_modules directory, skipping Git hooks uninstallation.'
)
return
}
// Remove hooks
const hooks = getHooks(gitDir)
removeHooks(hooks)
console.log('husky > Done')
}