Files

201 lines
5.4 KiB
JavaScript

import valueParser from 'postcss-value-parser';
import { isRegExp, isString } from '../../utils/validateTypes.mjs';
import { declarationValueIndex } from '../../utils/nodeFieldIndices.mjs';
import getDeclarationValue from '../../utils/getDeclarationValue.mjs';
import isStandardSyntaxDeclaration from '../../utils/isStandardSyntaxDeclaration.mjs';
import isStandardSyntaxValue from '../../utils/isStandardSyntaxValue.mjs';
import optionsMatches from '../../utils/optionsMatches.mjs';
import report from '../../utils/report.mjs';
import ruleMessages from '../../utils/ruleMessages.mjs';
import setDeclarationValue from '../../utils/setDeclarationValue.mjs';
import { singleValueColorProperties } from '../../reference/properties.mjs';
import validateOptions from '../../utils/validateOptions.mjs';
const ruleName = 'declaration-property-value-keyword-no-deprecated';
const messages = ruleMessages(ruleName, {
expected: (actual, expected) => `Expected "${actual}" to be "${expected}"`,
rejected: (property, keyword) =>
`Unexpected deprecated keyword "${keyword}" for property "${property}"`,
});
const meta = {
url: 'https://stylelint.io/user-guide/rules/declaration-property-value-keyword-no-deprecated',
fixable: true,
};
const DEPRECATED_COLORS = {
activecaption: 'canvas',
appworkspace: 'canvas',
background: 'canvas',
inactivecaption: 'canvas',
infobackground: 'canvas',
menu: 'canvas',
scrollbar: 'canvas',
window: 'canvas',
activeborder: 'ButtonBorder',
inactiveborder: 'ButtonBorder',
threeddarkshadow: 'ButtonBorder',
threedhighlight: 'ButtonBorder',
threedlightshadow: 'ButtonBorder',
threedshadow: 'ButtonBorder',
windowframe: 'ButtonBorder',
captiontext: 'CanvasText',
infotext: 'CanvasText',
menutext: 'CanvasText',
windowtext: 'CanvasText',
buttonhighlight: 'ButtonFace',
buttonshadow: 'ButtonFace',
threedface: 'ButtonFace',
inactivecaptiontext: 'GrayText',
};
/** @type {ReadonlyArray<[string, Record<string, string>]>} */
const COLOR_PROPERTIES = [...singleValueColorProperties.values()].map((value) => [
value,
DEPRECATED_COLORS,
]);
const PROPERTY_NAME_TO_KEYWORDS = new Map([
[
'appearance',
/** @type {string[] | Record<string, string>} */ ({
button: 'auto',
checkbox: 'auto',
listbox: 'auto',
menulist: 'auto',
meter: 'auto',
'progress-bar': 'auto',
'push-button': 'auto',
radio: 'auto',
searchfield: 'auto',
'slider-horizontal': 'auto',
'square-button': 'auto',
textarea: 'auto',
}),
],
[
'image-rendering',
{
optimizeQuality: 'smooth',
optimizeSpeed: 'pixelated',
},
],
['overflow', { overlay: 'auto' }],
['overflow-x', { overlay: 'auto' }],
['overflow-y', { overlay: 'auto' }],
['text-justify', { distribute: 'inter-character' }],
['text-orientation', { 'sideways-right': 'sideways' }],
['user-select', { element: 'contain' }],
['zoom', { reset: '1' }],
['border-color', DEPRECATED_COLORS],
['scrollbar-color', DEPRECATED_COLORS],
['text-decoration', ['blink']],
['text-decoration-line', ['blink']],
['box-sizing', ['padding-box']],
['image-orientation', ['flip']],
['min-height', ['intrinsic', 'min-intrinsic']],
['min-width', ['intrinsic', 'min-intrinsic']],
['max-height', ['intrinsic', 'min-intrinsic']],
['max-width', ['intrinsic', 'min-intrinsic']],
['height', ['intrinsic', 'min-intrinsic']],
['width', ['intrinsic', 'min-intrinsic']],
['word-break', ['break-word']],
...COLOR_PROPERTIES,
]);
/** @type {import('stylelint').CoreRules[ruleName]} */
const rule = (primary, secondaryOptions) => {
return (root, result) => {
const validOptions = validateOptions(
result,
ruleName,
{ actual: primary },
{
optional: true,
actual: secondaryOptions,
possible: {
ignoreKeywords: [isString, isRegExp],
},
},
);
if (!validOptions) return;
root.walkDecls((decl) => {
if (!isStandardSyntaxDeclaration(decl)) return;
const { prop, value } = decl;
if (optionsMatches(secondaryOptions, 'ignoreKeywords', value)) return;
const keywords = PROPERTY_NAME_TO_KEYWORDS.get(prop.toLowerCase());
if (!keywords) return;
const parsedValue = valueParser(getDeclarationValue(decl));
let isStandardValue = true;
parsedValue.walk((node) => {
if (node.type === 'comment') return;
if (!isStandardSyntaxValue(node.value)) isStandardValue = false;
});
if (!isStandardValue) return;
parsedValue.walk((node) => {
if (node.type !== 'word') return;
const nodeValue = node.value;
const lowercasedValue = nodeValue.toLowerCase();
const offset = node.sourceIndex;
let fix;
let message;
let messageArgs = [];
if (Array.isArray(keywords)) {
if (!keywords.includes(lowercasedValue)) return;
message = messages.rejected;
messageArgs = [prop, nodeValue];
} else {
const expectedKeyword = keywords[lowercasedValue];
if (!expectedKeyword) return;
message = messages.expected;
messageArgs = [nodeValue, expectedKeyword];
fix = () => {
node.value = expectedKeyword;
setDeclarationValue(decl, parsedValue.toString());
};
}
const index = declarationValueIndex(decl) + offset;
const endIndex = index + nodeValue.length;
report({
message,
messageArgs,
node: decl,
result,
ruleName,
index,
endIndex,
fix: {
apply: fix,
node: decl,
},
});
});
});
};
};
rule.ruleName = ruleName;
rule.messages = messages;
rule.meta = meta;
export default rule;