| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207 |
- import valueParser from 'postcss-value-parser';
- import { assert, isRegExp, isString } from '../../utils/validateTypes.mjs';
- import { declarationValueIndex } from '../../utils/nodeFieldIndices.mjs';
- import getDeclarationValue from '../../utils/getDeclarationValue.mjs';
- import isStandardSyntaxValue from '../../utils/isStandardSyntaxValue.mjs';
- import { isValueWord } from '../../utils/typeGuards.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 validateOptions from '../../utils/validateOptions.mjs';
- const ruleName = 'alpha-value-notation';
- const messages = ruleMessages(ruleName, {
- expected: (unfixed, fixed) => `Expected "${unfixed}" to be "${fixed}"`,
- });
- const meta = {
- url: 'https://stylelint.io/user-guide/rules/alpha-value-notation',
- fixable: true,
- };
- const ALPHA_PROPS =
- /^(?:opacity|shape-image-threshold|fill-opacity|flood-opacity|stop-opacity|stroke-opacity)$/i;
- const ALPHA_FUNCTION = /(?:color|hsla?|rgba?|hwb|lab|lch|oklab|oklch)\(/i;
- const ALPHA_FUNCTION_NAME = /^(?:color|hsla?|rgba?|hwb|lab|lch|oklab|oklch)$/i;
- const DIGIT = /\d/;
- /** @type {import('stylelint').CoreRules[ruleName]} */
- const rule = (primary, secondaryOptions) => {
- return (root, result) => {
- const validOptions = validateOptions(
- result,
- ruleName,
- {
- actual: primary,
- possible: ['number', 'percentage'],
- },
- {
- actual: secondaryOptions,
- possible: {
- exceptProperties: [isString, isRegExp],
- },
- optional: true,
- },
- );
- if (!validOptions) return;
- const optionFuncs = Object.freeze({
- number: {
- expFunc: isNumber,
- fixFunc: asNumber,
- },
- percentage: {
- expFunc: isPercentage,
- fixFunc: asPercentage,
- },
- });
- root.walkDecls((decl) => {
- const declarationValue = getDeclarationValue(decl);
- const isAlphaProp = ALPHA_PROPS.test(decl.prop);
- const isAlpha = isAlphaProp || ALPHA_FUNCTION.test(declarationValue);
- if (!isAlpha || !DIGIT.test(declarationValue)) return;
- const parsedValue = valueParser(declarationValue);
- parsedValue.walk((node) => {
- const inVal = isAlphaProp && DIGIT.test(node.value);
- const inFn = node.type === 'function' && ALPHA_FUNCTION_NAME.test(node.value);
- const alpha = inVal ? findAlphaInValue(node) : inFn ? findAlphaInFunction(node) : undefined;
- if (!alpha) return;
- const { value } = alpha;
- if (!isStandardSyntaxValue(value)) return;
- if (!isNumber(value) && !isPercentage(value)) return;
- /** @type {'number' | 'percentage'} */
- let expectation = primary;
- if (optionsMatches(secondaryOptions, 'exceptProperties', decl.prop)) {
- if (expectation === 'number') {
- expectation = 'percentage';
- } else if (expectation === 'percentage') {
- expectation = 'number';
- }
- }
- if (optionFuncs[expectation].expFunc(value)) return;
- const fixed = optionFuncs[expectation].fixFunc(value);
- const unfixed = value;
- const index = declarationValueIndex(decl) + alpha.sourceIndex;
- const endIndex = index + alpha.value.length;
- const fix = () => {
- alpha.value = fixed;
- setDeclarationValue(decl, parsedValue.toString());
- };
- report({
- message: messages.expected,
- messageArgs: [unfixed, fixed],
- node: decl,
- index,
- endIndex,
- result,
- ruleName,
- fix: {
- apply: fix,
- node: decl,
- },
- });
- });
- });
- };
- };
- /**
- * @param {string} value
- * @returns {string}
- */
- function asPercentage(value) {
- const number = Number(value);
- return `${Number((number * 100).toPrecision(3))}%`;
- }
- /**
- * @param {string} value
- * @returns {string}
- */
- function asNumber(value) {
- const dimension = valueParser.unit(value);
- assert(dimension);
- const number = Number(dimension.number);
- return Number((number / 100).toPrecision(3)).toString();
- }
- /**
- * @template {import('postcss-value-parser').Node} T
- * @param {T} node
- * @returns {T | undefined}
- */
- function findAlphaInValue(node) {
- return node.type === 'word' || node.type === 'function' ? node : undefined;
- }
- /**
- * @param {import('postcss-value-parser').FunctionNode} node
- * @returns {import('postcss-value-parser').Node | undefined}
- */
- function findAlphaInFunction(node) {
- const legacySyntax = node.nodes.some(({ type, value }) => type === 'div' && value === ',');
- if (legacySyntax) {
- const args = node.nodes.filter(({ type }) => type === 'word' || type === 'function');
- if (args.length === 4) return args[3];
- return undefined;
- }
- const slashNodeIndex = node.nodes.findIndex(({ type, value }) => type === 'div' && value === '/');
- if (slashNodeIndex !== -1) {
- const nodesAfterSlash = node.nodes.slice(slashNodeIndex + 1, node.nodes.length);
- return nodesAfterSlash.find(isValueWord);
- }
- return undefined;
- }
- /**
- * @param {string} value
- * @returns {boolean}
- */
- function isPercentage(value) {
- const dimension = valueParser.unit(value);
- return dimension && dimension.unit === '%';
- }
- /**
- * @param {string} value
- * @returns {boolean}
- */
- function isNumber(value) {
- const dimension = valueParser.unit(value);
- return dimension && dimension.unit === '';
- }
- rule.ruleName = ruleName;
- rule.messages = messages;
- rule.meta = meta;
- export default rule;
|