jsx-space-before-closing.js 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /**
  2. * @fileoverview Validate spacing before closing bracket in JSX.
  3. * @author ryym
  4. * @deprecated
  5. */
  6. 'use strict';
  7. const getTokenBeforeClosingBracket = require('../util/getTokenBeforeClosingBracket');
  8. const docsUrl = require('../util/docsUrl');
  9. const log = require('../util/log');
  10. const report = require('../util/report');
  11. let isWarnedForDeprecation = false;
  12. // ------------------------------------------------------------------------------
  13. // Rule Definition
  14. // ------------------------------------------------------------------------------
  15. const messages = {
  16. noSpaceBeforeClose: 'A space is forbidden before closing bracket',
  17. needSpaceBeforeClose: 'A space is required before closing bracket',
  18. };
  19. module.exports = {
  20. meta: {
  21. deprecated: true,
  22. docs: {
  23. description: 'Enforce spacing before closing bracket in JSX',
  24. category: 'Stylistic Issues',
  25. recommended: false,
  26. url: docsUrl('jsx-space-before-closing'),
  27. },
  28. fixable: 'code',
  29. messages,
  30. schema: [{
  31. enum: ['always', 'never'],
  32. }],
  33. },
  34. create(context) {
  35. const configuration = context.options[0] || 'always';
  36. // --------------------------------------------------------------------------
  37. // Public
  38. // --------------------------------------------------------------------------
  39. return {
  40. JSXOpeningElement(node) {
  41. if (!node.selfClosing) {
  42. return;
  43. }
  44. const sourceCode = context.getSourceCode();
  45. const leftToken = getTokenBeforeClosingBracket(node);
  46. const closingSlash = sourceCode.getTokenAfter(leftToken);
  47. if (leftToken.loc.end.line !== closingSlash.loc.start.line) {
  48. return;
  49. }
  50. if (configuration === 'always' && !sourceCode.isSpaceBetweenTokens(leftToken, closingSlash)) {
  51. report(context, messages.needSpaceBeforeClose, 'needSpaceBeforeClose', {
  52. loc: closingSlash.loc.start,
  53. fix(fixer) {
  54. return fixer.insertTextBefore(closingSlash, ' ');
  55. },
  56. });
  57. } else if (configuration === 'never' && sourceCode.isSpaceBetweenTokens(leftToken, closingSlash)) {
  58. report(context, messages.noSpaceBeforeClose, 'noSpaceBeforeClose', {
  59. loc: closingSlash.loc.start,
  60. fix(fixer) {
  61. const previousToken = sourceCode.getTokenBefore(closingSlash);
  62. return fixer.removeRange([previousToken.range[1], closingSlash.range[0]]);
  63. },
  64. });
  65. }
  66. },
  67. Program() {
  68. if (isWarnedForDeprecation) {
  69. return;
  70. }
  71. log('The react/jsx-space-before-closing rule is deprecated. '
  72. + 'Please use the react/jsx-tag-spacing rule with the '
  73. + '"beforeSelfClosing" option instead.');
  74. isWarnedForDeprecation = true;
  75. },
  76. };
  77. },
  78. };