/
standalone.js
312 lines (258 loc) · 8 KB
/
standalone.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
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
'use strict';
const debug = require('debug')('stylelint:standalone');
const fastGlob = require('fast-glob');
const fs = require('fs');
const globby = require('globby');
const normalizePath = require('normalize-path');
const path = require('path');
const createStylelint = require('./createStylelint');
const createPartialStylelintResult = require('./createPartialStylelintResult');
const filterFilePaths = require('./utils/filterFilePaths');
const formatters = require('./formatters');
const getFileIgnorer = require('./utils/getFileIgnorer');
const getFormatterOptionsText = require('./utils/getFormatterOptionsText');
const lintSource = require('./lintSource');
const NoFilesFoundError = require('./utils/noFilesFoundError');
const AllFilesIgnoredError = require('./utils/allFilesIgnoredError');
const { assert } = require('./utils/validateTypes');
const prepareReturnValue = require('./prepareReturnValue');
const ALWAYS_IGNORED_GLOBS = ['**/node_modules/**'];
const writeFileAtomic = require('write-file-atomic');
/** @typedef {import('stylelint').Formatter} Formatter */
/** @typedef {import('stylelint').FormatterType} FormatterType */
/**
* @type {import('stylelint').default['lint']}
*/
async function standalone({
allowEmptyInput = false,
cache: useCache = false,
cacheLocation,
cacheStrategy,
code,
codeFilename,
config,
configBasedir,
configFile,
customSyntax,
cwd = process.cwd(),
disableDefaultIgnores,
files,
fix,
formatter,
globbyOptions,
ignoreDisables,
ignorePath,
ignorePattern,
maxWarnings,
quiet,
reportDescriptionlessDisables,
reportInvalidScopeDisables,
reportNeedlessDisables,
}) {
const startTime = Date.now();
const isValidCode = typeof code === 'string';
if ((!files && !isValidCode) || (files && (code || isValidCode))) {
return Promise.reject(
new Error('You must pass stylelint a `files` glob or a `code` string, though not both'),
);
}
// The ignorer will be used to filter file paths after the glob is checked,
// before any files are actually read
/** @type {import('ignore').Ignore} */
let ignorer;
try {
ignorer = getFileIgnorer({ cwd, ignorePath, ignorePattern });
} catch (error) {
return Promise.reject(error);
}
/** @type {Formatter} */
let formatterFunction;
try {
formatterFunction = getFormatterFunction(formatter);
} catch (error) {
return Promise.reject(error);
}
const stylelint = createStylelint({
cacheLocation,
cacheStrategy,
config,
configFile,
configBasedir,
cwd,
ignoreDisables,
ignorePath,
reportNeedlessDisables,
reportInvalidScopeDisables,
reportDescriptionlessDisables,
customSyntax,
fix,
quiet,
});
if (!files) {
const absoluteCodeFilename =
codeFilename !== undefined && !path.isAbsolute(codeFilename)
? path.join(cwd, codeFilename)
: codeFilename;
// if file is ignored, return nothing
if (
absoluteCodeFilename &&
!filterFilePaths(ignorer, [path.relative(cwd, absoluteCodeFilename)]).length
) {
return prepareReturnValue([], maxWarnings, formatterFunction, cwd);
}
let stylelintResult;
try {
const postcssResult = await lintSource(stylelint, {
code,
codeFilename: absoluteCodeFilename,
});
stylelintResult = createPartialStylelintResult(postcssResult);
} catch (error) {
stylelintResult = handleError(error);
}
const postcssResult = stylelintResult._postcssResult;
const returnValue = prepareReturnValue([stylelintResult], maxWarnings, formatterFunction, cwd);
if (
fix &&
postcssResult &&
!postcssResult.stylelint.ignored &&
!postcssResult.stylelint.ruleDisableFix
) {
returnValue.output =
!postcssResult.stylelint.disableWritingFix && postcssResult.opts
? // If we're fixing, the output should be the fixed code
postcssResult.root.toString(postcssResult.opts.syntax)
: // If the writing of the fix is disabled, the input code is returned as-is
code;
}
return returnValue;
}
let fileList = [files].flat().map((entry) => {
const globCWD = (globbyOptions && globbyOptions.cwd) || cwd;
const absolutePath = !path.isAbsolute(entry)
? path.join(globCWD, entry)
: path.normalize(entry);
if (fs.existsSync(absolutePath)) {
// This path points to a file. Return an escaped path to avoid globbing
return fastGlob.escapePath(normalizePath(entry));
}
return entry;
});
if (!disableDefaultIgnores) {
fileList = fileList.concat(ALWAYS_IGNORED_GLOBS.map((glob) => `!${glob}`));
}
if (!useCache) {
stylelint._fileCache.destroy();
}
const effectiveGlobbyOptions = {
cwd,
...(globbyOptions || {}),
absolute: true,
};
const globCWD = effectiveGlobbyOptions.cwd;
let filePaths = await globby(fileList, effectiveGlobbyOptions);
// Record the length of filePaths before ignore operation
// Prevent prompting "No files matching the pattern 'xx' were found." when .stylelintignore ignore all input files
const filePathsLengthBeforeIgnore = filePaths.length;
// The ignorer filter needs to check paths relative to cwd
filePaths = filterFilePaths(
ignorer,
filePaths.map((p) => path.relative(globCWD, p)),
);
let stylelintResults;
if (filePaths.length) {
let absoluteFilePaths = filePaths.map((filePath) => {
const absoluteFilepath = !path.isAbsolute(filePath)
? path.join(globCWD, filePath)
: path.normalize(filePath);
return absoluteFilepath;
});
const getStylelintResults = absoluteFilePaths.map(async (absoluteFilepath) => {
debug(`Processing ${absoluteFilepath}`);
try {
const postcssResult = await lintSource(stylelint, {
filePath: absoluteFilepath,
cache: useCache,
});
if (
(postcssResult.stylelint.stylelintError || postcssResult.stylelint.stylelintWarning) &&
useCache
) {
debug(`${absoluteFilepath} contains linting errors and will not be cached.`);
stylelint._fileCache.removeEntry(absoluteFilepath);
}
/**
* If we're fixing, save the file with changed code
*/
if (
postcssResult.root &&
postcssResult.opts &&
!postcssResult.stylelint.ignored &&
fix &&
!postcssResult.stylelint.disableWritingFix
) {
const fixedCss = postcssResult.root.toString(postcssResult.opts.syntax);
if (
postcssResult.root &&
postcssResult.root.source &&
postcssResult.root.source.input.css !== fixedCss
) {
await writeFileAtomic(absoluteFilepath, fixedCss);
}
}
return createPartialStylelintResult(postcssResult);
} catch (error) {
// On any error, we should not cache the lint result
stylelint._fileCache.removeEntry(absoluteFilepath);
return handleError(error);
}
});
stylelintResults = await Promise.all(getStylelintResults);
} else if (allowEmptyInput) {
stylelintResults = await Promise.all([]);
} else if (filePathsLengthBeforeIgnore) {
// All input files ignored
stylelintResults = await Promise.reject(new AllFilesIgnoredError());
} else {
stylelintResults = await Promise.reject(new NoFilesFoundError(fileList));
}
if (useCache) {
stylelint._fileCache.reconcile();
}
const result = prepareReturnValue(stylelintResults, maxWarnings, formatterFunction, cwd);
debug(`Linting complete in ${Date.now() - startTime}ms`);
return result;
}
/**
* @param {FormatterType | Formatter | undefined} selected
* @returns {Formatter}
*/
function getFormatterFunction(selected) {
if (typeof selected === 'string') {
const formatterFunction = formatters[selected];
if (formatterFunction === undefined) {
throw new Error(
`You must use a valid formatter option: ${getFormatterOptionsText()} or a function`,
);
}
return formatterFunction;
}
if (typeof selected === 'function') {
return selected;
}
assert(formatters.json);
return formatters.json;
}
/**
* @typedef {import('stylelint').CssSyntaxError} CssSyntaxError
*
* @param {unknown} error
* @return {import('stylelint').LintResult}
*/
function handleError(error) {
if (error instanceof Error && error.name === 'CssSyntaxError') {
return createPartialStylelintResult(undefined, /** @type {CssSyntaxError} */ (error));
}
throw error;
}
module.exports = standalone;