mirror of
https://github.com/OliveTin/OliveTin
synced 2025-12-19 20:45:35 +00:00
259 lines
8.1 KiB
JavaScript
259 lines
8.1 KiB
JavaScript
// NOTICE: This file is generated by Rollup. To modify it,
|
|
// please instead edit the ESM counterpart and rebuild with Rollup (npm run build).
|
|
'use strict';
|
|
|
|
const cssTree = require('css-tree');
|
|
const validateTypes = require('../../utils/validateTypes.cjs');
|
|
const regexes = require('../../utils/regexes.cjs');
|
|
const nodeFieldIndices = require('../../utils/nodeFieldIndices.cjs');
|
|
const typeGuards = require('../../utils/typeGuards.cjs');
|
|
const getDeclarationValue = require('../../utils/getDeclarationValue.cjs');
|
|
const isCustomProperty = require('../../utils/isCustomProperty.cjs');
|
|
const isDescriptorDeclaration = require('../../utils/isDescriptorDeclaration.cjs');
|
|
const isStandardSyntaxDeclaration = require('../../utils/isStandardSyntaxDeclaration.cjs');
|
|
const isStandardSyntaxProperty = require('../../utils/isStandardSyntaxProperty.cjs');
|
|
const isStandardSyntaxValue = require('../../utils/isStandardSyntaxValue.cjs');
|
|
const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp.cjs');
|
|
const report = require('../../utils/report.cjs');
|
|
const ruleMessages = require('../../utils/ruleMessages.cjs');
|
|
const validateObjectWithArrayProps = require('../../utils/validateObjectWithArrayProps.cjs');
|
|
const validateObjectWithProps = require('../../utils/validateObjectWithProps.cjs');
|
|
const validateOptions = require('../../utils/validateOptions.cjs');
|
|
|
|
const ruleName = 'declaration-property-value-no-unknown';
|
|
|
|
const messages = ruleMessages(ruleName, {
|
|
rejected: (property, value) => `Unexpected unknown value "${value}" for property "${property}"`,
|
|
rejectedParseError: (property, value) =>
|
|
`Cannot parse property value "${value}" for property "${property}"`,
|
|
});
|
|
|
|
const meta = {
|
|
url: 'https://stylelint.io/user-guide/rules/declaration-property-value-no-unknown',
|
|
};
|
|
|
|
const SYNTAX_DESCRIPTOR = /^syntax$/i;
|
|
|
|
/** @typedef {import('stylelint').CoreRules[ruleName]} Rule */
|
|
/** @typedef {Parameters<Rule>[1]} SecondaryOptions */
|
|
|
|
/** @type {Rule} */
|
|
const rule = (primary, secondaryOptions) => {
|
|
return (root, result) => {
|
|
const validOptions = validateOptions(
|
|
result,
|
|
ruleName,
|
|
{ actual: primary },
|
|
{
|
|
actual: secondaryOptions,
|
|
possible: {
|
|
ignoreProperties: [validateObjectWithArrayProps(validateTypes.isString, validateTypes.isRegExp)],
|
|
propertiesSyntax: [validateObjectWithProps(validateTypes.isString)],
|
|
typesSyntax: [validateObjectWithProps(validateTypes.isString)],
|
|
},
|
|
optional: true,
|
|
},
|
|
);
|
|
|
|
if (!validOptions) {
|
|
return;
|
|
}
|
|
|
|
const ignoreProperties = Array.from(Object.entries(secondaryOptions?.ignoreProperties ?? {}));
|
|
|
|
/** @type {(name: string, propValue: string) => boolean} */
|
|
const isPropIgnored = (name, value) => {
|
|
const [, valuePattern] =
|
|
ignoreProperties.find(([namePattern]) => matchesStringOrRegExp(name, namePattern)) || [];
|
|
|
|
return Boolean(valuePattern && matchesStringOrRegExp(value, valuePattern));
|
|
};
|
|
|
|
/** @type {SecondaryOptions['propertiesSyntax']} */
|
|
const propertiesSyntax = {
|
|
'text-box-edge':
|
|
'auto | [ text | cap | ex | ideographic | ideographic-ink ] [ text | alphabetic | ideographic | ideographic-ink ]?',
|
|
'text-box-trim': 'none | trim-start | trim-end | trim-both',
|
|
'view-timeline':
|
|
"[ <'view-timeline-name'> [ <'view-timeline-axis'> || <'view-timeline-inset'> ]? ]#",
|
|
'font-size': '| math',
|
|
...secondaryOptions?.propertiesSyntax,
|
|
};
|
|
|
|
/**
|
|
* @todo add support for oklab(), oklch(), color(), color-mix(), light-dark(), etc.
|
|
* @see https://drafts.csswg.org/css-color-5/
|
|
*/
|
|
const typesSyntax = { ...secondaryOptions?.typesSyntax };
|
|
|
|
/** @type {Map<string, string>} */
|
|
const typedCustomPropertyNames = new Map();
|
|
|
|
root.walkAtRules(regexes.atRuleRegexes.propertyName, (atRule) => {
|
|
const propName = atRule.params.trim();
|
|
|
|
if (!propName || !atRule.nodes || !isCustomProperty(propName)) return;
|
|
|
|
for (const node of atRule.nodes) {
|
|
if (typeGuards.isDeclaration(node) && SYNTAX_DESCRIPTOR.test(node.prop)) {
|
|
const value = node.value.trim();
|
|
const unquoted = cssTree.string.decode(value);
|
|
|
|
// Only string values are valid.
|
|
// We can not check the syntax of this property.
|
|
if (unquoted === value) continue;
|
|
|
|
// Any value is allowed in this custom property.
|
|
// We don't need to check this property.
|
|
if (unquoted === '*') continue;
|
|
|
|
// https://github.com/csstree/csstree/pull/256
|
|
// We can circumvent this issue by prefixing the property name,
|
|
// making it a vendor-prefixed property instead of a custom property.
|
|
// No one should be using `-stylelint--` as a property prefix.
|
|
//
|
|
// When this is resolved `typedCustomPropertyNames` can become a `Set<string>`
|
|
// and the prefix can be removed.
|
|
const prefixedPropName = `-stylelint${propName}`;
|
|
|
|
typedCustomPropertyNames.set(propName, prefixedPropName);
|
|
propertiesSyntax[prefixedPropName] = unquoted;
|
|
}
|
|
}
|
|
});
|
|
|
|
const languageOptions = result.stylelint.config?.languageOptions;
|
|
const forkedLexer = cssTree.fork({
|
|
atrules: languageOptions?.syntax?.atRules || {},
|
|
properties: { ...(languageOptions?.syntax?.properties || {}), ...propertiesSyntax },
|
|
types: { ...(languageOptions?.syntax?.types || {}), ...typesSyntax },
|
|
cssWideKeywords: languageOptions?.syntax?.cssWideKeywords || [],
|
|
}).lexer;
|
|
|
|
root.walkDecls((decl) => {
|
|
const { prop } = decl;
|
|
const value = getDeclarationValue(decl);
|
|
|
|
// csstree/csstree#243
|
|
// NOTE: CSSTree's `fork()` doesn't support `-moz-initial`, but it may be possible in the future.
|
|
if (/^-moz-initial$/i.test(value)) return;
|
|
|
|
if (!isStandardSyntaxDeclaration(decl)) return;
|
|
|
|
if (isDescriptorDeclaration(decl)) return;
|
|
|
|
if (!isStandardSyntaxProperty(prop)) return;
|
|
|
|
if (!isStandardSyntaxValue(value)) return;
|
|
|
|
if (isCustomProperty(prop) && !typedCustomPropertyNames.has(prop)) return;
|
|
|
|
if (isPropIgnored(prop, value)) return;
|
|
|
|
/** @type {import('css-tree').CssNode} */
|
|
let cssTreeValueNode;
|
|
|
|
try {
|
|
cssTreeValueNode = cssTree.parse(value, { context: 'value', positions: true });
|
|
|
|
if (containsUnsupportedFunction(cssTreeValueNode)) return;
|
|
} catch {
|
|
const index = nodeFieldIndices.declarationValueIndex(decl);
|
|
const endIndex = index + value.length;
|
|
|
|
report({
|
|
message: messages.rejectedParseError,
|
|
messageArgs: [prop, value],
|
|
node: decl,
|
|
index,
|
|
endIndex,
|
|
result,
|
|
ruleName,
|
|
});
|
|
|
|
return;
|
|
}
|
|
|
|
const { error } = forkedLexer.matchProperty(
|
|
typedCustomPropertyNames.get(prop) ?? prop,
|
|
cssTreeValueNode,
|
|
);
|
|
|
|
if (!error) return;
|
|
|
|
if (!('mismatchLength' in error)) return;
|
|
|
|
const { name, rawMessage, loc } = error;
|
|
|
|
if (name !== 'SyntaxMatchError') return;
|
|
|
|
if (rawMessage !== 'Mismatch') return;
|
|
|
|
const valueIndex = nodeFieldIndices.declarationValueIndex(decl);
|
|
const mismatchValue = value.slice(loc.start.offset, loc.end.offset);
|
|
|
|
const functionNode = cssTree.find(
|
|
cssTreeValueNode,
|
|
(node) =>
|
|
node.type === 'Function' &&
|
|
node.loc !== undefined &&
|
|
loc.start.offset >= node.loc.start.offset &&
|
|
loc.end.offset <= node.loc.end.offset,
|
|
);
|
|
|
|
if (functionNode?.loc) {
|
|
const valueFunction = value.slice(
|
|
functionNode.loc.start.offset,
|
|
functionNode.loc.end.offset,
|
|
);
|
|
|
|
const index = valueIndex + functionNode.loc.start.offset;
|
|
const endIndex = index + valueFunction.length;
|
|
|
|
report({
|
|
message: messages.rejected,
|
|
messageArgs: [prop, valueFunction],
|
|
node: decl,
|
|
index,
|
|
endIndex,
|
|
result,
|
|
ruleName,
|
|
});
|
|
|
|
return;
|
|
}
|
|
|
|
report({
|
|
message: messages.rejected,
|
|
messageArgs: [prop, mismatchValue],
|
|
node: decl,
|
|
index: valueIndex + loc.start.offset,
|
|
endIndex: valueIndex + loc.end.offset,
|
|
result,
|
|
ruleName,
|
|
});
|
|
});
|
|
};
|
|
};
|
|
|
|
/**
|
|
* @see csstree/csstree#164 min, max, clamp
|
|
* @see csstree/csstree#245 env
|
|
* @param {import('css-tree').CssNode} cssTreeNode
|
|
* @returns {boolean}
|
|
*/
|
|
function containsUnsupportedFunction(cssTreeNode) {
|
|
return Boolean(
|
|
cssTree.find(
|
|
cssTreeNode,
|
|
(node) => node.type === 'Function' && ['clamp', 'min', 'max', 'env'].includes(node.name),
|
|
),
|
|
);
|
|
}
|
|
|
|
rule.ruleName = ruleName;
|
|
rule.messages = messages;
|
|
rule.meta = meta;
|
|
|
|
module.exports = rule;
|