index.js 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. // @ts-nocheck
  2. 'use strict';
  3. const _ = require('lodash');
  4. const beforeBlockString = require('../../utils/beforeBlockString');
  5. const blockString = require('../../utils/blockString');
  6. const hasBlock = require('../../utils/hasBlock');
  7. const hasEmptyBlock = require('../../utils/hasEmptyBlock');
  8. const optionsMatches = require('../../utils/optionsMatches');
  9. const report = require('../../utils/report');
  10. const ruleMessages = require('../../utils/ruleMessages');
  11. const validateOptions = require('../../utils/validateOptions');
  12. const whitespaceChecker = require('../../utils/whitespaceChecker');
  13. const ruleName = 'block-opening-brace-space-before';
  14. const messages = ruleMessages(ruleName, {
  15. expectedBefore: () => 'Expected single space before "{"',
  16. rejectedBefore: () => 'Unexpected whitespace before "{"',
  17. expectedBeforeSingleLine: () => 'Expected single space before "{" of a single-line block',
  18. rejectedBeforeSingleLine: () => 'Unexpected whitespace before "{" of a single-line block',
  19. expectedBeforeMultiLine: () => 'Expected single space before "{" of a multi-line block',
  20. rejectedBeforeMultiLine: () => 'Unexpected whitespace before "{" of a multi-line block',
  21. });
  22. function rule(expectation, options, context) {
  23. const checker = whitespaceChecker('space', expectation, messages);
  24. return (root, result) => {
  25. const validOptions = validateOptions(
  26. result,
  27. ruleName,
  28. {
  29. actual: expectation,
  30. possible: [
  31. 'always',
  32. 'never',
  33. 'always-single-line',
  34. 'never-single-line',
  35. 'always-multi-line',
  36. 'never-multi-line',
  37. ],
  38. },
  39. {
  40. actual: options,
  41. possible: {
  42. ignoreAtRules: [_.isString, _.isRegExp],
  43. ignoreSelectors: [_.isString, _.isRegExp],
  44. },
  45. optional: true,
  46. },
  47. );
  48. if (!validOptions) {
  49. return;
  50. }
  51. // Check both kinds of statements: rules and at-rules
  52. root.walkRules(check);
  53. root.walkAtRules(check);
  54. function check(statement) {
  55. // Return early if blockless or has an empty block
  56. if (!hasBlock(statement) || hasEmptyBlock(statement)) {
  57. return;
  58. }
  59. // Return early if at-rule is to be ignored
  60. if (optionsMatches(options, 'ignoreAtRules', statement.name)) {
  61. return;
  62. }
  63. // Return early if selector is to be ignored
  64. if (optionsMatches(options, 'ignoreSelectors', statement.selector)) {
  65. return;
  66. }
  67. const source = beforeBlockString(statement);
  68. const beforeBraceNoRaw = beforeBlockString(statement, {
  69. noRawBefore: true,
  70. });
  71. let index = beforeBraceNoRaw.length - 1;
  72. if (beforeBraceNoRaw[index - 1] === '\r') {
  73. index -= 1;
  74. }
  75. checker.before({
  76. source,
  77. index: source.length,
  78. lineCheckStr: blockString(statement),
  79. err: (m) => {
  80. if (context.fix) {
  81. if (expectation.startsWith('always')) {
  82. statement.raws.between = ' ';
  83. return;
  84. }
  85. if (expectation.startsWith('never')) {
  86. statement.raws.between = '';
  87. return;
  88. }
  89. }
  90. report({
  91. message: m,
  92. node: statement,
  93. index,
  94. result,
  95. ruleName,
  96. });
  97. },
  98. });
  99. }
  100. };
  101. }
  102. rule.ruleName = ruleName;
  103. rule.messages = messages;
  104. module.exports = rule;