validateQuoteMarks: add "ignoreJSX" value

Fixes #1953
Closes gh-1962

Author: markelog

lib/rules/validate-quote-marks.js

@@ -10,6 +10,7 @@
  *  - `Object`:
  *     - `escape`: allow the "other" quote mark to be used, but only to avoid having to escape
  *     - `mark`: the same effect as the non-object values
+ *     - `ignoreJSX`: ignore JSX nodes
  *
  * JSHint: [`quotmark`](http://jshint.com/docs/options/#quotmark)
  *
@@ -28,13 +29,20 @@
  * var x = "x";
  * var y = '"x"';
  * ```
+ *
  * ##### Invalid example for mode `{ "mark": "\"", "escape": true }`
  *
  * ```js
  * var x = "x";
  * var y = 'x';
  * ```
  *
+ * ##### Valid example for mode `{ "mark": "'", "escape": true, "ignoreJSX": true }`
+ *
+ * ```js
+ * <div className="flex-card__header">{this.props.children}</div>;
+ * ```
+ *
  * ##### Valid example for mode `"\""` or mode `true`
  *
  * ```js
@@ -62,13 +70,19 @@ module.exports.prototype = {
 
     configure: function(quoteMark) {
         this._allowEscape = false;
+        this._ignoreJSX = false;
 
         if (typeof quoteMark === 'object') {
             assert(
                 typeof quoteMark.escape === 'boolean' && quoteMark.mark !== undefined,
                 this.getOptionName() + ' option requires the "escape" and "mark" property to be defined'
             );
             this._allowEscape = quoteMark.escape;
+
+            if (quoteMark.ignoreJSX) {
+                this._ignoreJSX = quoteMark.ignoreJSX;
+            }
+
             quoteMark = quoteMark.mark;
         }
 
@@ -77,6 +91,11 @@ module.exports.prototype = {
             this.getOptionName() + ' option requires \'"\', "\'", or boolean true'
         );
 
+        assert(
+            quoteMark === '"' || quoteMark === '\'' || quoteMark === true,
+            this.getOptionName() + ' option requires \'"\', "\'", or boolean true'
+        );
+
         this._quoteMark = quoteMark;
     },
 
@@ -87,12 +106,20 @@ module.exports.prototype = {
     check: function(file, errors) {
         var quoteMark = this._quoteMark;
         var allowEscape = this._allowEscape;
+        var ignoreJSX = this._ignoreJSX;
+
         var opposite = {
             '"': '\'',
             '\'': '"'
         };
-
         file.iterateTokensByType('String', function(token) {
+            if (
+                ignoreJSX &&
+                file.getNodeByRange(token.range[0]).parentNode.type === 'JSXAttribute'
+            ) {
+                return;
+            }
+
             var str = token.value;
             var mark = str[0];
             var stripped = str.substring(1, str.length - 1);

test/specs/rules/validate-quote-marks.js

@@ -24,6 +24,28 @@ describe('rules/validate-quote-marks', function() {
         });
     });
 
+    describe('JSX', function() {
+        it('should not report any errors for JSX attribute', function() {
+            checker.configure({
+                validateQuoteMarks: { mark: '\'', ignoreJSX: true, escape: true },
+                esnext: true
+            });
+
+            var str = '<div className="flex-card__header">{this.props.children}</div>;';
+            expect(checker.checkString(str)).to.not.have.errors();
+        });
+
+        it('should report errors for JSX attribute', function() {
+            checker.configure({
+                validateQuoteMarks: { mark: '\'', escape: true },
+                esnext: true
+            });
+
+            var str = '<div className="flex-card__header">{this.props.children}</div>;';
+            expect(checker.checkString(str)).to.have.errors.from('validateQuoteMarks');
+        });
+    });
+
     describe('option value \' ', function() {
         beforeEach(function() {
             checker.configure({ validateQuoteMarks: '\'' });