forked from stylelint/stylelint
/
getPostcssResult.js
184 lines (152 loc) · 4.96 KB
/
getPostcssResult.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
'use strict';
const LazyResult = require('postcss/lib/lazy-result').default;
const path = require('path');
const { default: postcss } = require('postcss');
const { promises: fs } = require('fs');
/** @typedef {import('postcss').Result} Result */
/** @typedef {import('postcss').Syntax} Syntax */
/** @typedef {import('stylelint').CustomSyntax} CustomSyntax */
/** @typedef {import('stylelint').GetPostcssOptions} GetPostcssOptions */
/** @typedef {import('stylelint').InternalApi} StylelintInternalApi */
const postcssProcessor = postcss();
/**
* @param {StylelintInternalApi} stylelint
* @param {GetPostcssOptions} options
*
* @returns {Promise<Result>}
*/
module.exports = async function getPostcssResult(stylelint, options = {}) {
const cached = options.filePath ? stylelint._postcssResultCache.get(options.filePath) : undefined;
if (cached) {
return cached;
}
if (stylelint._options.syntax) {
let error = 'The "syntax" option is no longer available. ';
error +=
stylelint._options.syntax === 'css'
? 'You can remove the "--syntax" CLI flag as stylelint will now parse files as CSS by default'
: `You should install an appropriate syntax, e.g. postcss-scss, and use the "customSyntax" option`;
return Promise.reject(new Error(error));
}
const syntax = options.customSyntax
? getCustomSyntax(options.customSyntax)
: cssSyntax(stylelint, options.filePath);
const postcssOptions = {
from: options.filePath,
syntax,
};
/** @type {string | undefined} */
let getCode;
if (options.code !== undefined) {
getCode = options.code;
} else if (options.filePath) {
getCode = await fs.readFile(options.filePath, 'utf8');
}
if (getCode === undefined) {
return Promise.reject(new Error('code or filePath required'));
}
if (options.codeProcessors && options.codeProcessors.length) {
if (stylelint._options.fix) {
console.warn(
'Autofix is incompatible with processors and will be disabled. Are you sure you need a processor?',
);
stylelint._options.fix = false;
}
const sourceName = options.code ? options.codeFilename : options.filePath;
for (const codeProcessor of options.codeProcessors) {
getCode = codeProcessor(getCode, sourceName);
}
}
const postcssResult = await new LazyResult(postcssProcessor, getCode, postcssOptions);
if (options.filePath) {
stylelint._postcssResultCache.set(options.filePath, postcssResult);
}
return postcssResult;
};
/**
* @param {CustomSyntax} customSyntax
* @returns {Syntax}
*/
function getCustomSyntax(customSyntax) {
let resolved;
if (typeof customSyntax === 'string') {
try {
resolved = require(customSyntax);
} catch (error) {
if (
error &&
typeof error === 'object' &&
// @ts-expect-error -- TS2571: Object is of type 'unknown'.
error.code === 'MODULE_NOT_FOUND' &&
// @ts-expect-error -- TS2571: Object is of type 'unknown'.
error.message.includes(customSyntax)
) {
console.error('Stylelint MODULE_NOT_FOUND', error);
throw new Error(
`Cannot resolve custom syntax module "${customSyntax}". Check that module "${customSyntax}" is available and spelled correctly.`,
);
}
throw error;
}
/*
* PostCSS allows for syntaxes that only contain a parser, however,
* it then expects the syntax to be set as the `parse` option.
*/
if (!resolved.parse) {
resolved = {
parse: resolved,
stringify: postcss.stringify,
};
}
return resolved;
}
if (typeof customSyntax === 'object') {
if (typeof customSyntax.parse === 'function') {
resolved = { ...customSyntax };
} else {
throw new TypeError(
`An object provided to the "customSyntax" option must have a "parse" property. Ensure the "parse" property exists and its value is a function.`,
);
}
return resolved;
}
throw new Error(`Custom syntax must be a string or a Syntax object`);
}
/** @type {{ [key: string]: string }} */
const previouslyInferredExtensions = {
html: 'postcss-html',
js: '@stylelint/postcss-css-in-js',
jsx: '@stylelint/postcss-css-in-js',
less: 'postcss-less',
md: 'postcss-markdown',
sass: 'postcss-sass',
sss: 'sugarss',
scss: 'postcss-scss',
svelte: 'postcss-html',
ts: '@stylelint/postcss-css-in-js',
tsx: '@stylelint/postcss-css-in-js',
vue: 'postcss-html',
xml: 'postcss-html',
xst: 'postcss-html',
};
/**
* @param {StylelintInternalApi} stylelint
* @param {string|undefined} filePath
* @returns {Syntax}
*/
function cssSyntax(stylelint, filePath) {
const fileExtension = filePath ? path.extname(filePath).slice(1).toLowerCase() : '';
const extensions = ['css', 'pcss', 'postcss'];
if (previouslyInferredExtensions[fileExtension]) {
console.warn(
`${filePath}: When linting something other than CSS, you should install an appropriate syntax, e.g. "${previouslyInferredExtensions[fileExtension]}", and use the "customSyntax" option`,
);
}
return {
parse:
stylelint._options.fix && extensions.includes(fileExtension)
? require('postcss-safe-parser')
: postcss.parse,
stringify: postcss.stringify,
};
}