index.js 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. 'use strict';
  2. const isCustomProperty = require('../../utils/isCustomProperty');
  3. const isStandardSyntaxProperty = require('../../utils/isStandardSyntaxProperty');
  4. const report = require('../../utils/report');
  5. const ruleMessages = require('../../utils/ruleMessages');
  6. const validateOptions = require('../../utils/validateOptions');
  7. const optionsMatches = require('../../utils/optionsMatches');
  8. const { isRegExp, isString } = require('../../utils/validateTypes');
  9. const { isRule } = require('../../utils/typeGuards');
  10. const ruleName = 'property-case';
  11. const messages = ruleMessages(ruleName, {
  12. expected: (actual, expected) => `Expected "${actual}" to be "${expected}"`,
  13. });
  14. const meta = {
  15. url: 'https://stylelint.io/user-guide/rules/property-case',
  16. fixable: true,
  17. deprecated: true,
  18. };
  19. /** @type {import('stylelint').Rule} */
  20. const rule = (primary, secondaryOptions, context) => {
  21. return (root, result) => {
  22. const validOptions = validateOptions(
  23. result,
  24. ruleName,
  25. {
  26. actual: primary,
  27. possible: ['lower', 'upper'],
  28. },
  29. {
  30. actual: secondaryOptions,
  31. possible: {
  32. ignoreSelectors: [isString, isRegExp],
  33. },
  34. optional: true,
  35. },
  36. );
  37. if (!validOptions) {
  38. return;
  39. }
  40. root.walkDecls((decl) => {
  41. const prop = decl.prop;
  42. if (!isStandardSyntaxProperty(prop)) {
  43. return;
  44. }
  45. if (isCustomProperty(prop)) {
  46. return;
  47. }
  48. const { parent } = decl;
  49. if (!parent) throw new Error('A parent node must be present');
  50. if (isRule(parent)) {
  51. const { selector } = parent;
  52. if (selector && optionsMatches(secondaryOptions, 'ignoreSelectors', selector)) {
  53. return;
  54. }
  55. }
  56. const expectedProp = primary === 'lower' ? prop.toLowerCase() : prop.toUpperCase();
  57. if (prop === expectedProp) {
  58. return;
  59. }
  60. if (context.fix) {
  61. decl.prop = expectedProp;
  62. return;
  63. }
  64. report({
  65. message: messages.expected(prop, expectedProp),
  66. word: prop,
  67. node: decl,
  68. ruleName,
  69. result,
  70. });
  71. });
  72. };
  73. };
  74. rule.ruleName = ruleName;
  75. rule.messages = messages;
  76. rule.meta = meta;
  77. module.exports = rule;