Merge pull request #1897 from christophehurpeau/patch-1

 Rule sort-prop-types add noSortAlphabetically

Author: ljharb

docs/rules/sort-prop-types.md

@@ -83,7 +83,8 @@ class Component extends React.Component {
   "callbacksLast": <boolean>,
   "ignoreCase": <boolean>,
   "requiredFirst": <boolean>,
-  "sortShapeProp": <boolean>
+  "sortShapeProp": <boolean>,
+  "noSortAlphabetically": <boolean>
 }]
 ...
 ```
@@ -142,6 +143,20 @@ var Component = createReactClass({
 ...
 });
 ```
+### `noSortAlphabetically`
+
+When `true`, alphabetical order is not enforced:
+
+```js
+var Component = createReactClass({
+  propTypes: {
+    barRequired: PropTypes.any.isRequired,
+    z: PropTypes.string,
+    a: PropTypes.number,
+  },
+...
+});
+```
 
 ## When not to use
 

lib/rules/sort-prop-types.js

@@ -34,6 +34,10 @@ module.exports = {
         ignoreCase: {
           type: 'boolean'
         },
+        // Whether alphabetical sorting should be enforced
+        noSortAlphabetically: {
+          type: 'boolean'
+        },
         sortShapeProp: {
           type: 'boolean'
         }
@@ -48,6 +52,7 @@ module.exports = {
     const requiredFirst = configuration.requiredFirst || false;
     const callbacksLast = configuration.callbacksLast || false;
     const ignoreCase = configuration.ignoreCase || false;
+    const noSortAlphabetically = configuration.noSortAlphabetically || false;
     const sortShapeProp = configuration.sortShapeProp || false;
     const propWrapperFunctions = new Set(context.settings.propWrapperFunctions || []);
 
@@ -216,7 +221,7 @@ module.exports = {
           }
         }
 
-        if (currentPropName < prevPropName) {
+        if (!noSortAlphabetically && currentPropName < prevPropName) {
           context.report({
             node: curr,
             message: 'Prop types declarations should be sorted alphabetically',

tests/lib/rules/sort-prop-types.js

@@ -382,6 +382,36 @@ ruleTester.run('sort-prop-types', rule, {
     options: [{
       sortShapeProp: true
     }]
+  }, {
+    code: `
+      class Component extends React.Component {
+        render() {
+          return <div />;
+        }
+      }
+      Component.propTypes = {
+        a: PropTypes.any,
+        z: PropTypes.any,
+      };
+    `,
+    options: [{
+      noSortAlphabetically: true
+    }]
+  }, {
+    code: `
+      class Component extends React.Component {
+        render() {
+          return <div />;
+        }
+      }
+      Component.propTypes = {
+        z: PropTypes.any,
+        a: PropTypes.any,
+      };
+    `,
+    options: [{
+      noSortAlphabetically: true
+    }]
   }],
 
   invalid: [{
@@ -1471,5 +1501,37 @@ ruleTester.run('sort-prop-types', rule, {
         }
       }
     `
+  }, {
+    code: [
+      'var First = createReactClass({',
+      '  propTypes: {',
+      '    z: PropTypes.string,',
+      '    a: PropTypes.any',
+      '  },',
+      '  render: function() {',
+      '    return <div />;',
+      '  }',
+      '});'
+    ].join('\n'),
+    options: [{
+      noSortAlphabetically: false
+    }],
+    errors: [{
+      message: ERROR_MESSAGE,
+      line: 4,
+      column: 5,
+      type: 'Property'
+    }],
+    output: [
+      'var First = createReactClass({',
+      '  propTypes: {',
+      '    a: PropTypes.any,',
+      '    z: PropTypes.string',
+      '  },',
+      '  render: function() {',
+      '    return <div />;',
+      '  }',
+      '});'
+    ].join('\n')
   }]
 });