index.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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. };
  19. /** @type {import('stylelint').Rule} */
  20. const rule = (primary, _secondaryOptions, context) => {
  21. return (root, result) => {
  22. const validOptions = validateOptions(result, ruleName, {
  23. actual: primary,
  24. possible: ['lower', 'upper'],
  25. });
  26. if (!validOptions) {
  27. return;
  28. }
  29. root.walkAtRules(/^media$/i, (atRule) => {
  30. let hasComments = atRule.raws.params && atRule.raws.params.raw;
  31. const mediaRule = hasComments ? hasComments : atRule.params;
  32. mediaParser(mediaRule).walk(/^media-feature$/i, (mediaFeatureNode) => {
  33. const parent = mediaFeatureNode.parent;
  34. const mediaFeatureRangeContext = isRangeContextMediaFeature(parent.value);
  35. let value;
  36. let sourceIndex;
  37. if (mediaFeatureRangeContext) {
  38. const parsedRangeContext = rangeContextNodeParser(mediaFeatureNode);
  39. value = parsedRangeContext.name.value;
  40. sourceIndex = parsedRangeContext.name.sourceIndex;
  41. } else {
  42. value = mediaFeatureNode.value;
  43. sourceIndex = mediaFeatureNode.sourceIndex;
  44. }
  45. if (!isStandardSyntaxMediaFeatureName(value) || isCustomMediaQuery(value)) {
  46. return;
  47. }
  48. const expectedFeatureName = primary === 'lower' ? value.toLowerCase() : value.toUpperCase();
  49. if (value === expectedFeatureName) {
  50. return;
  51. }
  52. if (context.fix) {
  53. if (hasComments) {
  54. hasComments =
  55. hasComments.slice(0, sourceIndex) +
  56. expectedFeatureName +
  57. hasComments.slice(sourceIndex + expectedFeatureName.length);
  58. if (atRule.raws.params == null) {
  59. throw new Error('The `AtRuleRaws` node must have a `params` property');
  60. }
  61. atRule.raws.params.raw = hasComments;
  62. } else {
  63. atRule.params =
  64. atRule.params.slice(0, sourceIndex) +
  65. expectedFeatureName +
  66. atRule.params.slice(sourceIndex + expectedFeatureName.length);
  67. }
  68. return;
  69. }
  70. report({
  71. index: atRuleParamIndex(atRule) + sourceIndex,
  72. message: messages.expected(value, expectedFeatureName),
  73. node: atRule,
  74. ruleName,
  75. result,
  76. });
  77. });
  78. });
  79. };
  80. };
  81. rule.ruleName = ruleName;
  82. rule.messages = messages;
  83. rule.meta = meta;
  84. module.exports = rule;