mirror of
https://github.com/OliveTin/OliveTin
synced 2025-12-20 04:55:32 +00:00
165 lines
4.2 KiB
JavaScript
165 lines
4.2 KiB
JavaScript
import valueParser from 'postcss-value-parser';
|
|
|
|
import { declarationValueIndex } from '../../utils/nodeFieldIndices.mjs';
|
|
import getDeclarationValue from '../../utils/getDeclarationValue.mjs';
|
|
import isStandardSyntaxValue from '../../utils/isStandardSyntaxValue.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 = 'lightness-notation';
|
|
|
|
const messages = ruleMessages(ruleName, {
|
|
expected: (unfixed, fixed) => `Expected "${unfixed}" to be "${fixed}"`,
|
|
});
|
|
|
|
const meta = {
|
|
url: 'https://stylelint.io/user-guide/rules/lightness-notation',
|
|
fixable: true,
|
|
};
|
|
|
|
const LIGHTNESS_ZERO_TO_ONE_RANGE_FUNCS = new Set(['oklch', 'oklab']);
|
|
const LIGHTNESS_ZERO_TO_HUNDRED_RANGE_FUNCS = new Set(['lch', 'lab']);
|
|
const LIGHTNESS_FUNCS = new Set([
|
|
...LIGHTNESS_ZERO_TO_ONE_RANGE_FUNCS,
|
|
...LIGHTNESS_ZERO_TO_HUNDRED_RANGE_FUNCS,
|
|
]);
|
|
const HAS_LIGHTNESS_COLOR_FUNC = new RegExp(`\\b(?:${[...LIGHTNESS_FUNCS].join('|')})\\(`, 'i');
|
|
|
|
/** @type {import('stylelint').CoreRules[ruleName]} */
|
|
const rule = (primary) => {
|
|
return (root, result) => {
|
|
const validOptions = validateOptions(result, ruleName, {
|
|
actual: primary,
|
|
possible: ['percentage', 'number'],
|
|
});
|
|
|
|
if (!validOptions) return;
|
|
|
|
root.walkDecls((decl) => {
|
|
if (!HAS_LIGHTNESS_COLOR_FUNC.test(decl.value)) return;
|
|
|
|
const parsedValue = valueParser(getDeclarationValue(decl));
|
|
|
|
parsedValue.walk((node) => {
|
|
if (node.type !== 'function') return;
|
|
|
|
const functionName = node.value.toLowerCase();
|
|
|
|
if (!LIGHTNESS_FUNCS.has(functionName)) return;
|
|
|
|
const lightness = findLightness(node);
|
|
|
|
if (!lightness) return;
|
|
|
|
const { value: unfixedValue } = lightness;
|
|
|
|
if (!isStandardSyntaxValue(unfixedValue)) return;
|
|
|
|
const dimension = valueParser.unit(unfixedValue);
|
|
|
|
if (!dimension) return;
|
|
|
|
const isPercentage = dimension.unit === `%`;
|
|
const isNumber = dimension.unit === '';
|
|
|
|
if (!isPercentage && !isNumber) return;
|
|
|
|
if (primary === 'percentage' && isPercentage) return;
|
|
|
|
if (primary === 'number' && isNumber) return;
|
|
|
|
const fixedValue =
|
|
primary === 'percentage'
|
|
? asPercentage(unfixedValue, functionName)
|
|
: asNumber(unfixedValue, functionName);
|
|
const valueIndex = declarationValueIndex(decl);
|
|
const fix = () => {
|
|
lightness.value = fixedValue;
|
|
setDeclarationValue(decl, parsedValue.toString());
|
|
};
|
|
|
|
report({
|
|
message: messages.expected,
|
|
messageArgs: [unfixedValue, fixedValue],
|
|
node: decl,
|
|
index: valueIndex + lightness.sourceIndex,
|
|
endIndex: valueIndex + lightness.sourceEndIndex,
|
|
result,
|
|
ruleName,
|
|
fix: {
|
|
apply: fix,
|
|
node: decl,
|
|
},
|
|
});
|
|
});
|
|
});
|
|
};
|
|
};
|
|
|
|
/**
|
|
* @param {string} value
|
|
* @param {import('postcss-value-parser').FunctionNode['value']} func
|
|
*/
|
|
function asPercentage(value, func) {
|
|
let num = Number.parseFloat(value);
|
|
|
|
if (LIGHTNESS_ZERO_TO_HUNDRED_RANGE_FUNCS.has(func)) {
|
|
return `${num}%`;
|
|
}
|
|
|
|
if (LIGHTNESS_ZERO_TO_ONE_RANGE_FUNCS.has(func)) {
|
|
num *= 100;
|
|
}
|
|
|
|
if (Number.isInteger(num)) {
|
|
return `${num}%`;
|
|
}
|
|
|
|
return `${roundToNumberOfDigits(num, value)}%`;
|
|
}
|
|
|
|
/**
|
|
* @param {string} value
|
|
* @param {import('postcss-value-parser').FunctionNode['value']} func
|
|
*/
|
|
function asNumber(value, func) {
|
|
let num = Number.parseFloat(value);
|
|
|
|
if (LIGHTNESS_ZERO_TO_ONE_RANGE_FUNCS.has(func)) {
|
|
num /= 100;
|
|
|
|
return `${roundToNumberOfDigits(num, value)}`;
|
|
}
|
|
|
|
return `${num}`;
|
|
}
|
|
|
|
/**
|
|
* @param {number} num
|
|
* @param {string} value
|
|
* @returns {string}
|
|
*/
|
|
function roundToNumberOfDigits(num, value) {
|
|
if (num === 0) return '0';
|
|
|
|
const precision = value.replaceAll('%', '').replaceAll('.', '').length;
|
|
|
|
if (precision === 0) return `${num}`;
|
|
|
|
return num.toPrecision(precision).replace(/0+$/, ''); // trim trailing zeros
|
|
}
|
|
|
|
/**
|
|
* @param {import('postcss-value-parser').FunctionNode} node
|
|
*/
|
|
function findLightness({ nodes }) {
|
|
return nodes.find(({ type }) => type === 'word' || type === 'function');
|
|
}
|
|
|
|
rule.ruleName = ruleName;
|
|
rule.messages = messages;
|
|
rule.meta = meta;
|
|
export default rule;
|