index.js 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. 'use strict';
  2. const hasBlock = require('../../utils/hasBlock');
  3. const optionsMatches = require('../../utils/optionsMatches');
  4. const report = require('../../utils/report');
  5. const ruleMessages = require('../../utils/ruleMessages');
  6. const { isAtRule } = require('../../utils/typeGuards');
  7. const validateOptions = require('../../utils/validateOptions');
  8. const ruleName = 'declaration-block-trailing-semicolon';
  9. const messages = ruleMessages(ruleName, {
  10. expected: 'Expected a trailing semicolon',
  11. rejected: 'Unexpected trailing semicolon',
  12. });
  13. const meta = {
  14. url: 'https://stylelint.io/user-guide/rules/declaration-block-trailing-semicolon',
  15. fixable: true,
  16. deprecated: true,
  17. };
  18. /** @type {import('stylelint').Rule} */
  19. const rule = (primary, secondaryOptions, context) => {
  20. return (root, result) => {
  21. const validOptions = validateOptions(
  22. result,
  23. ruleName,
  24. {
  25. actual: primary,
  26. possible: ['always', 'never'],
  27. },
  28. {
  29. actual: secondaryOptions,
  30. possible: {
  31. ignore: ['single-declaration'],
  32. },
  33. optional: true,
  34. },
  35. );
  36. if (!validOptions) {
  37. return;
  38. }
  39. root.walkAtRules((atRule) => {
  40. if (!atRule.parent) throw new Error('A parent node must be present');
  41. if (atRule.parent === root) {
  42. return;
  43. }
  44. if (atRule !== atRule.parent.last) {
  45. return;
  46. }
  47. if (hasBlock(atRule)) {
  48. return;
  49. }
  50. checkLastNode(atRule);
  51. });
  52. root.walkDecls((decl) => {
  53. if (!decl.parent) throw new Error('A parent node must be present');
  54. if (decl.parent.type === 'object') {
  55. return;
  56. }
  57. if (decl !== decl.parent.last) {
  58. return;
  59. }
  60. checkLastNode(decl);
  61. });
  62. /**
  63. * @param {import('postcss').Node} node
  64. */
  65. function checkLastNode(node) {
  66. if (!node.parent) throw new Error('A parent node must be present');
  67. const hasSemicolon = node.parent.raws.semicolon;
  68. const ignoreSingleDeclaration = optionsMatches(
  69. secondaryOptions,
  70. 'ignore',
  71. 'single-declaration',
  72. );
  73. if (ignoreSingleDeclaration && node.parent.first === node) {
  74. return;
  75. }
  76. let message;
  77. if (primary === 'always') {
  78. if (hasSemicolon) {
  79. return;
  80. }
  81. // auto-fix
  82. if (context.fix) {
  83. node.parent.raws.semicolon = true;
  84. if (isAtRule(node)) {
  85. node.raws.between = '';
  86. node.parent.raws.after = ' ';
  87. }
  88. return;
  89. }
  90. message = messages.expected;
  91. } else if (primary === 'never') {
  92. if (!hasSemicolon) {
  93. return;
  94. }
  95. // auto-fix
  96. if (context.fix) {
  97. node.parent.raws.semicolon = false;
  98. return;
  99. }
  100. message = messages.rejected;
  101. } else {
  102. throw new Error(`Unexpected primary option: "${primary}"`);
  103. }
  104. report({
  105. message,
  106. node,
  107. index: node.toString().trim().length - 1,
  108. result,
  109. ruleName,
  110. });
  111. }
  112. };
  113. };
  114. rule.ruleName = ruleName;
  115. rule.messages = messages;
  116. rule.meta = meta;
  117. module.exports = rule;