index.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. 'use strict';
  2. const atRuleParamIndex = require('../../utils/atRuleParamIndex');
  3. const isCustomMediaQuery = require('../../utils/isCustomMediaQuery');
  4. const isRangeContextMediaFeature = require('../../utils/isRangeContextMediaFeature');
  5. const isStandardSyntaxMediaFeatureName = require('../../utils/isStandardSyntaxMediaFeatureName');
  6. const mediaParser = require('postcss-media-query-parser').default;
  7. const rangeContextNodeParser = require('../rangeContextNodeParser');
  8. const report = require('../../utils/report');
  9. const ruleMessages = require('../../utils/ruleMessages');
  10. const validateOptions = require('../../utils/validateOptions');
  11. const ruleName = 'media-feature-name-case';
  12. const messages = ruleMessages(ruleName, {
  13. expected: (actual, expected) => `Expected "${actual}" to be "${expected}"`,
  14. });
  15. const meta = {
  16. url: 'https://stylelint.io/user-guide/rules/media-feature-name-case',
  17. fixable: true,
  18. deprecated: true,
  19. };
  20. /** @type {import('stylelint').Rule} */
  21. const rule = (primary, _secondaryOptions, context) => {
  22. return (root, result) => {
  23. const validOptions = validateOptions(result, ruleName, {
  24. actual: primary,
  25. possible: ['lower', 'upper'],
  26. });
  27. if (!validOptions) {
  28. return;
  29. }
  30. root.walkAtRules(/^media$/i, (atRule) => {
  31. let hasComments = atRule.raws.params && atRule.raws.params.raw;
  32. const mediaRule = hasComments ? hasComments : atRule.params;
  33. mediaParser(mediaRule).walk(/^media-feature$/i, (mediaFeatureNode) => {
  34. const parent = mediaFeatureNode.parent;
  35. const mediaFeatureRangeContext = isRangeContextMediaFeature(parent.value);
  36. let value;
  37. let sourceIndex;
  38. if (mediaFeatureRangeContext) {
  39. const parsedRangeContext = rangeContextNodeParser(mediaFeatureNode);
  40. value = parsedRangeContext.name.value;
  41. sourceIndex = parsedRangeContext.name.sourceIndex;
  42. } else {
  43. value = mediaFeatureNode.value;
  44. sourceIndex = mediaFeatureNode.sourceIndex;
  45. }
  46. if (!isStandardSyntaxMediaFeatureName(value) || isCustomMediaQuery(value)) {
  47. return;
  48. }
  49. const expectedFeatureName = primary === 'lower' ? value.toLowerCase() : value.toUpperCase();
  50. if (value === expectedFeatureName) {
  51. return;
  52. }
  53. if (context.fix) {
  54. if (hasComments) {
  55. hasComments =
  56. hasComments.slice(0, sourceIndex) +
  57. expectedFeatureName +
  58. hasComments.slice(sourceIndex + expectedFeatureName.length);
  59. if (atRule.raws.params == null) {
  60. throw new Error('The `AtRuleRaws` node must have a `params` property');
  61. }
  62. atRule.raws.params.raw = hasComments;
  63. } else {
  64. atRule.params =
  65. atRule.params.slice(0, sourceIndex) +
  66. expectedFeatureName +
  67. atRule.params.slice(sourceIndex + expectedFeatureName.length);
  68. }
  69. return;
  70. }
  71. report({
  72. index: atRuleParamIndex(atRule) + sourceIndex,
  73. message: messages.expected(value, expectedFeatureName),
  74. node: atRule,
  75. ruleName,
  76. result,
  77. });
  78. });
  79. });
  80. };
  81. };
  82. rule.ruleName = ruleName;
  83. rule.messages = messages;
  84. rule.meta = meta;
  85. module.exports = rule;