index.js 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. 'use strict';
  2. const valueParser = require('postcss-value-parser');
  3. const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp');
  4. const report = require('../../utils/report');
  5. const ruleMessages = require('../../utils/ruleMessages');
  6. const vendor = require('../../utils/vendor');
  7. const validateOptions = require('../../utils/validateOptions');
  8. const { isNumber, assertNumber } = require('../../utils/validateTypes');
  9. const validateObjectWithProps = require('../../utils/validateObjectWithProps');
  10. const ruleName = 'declaration-property-max-values';
  11. const messages = ruleMessages(ruleName, {
  12. rejected: (property, max) =>
  13. `Expected "${property}" to have no more than ${max} ${max === 1 ? 'value' : 'values'}`,
  14. });
  15. const meta = {
  16. url: 'https://stylelint.io/user-guide/rules/declaration-property-max-values',
  17. };
  18. /**
  19. * @param {valueParser.Node} node
  20. */
  21. const isValueNode = (node) => {
  22. return node.type === 'word' || node.type === 'function' || node.type === 'string';
  23. };
  24. /** @type {import('stylelint').Rule<Record<string, number>>} */
  25. const rule = (primary) => {
  26. return (root, result) => {
  27. const validOptions = validateOptions(result, ruleName, {
  28. actual: primary,
  29. possible: [validateObjectWithProps(isNumber)],
  30. });
  31. if (!validOptions) {
  32. return;
  33. }
  34. root.walkDecls((decl) => {
  35. const { prop, value } = decl;
  36. const propLength = valueParser(value).nodes.filter(isValueNode).length;
  37. const unprefixedProp = vendor.unprefixed(prop);
  38. const propKey = Object.keys(primary).find((propIdentifier) =>
  39. matchesStringOrRegExp(unprefixedProp, propIdentifier),
  40. );
  41. if (!propKey) {
  42. return;
  43. }
  44. const max = primary[propKey];
  45. assertNumber(max);
  46. if (propLength <= max) {
  47. return;
  48. }
  49. report({
  50. message: messages.rejected(prop, max),
  51. node: decl,
  52. result,
  53. ruleName,
  54. });
  55. });
  56. };
  57. };
  58. rule.ruleName = ruleName;
  59. rule.messages = messages;
  60. rule.meta = meta;
  61. module.exports = rule;