/
index.js
107 lines (95 loc) · 3.26 KB
/
index.js
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
'use strict'
const dedent = require('dedent')
const cosmiconfig = require('cosmiconfig')
const stringifyObject = require('stringify-object')
const printErrors = require('./printErrors')
const runAll = require('./runAll')
const validateConfig = require('./validateConfig')
const debugLog = require('debug')('lint-staged')
const errConfigNotFound = new Error('Config could not be found')
function resolveConfig(configPath) {
try {
return require.resolve(configPath)
} catch (ignore) {
return configPath
}
}
function loadConfig(configPath) {
const explorer = cosmiconfig('lint-staged', {
searchPlaces: [
'package.json',
'.lintstagedrc',
'.lintstagedrc.json',
'.lintstagedrc.yaml',
'.lintstagedrc.yml',
'.lintstagedrc.js',
'lint-staged.config.js'
]
})
return configPath ? explorer.load(resolveConfig(configPath)) : explorer.search()
}
/**
* @typedef {(...any) => void} LogFunction
* @typedef {{ error: LogFunction, log: LogFunction, warn: LogFunction }} Logger
*
* Root lint-staged function that is called from `bin/lint-staged`.
*
* @param {object} options
* @param {string} [options.configPath] - Path to configuration file
* @param {boolean} [options.shell] - Use execa’s shell mode to execute linter commands
* @param {boolean} [options.quiet] - Use Listr’s silent renderer
* @param {boolean} [options.debug] - Enable debug mode
* @param {Logger} [logger]
*
* @returns {Promise<boolean>} Promise of whether the linting passed or failed
*/
module.exports = function lintStaged(
{ configPath, shell = false, quiet = false, debug = false } = {},
logger = console
) {
debugLog('Loading config using `cosmiconfig`')
return loadConfig(configPath)
.then(result => {
if (result == null) throw errConfigNotFound
debugLog('Successfully loaded config from `%s`:\n%O', result.filepath, result.config)
// result.config is the parsed configuration object
// result.filepath is the path to the config file that was found
const config = validateConfig(result.config)
if (debug) {
// Log using logger to be able to test through `consolemock`.
logger.log('Running lint-staged with the following config:')
logger.log(stringifyObject(config, { indent: ' ' }))
} else {
// We might not be in debug mode but `DEBUG=lint-staged*` could have
// been set.
debugLog('Normalized config:\n%O', config)
}
return runAll(config, shell, quiet, debug, logger)
.then(() => {
debugLog('linters were executed successfully!')
return Promise.resolve(true)
})
.catch(error => {
printErrors(error, logger)
return Promise.resolve(false)
})
})
.catch(err => {
if (err === errConfigNotFound) {
logger.error(`${err.message}.`)
} else {
// It was probably a parsing error
logger.error(dedent`
Could not parse lint-staged config.
${err}
`)
}
logger.error() // empty line
// Print helpful message for all errors
logger.error(dedent`
Please make sure you have created it correctly.
See https://github.com/okonet/lint-staged#configuration.
`)
return Promise.reject(err)
})
}