index.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. 'use strict';
  2. const getRuleSelector = require('../../utils/getRuleSelector');
  3. const isStandardSyntaxRule = require('../../utils/isStandardSyntaxRule');
  4. const isValidIdentifier = require('../../utils/isValidIdentifier');
  5. const parseSelector = require('../../utils/parseSelector');
  6. const report = require('../../utils/report');
  7. const ruleMessages = require('../../utils/ruleMessages');
  8. const validateOptions = require('../../utils/validateOptions');
  9. const ruleName = 'selector-attribute-quotes';
  10. const messages = ruleMessages(ruleName, {
  11. expected: (value) => `Expected quotes around "${value}"`,
  12. rejected: (value) => `Unexpected quotes around "${value}"`,
  13. });
  14. const meta = {
  15. url: 'https://stylelint.io/user-guide/rules/selector-attribute-quotes',
  16. fixable: true,
  17. };
  18. const acceptedQuoteMark = '"';
  19. /** @type {import('stylelint').Rule<'always' | 'never'>} */
  20. const rule = (primary, _secondaryOptions, context) => {
  21. return (root, result) => {
  22. const validOptions = validateOptions(result, ruleName, {
  23. actual: primary,
  24. possible: ['always', 'never'],
  25. });
  26. if (!validOptions) {
  27. return;
  28. }
  29. root.walkRules((ruleNode) => {
  30. if (!isStandardSyntaxRule(ruleNode)) {
  31. return;
  32. }
  33. const { selector } = ruleNode;
  34. if (!selector.includes('[') || !selector.includes('=')) {
  35. return;
  36. }
  37. parseSelector(getRuleSelector(ruleNode), result, ruleNode, (selectorTree) => {
  38. let selectorFixed = false;
  39. selectorTree.walkAttributes((attributeNode) => {
  40. const { operator, value, quoted } = attributeNode;
  41. if (!operator || !value) {
  42. return;
  43. }
  44. if (!quoted && primary === 'always') {
  45. if (context.fix) {
  46. selectorFixed = true;
  47. attributeNode.quoteMark = acceptedQuoteMark;
  48. } else {
  49. complain(messages.expected(value), attributeNode);
  50. }
  51. }
  52. if (quoted && primary === 'never') {
  53. // some selectors require quotes to be valid;
  54. // we pass in the raw string value, which contains the escape characters
  55. // necessary to check if escaped characters are valid
  56. // see: https://github.com/stylelint/stylelint/issues/4300
  57. if (
  58. !attributeNode.raws.value ||
  59. !isValidIdentifier(attributeNode.raws.value.slice(1, -1))
  60. ) {
  61. return;
  62. }
  63. if (context.fix) {
  64. selectorFixed = true;
  65. attributeNode.quoteMark = null;
  66. } else {
  67. complain(messages.rejected(value), attributeNode);
  68. }
  69. }
  70. });
  71. if (selectorFixed) {
  72. ruleNode.selector = selectorTree.toString();
  73. }
  74. });
  75. /**
  76. * @param {string} message
  77. * @param {import('postcss-selector-parser').Attribute} attrNode
  78. */
  79. function complain(message, attrNode) {
  80. const index = attrNode.sourceIndex + attrNode.offsetOf('value');
  81. const value = attrNode.raws.value || attrNode.value || '';
  82. const endIndex = index + value.length;
  83. report({
  84. message,
  85. index,
  86. endIndex,
  87. result,
  88. ruleName,
  89. node: ruleNode,
  90. });
  91. }
  92. });
  93. };
  94. };
  95. rule.ruleName = ruleName;
  96. rule.messages = messages;
  97. rule.meta = meta;
  98. module.exports = rule;