Merge pull request #506 from peet/autofix-jsx-equals-spacing

Add auto fix for jsx-equals-spacing
jsx-eslint · Mar 20, 2016 · e3c27f9 · e3c27f9
2 parents 3365231 + ef0d1d4
commit e3c27f9
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -101,7 +101,7 @@ The plugin has a [recommended configuration](#user-content-recommended-configura
 * [jsx-boolean-value](docs/rules/jsx-boolean-value.md): Enforce boolean attributes notation in JSX (fixable)
 * [jsx-closing-bracket-location](docs/rules/jsx-closing-bracket-location.md): Validate closing bracket location in JSX
 * [jsx-curly-spacing](docs/rules/jsx-curly-spacing.md): Enforce or disallow spaces inside of curly braces in JSX attributes (fixable)
-* [jsx-equals-spacing](docs/rules/jsx-equals-spacing.md): Enforce or disallow spaces around equal signs in JSX attributes
+* [jsx-equals-spacing](docs/rules/jsx-equals-spacing.md): Enforce or disallow spaces around equal signs in JSX attributes (fixable)
 * [jsx-handler-names](docs/rules/jsx-handler-names.md): Enforce event handler naming conventions in JSX
 * [jsx-indent-props](docs/rules/jsx-indent-props.md): Validate props indentation in JSX (fixable)
 * [jsx-indent](docs/rules/jsx-indent.md): Validate JSX indentation

diff --git a/docs/rules/jsx-equals-spacing.md b/docs/rules/jsx-equals-spacing.md
@@ -2,6 +2,8 @@
 
 Some style guides require or disallow spaces around equal signs.
 
+**Fixable:** This rule is automatically fixable using the `--fix` flag on the command line.
+
 ## Rule Details
 
 This rule will enforce consistency of spacing around equal signs in JSX attributes, by requiring or disallowing one or more spaces before and after `=`.

diff --git a/lib/rules/jsx-equals-spacing.js b/lib/rules/jsx-equals-spacing.js
@@ -43,14 +43,20 @@ module.exports = function(context) {
               context.report({
                 node: attrNode,
                 loc: equalToken.loc.start,
-                message: 'There should be no space before \'=\''
+                message: 'There should be no space before \'=\'',
+                fix: function(fixer) {
+                  return fixer.removeRange([attrNode.name.range[1], equalToken.start]);
+                }
               });
             }
             if (spacedAfter) {
               context.report({
                 node: attrNode,
                 loc: equalToken.loc.start,
-                message: 'There should be no space after \'=\''
+                message: 'There should be no space after \'=\'',
+                fix: function(fixer) {
+                  return fixer.removeRange([equalToken.end, attrNode.value.range[0]]);
+                }
               });
             }
             break;
@@ -59,14 +65,20 @@ module.exports = function(context) {
               context.report({
                 node: attrNode,
                 loc: equalToken.loc.start,
-                message: 'A space is required before \'=\''
+                message: 'A space is required before \'=\'',
+                fix: function(fixer) {
+                  return fixer.insertTextBefore(equalToken, ' ');
+                }
               });
             }
             if (!spacedAfter) {
               context.report({
                 node: attrNode,
                 loc: equalToken.loc.start,
-                message: 'A space is required after \'=\''
+                message: 'A space is required after \'=\'',
+                fix: function(fixer) {
+                  return fixer.insertTextAfter(equalToken, ' ');
+                }
               });
             }
             break;

diff --git a/tests/lib/rules/jsx-equals-spacing.js b/tests/lib/rules/jsx-equals-spacing.js
@@ -83,13 +83,15 @@ ruleTester.run('jsx-equals-spacing', rule, {
 
   invalid: [{
     code: '<App foo = {bar} />',
+    output: '<App foo={bar} />',
     parserOptions: parserOptions,
     errors: [
       {message: 'There should be no space before \'=\''},
       {message: 'There should be no space after \'=\''}
     ]
   }, {
     code: '<App foo = {bar} />',
+    output: '<App foo={bar} />',
     options: ['never'],
     parserOptions: parserOptions,
     errors: [
@@ -98,20 +100,23 @@ ruleTester.run('jsx-equals-spacing', rule, {
     ]
   }, {
     code: '<App foo ={bar} />',
+    output: '<App foo={bar} />',
     options: ['never'],
     parserOptions: parserOptions,
     errors: [
       {message: 'There should be no space before \'=\''}
     ]
   }, {
     code: '<App foo= {bar} />',
+    output: '<App foo={bar} />',
     options: ['never'],
     parserOptions: parserOptions,
     errors: [
       {message: 'There should be no space after \'=\''}
     ]
   }, {
     code: '<App foo= {bar} bar = {baz} />',
+    output: '<App foo={bar} bar={baz} />',
     options: ['never'],
     parserOptions: parserOptions,
     errors: [
@@ -121,6 +126,7 @@ ruleTester.run('jsx-equals-spacing', rule, {
     ]
   }, {
     code: '<App foo={bar} />',
+    output: '<App foo = {bar} />',
     options: ['always'],
     parserOptions: parserOptions,
     errors: [
@@ -129,20 +135,23 @@ ruleTester.run('jsx-equals-spacing', rule, {
     ]
   }, {
     code: '<App foo ={bar} />',
+    output: '<App foo = {bar} />',
     options: ['always'],
     parserOptions: parserOptions,
     errors: [
       {message: 'A space is required after \'=\''}
     ]
   }, {
     code: '<App foo= {bar} />',
+    output: '<App foo = {bar} />',
     options: ['always'],
     parserOptions: parserOptions,
     errors: [
       {message: 'A space is required before \'=\''}
     ]
   }, {
     code: '<App foo={bar} bar ={baz} />',
+    output: '<App foo = {bar} bar = {baz} />',
     options: ['always'],
     parserOptions: parserOptions,
     errors: [