-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
config.js
124 lines (116 loc) · 3.53 KB
/
config.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
'use strict';
/**
* Responsible for loading / finding Mocha's "rc" files.
* This doesn't have anything to do with `mocha.opts`.
*
* @private
* @module
*/
const fs = require('fs');
const findUp = require('find-up');
const path = require('path');
const debug = require('debug')('mocha:cli:config');
const utils = require('../utils');
/**
* These are the valid config files, in order of precedence;
* e.g., if `.mocharc.js` is present, then `.mocharc.yaml` and the rest
* will be ignored.
* The user should still be able to explicitly specify a file.
* @private
*/
exports.CONFIG_FILES = [
'.mocharc.js',
'.mocharc.yaml',
'.mocharc.yml',
'.mocharc.jsonc',
'.mocharc.json'
];
/**
* Parsers for various config filetypes. Each accepts a filepath and
* returns an object (but could throw)
*
* Filepath *must* be absolute; external logic resolves relative paths.
*/
const parsers = (exports.parsers = {
yaml: filepath =>
require('js-yaml').safeLoad(fs.readFileSync(filepath, 'utf8')),
js: filepath => require(filepath),
json: filepath =>
JSON.parse(
require('strip-json-comments')(fs.readFileSync(filepath, 'utf8'))
)
});
/**
* Loads and parses, based on file extension, a config file.
* "JSON" files may have comments.
* @param {string} filepath - Config file path or module name to load
* @returns {Object} Parsed config object
* @private
*/
exports.loadConfig = filepath => {
const {absFilepath, discoveryMethod} = exports.resolveConfigPath(filepath);
return exports.parseConfig(absFilepath, discoveryMethod);
};
/**
* Resolve the location of a config on disk and the method of discovery:
* cwd-relative path or require.resolve
*
* As opposed to findConfig, this does not ascend the filesystem.
* When the user specifies `--config`, findConfig is not called, but
* `resolveConfigPath` is still called.
*
* @param {string} filepath - Config file path or module name to load
* @private
*/
exports.resolveConfigPath = filepath => {
/** @type {'cwd-relative' | 'node-require-resolve'} */
let discoveryMethod = 'cwd-relative';
let absFilepath = path.resolve(filepath);
if (!fs.existsSync(absFilepath) || fs.statSync(absFilepath).isDirectory()) {
discoveryMethod = 'node-require-resolve';
try {
absFilepath = utils.requireResolveRelative(filepath);
} catch (e) {
throw new Error(
`failed to locate ${filepath} as either a relative path or a require()-able node module`
);
}
}
return {discoveryMethod, absFilepath};
};
/**
* @param {string} absFilepath absolute path to config file
* @param {'cwd-relative' | 'node-require-resolve'} discoveryMethod
*/
exports.parseConfig = (absFilepath, discoveryMethod) => {
let config = {};
const ext = path.extname(absFilepath);
try {
if (discoveryMethod === 'node-require-resolve') {
config = require(absFilepath);
} else if (/\.ya?ml/.test(ext)) {
config = parsers.yaml(absFilepath);
} else if (ext === '.js') {
config = parsers.js(absFilepath);
} else {
config = parsers.json(absFilepath);
}
} catch (err) {
throw new Error(
`failed to parse ${path.relative(process.cwd(), absFilepath)}: ${err}`
);
}
return config;
};
/**
* Find ("find up") config file starting at `cwd`
* @param {string} [cwd] - Current working directory
* @returns {string|null} Filepath to config, if found
*/
exports.findConfig = (cwd = process.cwd()) => {
const filepath = findUp.sync(exports.CONFIG_FILES, {cwd});
if (filepath) {
debug(`found config at ${filepath}`);
}
return filepath;
};