[New] jsx-sort-props: add customPropsFirst to support custom props list for sorting
#3853
Conversation
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
…s list for sorting
ljharb
requested changes
Nov 18, 2024
|
|
||
| This can only be an array option. | ||
|
|
||
| When `customPropsFirst` is defined, the specified custom props must be listed before all other props, but still respecting the alphabetical order: |
There was a problem hiding this comment.
Suggested change
| When `customPropsFirst` is defined, the specified custom props must be listed before all other props, but still respecting the alphabetical order: | |
| When `customPropsFirst` is defined, the specified custom props must be listed before all other props, but still respecting the configured order within the set of custom props: |
| <Hello className="flex" theme="light" name="John" /> | ||
| ``` | ||
|
|
||
| If both `reservedFirst` and `customPropsFirst` are defined, reserved props are listed first, followed by custom props, and then all other props, but still respecting the alphabetical order: |
There was a problem hiding this comment.
Suggested change
| If both `reservedFirst` and `customPropsFirst` are defined, reserved props are listed first, followed by custom props, and then all other props, but still respecting the alphabetical order: | |
| If both `reservedFirst` and `customPropsFirst` are defined, reserved props are listed first, followed by custom props, and then all other props, but still respecting the configured order within each of those three groups: |
Comment on lines
+421
to
+423
| customPropsFirst: { | ||
| type: ['array', 'boolean'], | ||
| }, |
There was a problem hiding this comment.
true probably shouldn't be an allowed value here - also, the array should be limited to a unique list of strings.
Suggested change
| customPropsFirst: { | |
| type: ['array', 'boolean'], | |
| }, | |
| customPropsFirst: { | |
| oneOf: [ | |
| { | |
| type: 'array', | |
| uniqueItems: true, | |
| items: { type: 'string' }, | |
| }, | |
| { | |
| type: 'boolean', | |
| enum: [false], | |
| }, | |
| ], | |
| }, |
Comment on lines
+327
to
+346
| /** | ||
| * Checks if the `customPropsFirst` option is valid | ||
| * @param {Object} context The context of the rule | ||
| * @param {boolean | string[]} customPropsFirst The `customPropsFirst` option | ||
| * @return {Function | undefined} If an error is detected, a function to generate the error message, otherwise, `undefined` | ||
| */ | ||
| // eslint-disable-next-line consistent-return | ||
| function validateCustomPropsFirstConfig(context, customPropsFirst) { | ||
| if (customPropsFirst) { | ||
| if (Array.isArray(customPropsFirst)) { | ||
| if (customPropsFirst.length === 0) { | ||
| return function Report(decl) { | ||
| report(context, messages.customPropsListIsEmpty, 'customPropsListIsEmpty', { | ||
| node: decl, | ||
| }); | ||
| }; | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
this should be handled by the schema, not by the plugin, and can be removed. (also an empty list is fine)
Comment on lines
+444
to
+446
| const customPropsFirst = configuration.customPropsFirst || false; | ||
| const customPropsFirstError = validateCustomPropsFirstConfig(context, customPropsFirst); | ||
| const customPropsList = Array.isArray(customPropsFirst) ? customPropsFirst : []; |
There was a problem hiding this comment.
Suggested change
| const customPropsFirst = configuration.customPropsFirst || false; | |
| const customPropsFirstError = validateCustomPropsFirstConfig(context, customPropsFirst); | |
| const customPropsList = Array.isArray(customPropsFirst) ? customPropsFirst : []; | |
| const customPropsList = configuration.customPropsFirst; |
no need to even ensure it's an array
Comment on lines
+495
to
+499
| if (customPropsFirstError) { | ||
| customPropsFirstError(decl); | ||
| return memo; | ||
| } | ||
|
|
There was a problem hiding this comment.
Suggested change
| if (customPropsFirstError) { | |
| customPropsFirstError(decl); | |
| return memo; | |
| } |
|
Wow @ljharb thank you for such a prompt review and moving forward with my PR, appreciate it I'll get back here soon with resolving your comments and updating tests |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR brings a new
customPropsFirstoption forjsx-sort-propsto support custom user's props list for sortingRefering to: #3851
Resolving issues: #3175 #3639 #3193
It's my first time writing an ESLint rule option, so please let me know what could be better. Also, this is my first time writing tests. I expect we'll have to write a lot more than I've come up with so far, but let's start with this