144 lines
3.8 KiB
JavaScript
144 lines
3.8 KiB
JavaScript
import {
|
|
atRuleAfterIndex,
|
|
atRuleAfterNameIndex,
|
|
atRuleBetweenIndex,
|
|
atRuleParamIndex,
|
|
declarationBetweenIndex,
|
|
declarationValueIndex,
|
|
ruleAfterIndex,
|
|
ruleBetweenIndex,
|
|
} from '../../utils/nodeFieldIndices.mjs';
|
|
|
|
import getAtRuleParams from '../../utils/getAtRuleParams.mjs';
|
|
import getDeclarationValue from '../../utils/getDeclarationValue.mjs';
|
|
import getRuleSelector from '../../utils/getRuleSelector.mjs';
|
|
import report from '../../utils/report.mjs';
|
|
import ruleMessages from '../../utils/ruleMessages.mjs';
|
|
import validateOptions from '../../utils/validateOptions.mjs';
|
|
|
|
const ruleName = 'no-irregular-whitespace';
|
|
|
|
const messages = ruleMessages(ruleName, {
|
|
unexpected: 'Unexpected irregular whitespace',
|
|
});
|
|
|
|
const meta = {
|
|
url: 'https://stylelint.io/user-guide/rules/no-irregular-whitespace',
|
|
};
|
|
|
|
const IRREGULAR_WHITESPACES = [
|
|
'\u000B', // Line Tabulation (\v) - <VT>
|
|
'\u000C', // Form Feed (\f) - <FF>
|
|
'\u00A0', // No-Break Space - <NBSP>
|
|
'\u0085', // Next Line
|
|
'\u1680', // Ogham Space Mark
|
|
'\u180E', // Mongolian Vowel Separator - <MVS>
|
|
'\uFEFF', // Zero Width No-Break Space - <BOM>
|
|
'\u2000', // En Quad
|
|
'\u2001', // Em Quad
|
|
'\u2002', // En Space - <ENSP>
|
|
'\u2003', // Em Space - <EMSP>
|
|
'\u2004', // Tree-Per-Em
|
|
'\u2005', // Four-Per-Em
|
|
'\u2006', // Six-Per-Em
|
|
'\u2007', // Figure Space
|
|
'\u2008', // Punctuation Space - <PUNCSP>
|
|
'\u2009', // Thin Space
|
|
'\u200A', // Hair Space
|
|
'\u200B', // Zero Width Space - <ZWSP>
|
|
'\u2028', // Line Separator
|
|
'\u2029', // Paragraph Separator
|
|
'\u202F', // Narrow No-Break Space
|
|
'\u205F', // Medium Mathematical Space
|
|
'\u3000', // Ideographic Space
|
|
];
|
|
|
|
const IRREGULAR_WHITESPACES_PATTERN = new RegExp(`([${IRREGULAR_WHITESPACES.join('')}]+)`, 'g');
|
|
|
|
/**
|
|
* @param {string} str
|
|
* @returns {Array<{index: number, length: number}>}
|
|
*/
|
|
const findIrregularWhitespace = (str) => {
|
|
return Array.from(str.matchAll(IRREGULAR_WHITESPACES_PATTERN)).map((match) => {
|
|
return {
|
|
index: match.index,
|
|
length: match[0].length,
|
|
};
|
|
});
|
|
};
|
|
|
|
/** @type {import('stylelint').CoreRules[ruleName]} */
|
|
const rule = (primary) => {
|
|
return (root, result) => {
|
|
const validOptions = validateOptions(result, ruleName, { actual: primary });
|
|
|
|
if (!validOptions) {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* @template {import('postcss').Node} T
|
|
* @param {T} node
|
|
* @param {string | undefined} value
|
|
* @param {(node: T) => number} getIndex
|
|
*/
|
|
const validate = (node, value, getIndex) => {
|
|
if (!value) return;
|
|
|
|
const issues = findIrregularWhitespace(value);
|
|
|
|
if (!issues.length) return;
|
|
|
|
const startIndex = getIndex(node);
|
|
|
|
issues.forEach(({ index, length }) => {
|
|
report({
|
|
ruleName,
|
|
result,
|
|
message: messages.unexpected,
|
|
node,
|
|
index: startIndex + index,
|
|
endIndex: startIndex + index + length,
|
|
});
|
|
});
|
|
};
|
|
|
|
root.walkAtRules((atRule) => {
|
|
validate(atRule, atRule.raws.before, zeroIndex);
|
|
validate(atRule, atRule.name, oneIndex);
|
|
validate(atRule, atRule.raws.afterName, atRuleAfterNameIndex);
|
|
validate(atRule, getAtRuleParams(atRule), atRuleParamIndex);
|
|
validate(atRule, atRule.raws.between, atRuleBetweenIndex);
|
|
validate(atRule, atRule.raws.after, atRuleAfterIndex);
|
|
});
|
|
|
|
root.walkRules((ruleNode) => {
|
|
validate(ruleNode, ruleNode.raws.before, zeroIndex);
|
|
validate(ruleNode, getRuleSelector(ruleNode), zeroIndex);
|
|
validate(ruleNode, ruleNode.raws.between, ruleBetweenIndex);
|
|
validate(ruleNode, ruleNode.raws.after, ruleAfterIndex);
|
|
});
|
|
|
|
root.walkDecls((decl) => {
|
|
validate(decl, decl.raws.before, zeroIndex);
|
|
validate(decl, decl.prop, zeroIndex);
|
|
validate(decl, decl.raws.between, declarationBetweenIndex);
|
|
validate(decl, getDeclarationValue(decl), declarationValueIndex);
|
|
});
|
|
};
|
|
};
|
|
|
|
function zeroIndex() {
|
|
return 0;
|
|
}
|
|
|
|
function oneIndex() {
|
|
return 1;
|
|
}
|
|
|
|
rule.ruleName = ruleName;
|
|
rule.messages = messages;
|
|
rule.meta = meta;
|
|
export default rule;
|