index.js 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. 'use strict';
  2. const valueParser = require('postcss-value-parser');
  3. const declarationValueIndex = require('../../utils/declarationValueIndex');
  4. const isCustomProperty = require('../../utils/isCustomProperty');
  5. const report = require('../../utils/report');
  6. const ruleMessages = require('../../utils/ruleMessages');
  7. const validateOptions = require('../../utils/validateOptions');
  8. const ruleName = 'custom-property-no-missing-var-function';
  9. const messages = ruleMessages(ruleName, {
  10. rejected: (customProperty) => `Unexpected missing var function for "${customProperty}"`,
  11. });
  12. const meta = {
  13. url: 'https://stylelint.io/user-guide/rules/custom-property-no-missing-var-function',
  14. };
  15. /** @type {import('stylelint').Rule} */
  16. const rule = (primary) => {
  17. return (root, result) => {
  18. const validOptions = validateOptions(result, ruleName, { actual: primary });
  19. if (!validOptions) return;
  20. /** @type {Set<string>} */
  21. const knownCustomProperties = new Set();
  22. root.walkAtRules(/^property$/i, (atRule) => {
  23. knownCustomProperties.add(atRule.params);
  24. });
  25. root.walkDecls(({ prop }) => {
  26. if (isCustomProperty(prop)) knownCustomProperties.add(prop);
  27. });
  28. root.walkDecls((decl) => {
  29. const { value } = decl;
  30. const parsedValue = valueParser(value);
  31. parsedValue.walk((node) => {
  32. if (isVarFunction(node)) return false;
  33. if (!isDashedIdent(node)) return;
  34. if (!knownCustomProperties.has(node.value)) return;
  35. const index = declarationValueIndex(decl) + node.sourceIndex;
  36. const endIndex = index + node.value.length;
  37. report({
  38. message: messages.rejected,
  39. messageArgs: [node.value],
  40. node: decl,
  41. index,
  42. endIndex,
  43. result,
  44. ruleName,
  45. });
  46. return false;
  47. });
  48. });
  49. };
  50. };
  51. /**
  52. * @param {import('postcss-value-parser').Node} node
  53. */
  54. function isDashedIdent({ type, value }) {
  55. return type === 'word' && value.startsWith('--');
  56. }
  57. /**
  58. * @param {import('postcss-value-parser').Node} node
  59. */
  60. function isVarFunction({ type, value }) {
  61. return type === 'function' && value === 'var';
  62. }
  63. rule.ruleName = ruleName;
  64. rule.messages = messages;
  65. rule.meta = meta;
  66. module.exports = rule;