index.js 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. 'use strict';
  2. const beforeBlockString = require('../../utils/beforeBlockString');
  3. const blockString = require('../../utils/blockString');
  4. const hasBlock = require('../../utils/hasBlock');
  5. const hasEmptyBlock = require('../../utils/hasEmptyBlock');
  6. const optionsMatches = require('../../utils/optionsMatches');
  7. const report = require('../../utils/report');
  8. const ruleMessages = require('../../utils/ruleMessages');
  9. const validateOptions = require('../../utils/validateOptions');
  10. const whitespaceChecker = require('../../utils/whitespaceChecker');
  11. const ruleName = 'block-opening-brace-space-after';
  12. const messages = ruleMessages(ruleName, {
  13. expectedAfter: () => 'Expected single space after "{"',
  14. rejectedAfter: () => 'Unexpected whitespace after "{"',
  15. expectedAfterSingleLine: () => 'Expected single space after "{" of a single-line block',
  16. rejectedAfterSingleLine: () => 'Unexpected whitespace after "{" of a single-line block',
  17. expectedAfterMultiLine: () => 'Expected single space after "{" of a multi-line block',
  18. rejectedAfterMultiLine: () => 'Unexpected whitespace after "{" of a multi-line block',
  19. });
  20. const meta = {
  21. url: 'https://stylelint.io/user-guide/rules/block-opening-brace-space-after',
  22. fixable: true,
  23. deprecated: true,
  24. };
  25. /** @type {import('stylelint').Rule} */
  26. const rule = (primary, secondaryOptions, context) => {
  27. const checker = whitespaceChecker('space', primary, messages);
  28. return (root, result) => {
  29. const validOptions = validateOptions(
  30. result,
  31. ruleName,
  32. {
  33. actual: primary,
  34. possible: [
  35. 'always',
  36. 'never',
  37. 'always-single-line',
  38. 'never-single-line',
  39. 'always-multi-line',
  40. 'never-multi-line',
  41. ],
  42. },
  43. {
  44. actual: secondaryOptions,
  45. possible: {
  46. ignore: ['at-rules'],
  47. },
  48. optional: true,
  49. },
  50. );
  51. if (!validOptions) {
  52. return;
  53. }
  54. // Check both kinds of statements: rules and at-rules
  55. root.walkRules(check);
  56. if (!optionsMatches(secondaryOptions, 'ignore', 'at-rules')) {
  57. root.walkAtRules(check);
  58. }
  59. /**
  60. * @param {import('postcss').Rule | import('postcss').AtRule} statement
  61. */
  62. function check(statement) {
  63. // Return early if blockless or has an empty block
  64. if (!hasBlock(statement) || hasEmptyBlock(statement)) {
  65. return;
  66. }
  67. checker.after({
  68. source: blockString(statement),
  69. index: 0,
  70. err: (m) => {
  71. if (context.fix) {
  72. const statementFirst = statement.first;
  73. if (statementFirst == null) return;
  74. if (primary.startsWith('always')) {
  75. statementFirst.raws.before = ' ';
  76. return;
  77. }
  78. if (primary.startsWith('never')) {
  79. statementFirst.raws.before = '';
  80. return;
  81. }
  82. }
  83. report({
  84. message: m,
  85. node: statement,
  86. index: beforeBlockString(statement, { noRawBefore: true }).length + 1,
  87. result,
  88. ruleName,
  89. });
  90. },
  91. });
  92. }
  93. };
  94. };
  95. rule.ruleName = ruleName;
  96. rule.messages = messages;
  97. rule.meta = meta;
  98. module.exports = rule;