index.js 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. 'use strict';
  2. const atRuleParamIndex = require('../../utils/atRuleParamIndex');
  3. const declarationValueIndex = require('../../utils/declarationValueIndex');
  4. const getUnitFromValueNode = require('../../utils/getUnitFromValueNode');
  5. const report = require('../../utils/report');
  6. const ruleMessages = require('../../utils/ruleMessages');
  7. const validateOptions = require('../../utils/validateOptions');
  8. const valueParser = require('postcss-value-parser');
  9. const ruleName = 'unit-case';
  10. const messages = ruleMessages(ruleName, {
  11. expected: (actual, expected) => `Expected "${actual}" to be "${expected}"`,
  12. });
  13. const meta = {
  14. url: 'https://stylelint.io/user-guide/rules/list/unit-case',
  15. };
  16. /** @type {import('stylelint').Rule} */
  17. const rule = (primary, _secondaryOptions, context) => {
  18. return (root, result) => {
  19. const validOptions = validateOptions(result, ruleName, {
  20. actual: primary,
  21. possible: ['lower', 'upper'],
  22. });
  23. if (!validOptions) {
  24. return;
  25. }
  26. /**
  27. * @template {import('postcss').AtRule | import('postcss').Declaration} T
  28. * @param {T} node
  29. * @param {string} checkedValue
  30. * @param {(node: T) => number} getIndex
  31. * @returns {void}
  32. */
  33. function check(node, checkedValue, getIndex) {
  34. /** @type {Array<{ index: number, message: string }>} */
  35. const problems = [];
  36. /**
  37. * @param {import('postcss-value-parser').Node} valueNode
  38. * @returns {boolean}
  39. */
  40. function processValue(valueNode) {
  41. const unit = getUnitFromValueNode(valueNode);
  42. if (!unit) {
  43. return false;
  44. }
  45. const expectedUnit = primary === 'lower' ? unit.toLowerCase() : unit.toUpperCase();
  46. if (unit === expectedUnit) {
  47. return false;
  48. }
  49. problems.push({
  50. index: getIndex(node) + valueNode.sourceIndex,
  51. message: messages.expected(unit, expectedUnit),
  52. });
  53. return true;
  54. }
  55. const parsedValue = valueParser(checkedValue).walk((valueNode) => {
  56. // Ignore wrong units within `url` function
  57. let needFix = false;
  58. const value = valueNode.value;
  59. if (valueNode.type === 'function' && value.toLowerCase() === 'url') {
  60. return false;
  61. }
  62. if (value.includes('*')) {
  63. value.split('*').some((val) => {
  64. return processValue({
  65. ...valueNode,
  66. sourceIndex: value.indexOf(val) + val.length + 1,
  67. value: val,
  68. });
  69. });
  70. }
  71. needFix = processValue(valueNode);
  72. if (needFix && context.fix) {
  73. valueNode.value = primary === 'lower' ? value.toLowerCase() : value.toUpperCase();
  74. }
  75. });
  76. if (problems.length) {
  77. if (context.fix) {
  78. if ('name' in node && node.name === 'media') {
  79. node.params = parsedValue.toString();
  80. } else if ('value' in node) {
  81. node.value = parsedValue.toString();
  82. }
  83. } else {
  84. for (const err of problems) {
  85. report({
  86. index: err.index,
  87. message: err.message,
  88. node,
  89. result,
  90. ruleName,
  91. });
  92. }
  93. }
  94. }
  95. }
  96. root.walkAtRules((atRule) => {
  97. if (!/^media$/i.test(atRule.name) && !('variable' in atRule)) {
  98. return;
  99. }
  100. check(atRule, atRule.params, atRuleParamIndex);
  101. });
  102. root.walkDecls((decl) => check(decl, decl.value, declarationValueIndex));
  103. };
  104. };
  105. rule.ruleName = ruleName;
  106. rule.messages = messages;
  107. rule.meta = meta;
  108. module.exports = rule;