index.js 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. 'use strict';
  2. const isCustomProperty = require('../../utils/isCustomProperty');
  3. const isStandardSyntaxProperty = require('../../utils/isStandardSyntaxProperty');
  4. const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp');
  5. const report = require('../../utils/report');
  6. const ruleMessages = require('../../utils/ruleMessages');
  7. const validateOptions = require('../../utils/validateOptions');
  8. const vendor = require('../../utils/vendor');
  9. const { isRegExp, isString } = require('../../utils/validateTypes');
  10. const ruleName = 'property-allowed-list';
  11. const messages = ruleMessages(ruleName, {
  12. rejected: (property) => `Unexpected property "${property}"`,
  13. });
  14. const meta = {
  15. url: 'https://stylelint.io/user-guide/rules/list/property-allowed-list',
  16. };
  17. /** @type {import('stylelint').Rule<string | RegExp | Array<string | RegExp>>} */
  18. const rule = (primary) => {
  19. return (root, result) => {
  20. const validOptions = validateOptions(result, ruleName, {
  21. actual: primary,
  22. possible: [isString, isRegExp],
  23. });
  24. if (!validOptions) {
  25. return;
  26. }
  27. root.walkDecls((decl) => {
  28. const prop = decl.prop;
  29. if (!isStandardSyntaxProperty(prop)) {
  30. return;
  31. }
  32. if (isCustomProperty(prop)) {
  33. return;
  34. }
  35. // either the prefix or unprefixed version is in the list
  36. if (matchesStringOrRegExp([prop, vendor.unprefixed(prop)], primary)) {
  37. return;
  38. }
  39. report({
  40. message: messages.rejected(prop),
  41. word: prop,
  42. node: decl,
  43. result,
  44. ruleName,
  45. });
  46. });
  47. };
  48. };
  49. rule.primaryOptionArray = true;
  50. rule.ruleName = ruleName;
  51. rule.messages = messages;
  52. rule.meta = meta;
  53. module.exports = rule;