index.js 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. 'use strict';
  2. const valueParser = require('postcss-value-parser');
  3. const declarationValueIndex = require('../../utils/declarationValueIndex');
  4. const flattenArray = require('../../utils/flattenArray');
  5. const getDimension = require('../../utils/getDimension');
  6. const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp');
  7. const report = require('../../utils/report');
  8. const ruleMessages = require('../../utils/ruleMessages');
  9. const validateObjectWithArrayProps = require('../../utils/validateObjectWithArrayProps');
  10. const validateOptions = require('../../utils/validateOptions');
  11. const { isString } = require('../../utils/validateTypes');
  12. const vendor = require('../../utils/vendor');
  13. const ruleName = 'declaration-property-unit-disallowed-list';
  14. const messages = ruleMessages(ruleName, {
  15. rejected: (property, unit) => `Unexpected unit "${unit}" for property "${property}"`,
  16. });
  17. const meta = {
  18. url: 'https://stylelint.io/user-guide/rules/list/declaration-property-unit-disallowed-list',
  19. };
  20. /** @type {import('stylelint').Rule<Record<string, string | string[]>>} */
  21. const rule = (primary) => {
  22. return (root, result) => {
  23. const validOptions = validateOptions(result, ruleName, {
  24. actual: primary,
  25. possible: [validateObjectWithArrayProps(isString)],
  26. });
  27. if (!validOptions) {
  28. return;
  29. }
  30. root.walkDecls((decl) => {
  31. const prop = decl.prop;
  32. const value = decl.value;
  33. const unprefixedProp = vendor.unprefixed(prop);
  34. const propKey = Object.keys(primary).find((propIdentifier) =>
  35. matchesStringOrRegExp(unprefixedProp, propIdentifier),
  36. );
  37. if (!propKey) {
  38. return;
  39. }
  40. const propList = flattenArray(primary[propKey]);
  41. if (!propList) {
  42. return;
  43. }
  44. valueParser(value).walk((node) => {
  45. // Ignore wrong units within `url` function
  46. if (node.type === 'function' && node.value.toLowerCase() === 'url') {
  47. return false;
  48. }
  49. if (node.type === 'string') {
  50. return;
  51. }
  52. const { unit } = getDimension(node);
  53. if (!unit || (unit && !propList.includes(unit.toLowerCase()))) {
  54. return;
  55. }
  56. const index = declarationValueIndex(decl) + node.sourceIndex;
  57. const endIndex = index + node.value.length;
  58. report({
  59. message: messages.rejected(prop, unit),
  60. node: decl,
  61. index,
  62. endIndex,
  63. result,
  64. ruleName,
  65. });
  66. });
  67. });
  68. };
  69. };
  70. rule.ruleName = ruleName;
  71. rule.messages = messages;
  72. rule.meta = meta;
  73. module.exports = rule;