-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename jsx-sort-prop-types to sort-prop-types
This rule has nothing to do with JSX, so it doesn't make sense for "jsx" to appear in its name. To prevent breaking this rule for people, I have set up jsx-sort-prop-types as an alias with a deprecation warning. Eventually, we should remove it altogether. For the deprecation warning, I borrowed code from jsx-quotes. While I was at it, I corrected some minor wording issues in the documentation for this rule (mostly using "propTypes" instead of "propsTypes"). Fixes #87.
- Loading branch information
Showing
6 changed files
with
777 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /** | ||
| * @fileoverview Enforce propTypes declarations alphabetical sorting | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| // ------------------------------------------------------------------------------ | ||
| // Rule Definition | ||
| // ------------------------------------------------------------------------------ | ||
|
|
||
| module.exports = function(context) { | ||
|
|
||
| var configuration = context.options[0] || {}; | ||
| var requiredFirst = configuration.requiredFirst || false; | ||
| var callbacksLast = configuration.callbacksLast || false; | ||
| var ignoreCase = configuration.ignoreCase || false; | ||
|
|
||
| /** | ||
| * Checks if node is `propTypes` declaration | ||
| * @param {ASTNode} node The AST node being checked. | ||
| * @returns {Boolean} True if node is `propTypes` declaration, false if not. | ||
| */ | ||
| function isPropTypesDeclaration(node) { | ||
|
|
||
| // Special case for class properties | ||
| // (babel-eslint does not expose property name so we have to rely on tokens) | ||
| if (node.type === 'ClassProperty') { | ||
| var tokens = context.getFirstTokens(node, 2); | ||
| return (tokens[0] && tokens[0].value === 'propTypes') || | ||
| (tokens[1] && tokens[1].value === 'propTypes'); | ||
| } | ||
|
|
||
| return Boolean( | ||
| node && | ||
| node.name === 'propTypes' | ||
| ); | ||
| } | ||
|
|
||
| function getKey(node) { | ||
| return node.key.type === 'Identifier' ? node.key.name : node.key.value; | ||
| } | ||
|
|
||
| function getValueName(node) { | ||
| return node.value.property && node.value.property.name; | ||
| } | ||
|
|
||
| function isCallbackPropName(propName) { | ||
| return /^on[A-Z]/.test(propName); | ||
| } | ||
|
|
||
| function isRequiredProp(node) { | ||
| return getValueName(node) === 'isRequired'; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if propTypes declarations are sorted | ||
| * @param {Array} declarations The array of AST nodes being checked. | ||
| * @returns {void} | ||
| */ | ||
| function checkSorted(declarations) { | ||
| declarations.reduce(function(prev, curr) { | ||
| var prevPropName = getKey(prev); | ||
| var currentPropName = getKey(curr); | ||
| var previousIsRequired = isRequiredProp(prev); | ||
| var currentIsRequired = isRequiredProp(curr); | ||
| var previousIsCallback = isCallbackPropName(prevPropName); | ||
| var currentIsCallback = isCallbackPropName(currentPropName); | ||
|
|
||
| if (ignoreCase) { | ||
| prevPropName = prevPropName.toLowerCase(); | ||
| currentPropName = currentPropName.toLowerCase(); | ||
| } | ||
|
|
||
| if (requiredFirst) { | ||
| if (previousIsRequired && !currentIsRequired) { | ||
| // Transition between required and non-required. Don't compare for alphabetical. | ||
| return curr; | ||
| } | ||
| if (!previousIsRequired && currentIsRequired) { | ||
| // Encountered a non-required prop after a required prop | ||
| context.report(curr, 'Required prop types must be listed before all other prop types'); | ||
| return curr; | ||
| } | ||
| } | ||
|
|
||
| if (callbacksLast) { | ||
| if (!previousIsCallback && currentIsCallback) { | ||
| // Entering the callback prop section | ||
| return curr; | ||
| } | ||
| if (previousIsCallback && !currentIsCallback) { | ||
| // Encountered a non-callback prop after a callback prop | ||
| context.report(prev, 'Callback prop types must be listed after all other prop types'); | ||
| return prev; | ||
| } | ||
| } | ||
|
|
||
| if (currentPropName < prevPropName) { | ||
| context.report(curr, 'Prop types declarations should be sorted alphabetically'); | ||
| return prev; | ||
| } | ||
|
|
||
| return curr; | ||
| }, declarations[0]); | ||
| } | ||
|
|
||
| return { | ||
| ClassProperty: function(node) { | ||
| if (isPropTypesDeclaration(node) && node.value && node.value.type === 'ObjectExpression') { | ||
| checkSorted(node.value.properties); | ||
| } | ||
| }, | ||
|
|
||
| MemberExpression: function(node) { | ||
| if (isPropTypesDeclaration(node.property)) { | ||
| var right = node.parent.right; | ||
| if (right && right.type === 'ObjectExpression') { | ||
| checkSorted(right.properties); | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| ObjectExpression: function(node) { | ||
| node.properties.forEach(function(property) { | ||
| if (!property.key) { | ||
| return; | ||
| } | ||
|
|
||
| if (!isPropTypesDeclaration(property.key)) { | ||
| return; | ||
| } | ||
| if (property.value.type === 'ObjectExpression') { | ||
| checkSorted(property.value.properties); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| }; | ||
| }; | ||
|
|
||
| module.exports.schema = [{ | ||
| type: 'object', | ||
| properties: { | ||
| requiredFirst: { | ||
| type: 'boolean' | ||
| }, | ||
| callbacksLast: { | ||
| type: 'boolean' | ||
| }, | ||
| ignoreCase: { | ||
| type: 'boolean' | ||
| } | ||
| }, | ||
| additionalProperties: false | ||
| }]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.