Add eslint rule for preventing string literals in select/dispatch/useDispatch #28726
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
17 tasks
|
Size Change: -12 B (0%) Total Size: 1.37 MB
ℹ️ View Unchanged
|
gziolo
added
[Type] Code Quality
david-szabo97
force-pushed
the
add/eslint-rule-for-store-string-literals
branch
from
080ac2d
to
fd5f95f
Compare
|
Let's downgrade those new rules to warning level and land immediately to simplify the process for remaining hardcoded store references. |
david-szabo97
added
[Package] ESLint plugin
david-szabo97
requested review from
vindl,
mattwiebe,
Addison-Stavlo,
Copons,
gziolo and
jeyip
david-szabo97
requested review from
ajitbohra,
nerrad and
ntwb
as code owners
david-szabo97
force-pushed
the
add/eslint-rule-for-store-string-literals
branch
from
1f4a643
to
ca1cea1
Compare
|
Found one false report. We use import { text, select } from '@storybook/addon-knobs'; |
Yes, I see this being an issue in more places. It should match the following:
Plus something you listed related to the registry maybe, definitely less common. I don't mind we start small and expand later. It probably should always remind off in the recommended WordPress ESLint config since it's totally fine to reference a store as a string in a small plugin. We should also document this rule and add tests (which is quite simple with the rule tester). Let me know how would you like to split work so I could help you land this PR. |
I'm looking into how to make this more accurate.
If you could take care of documenting and testing that would be great! |
gziolo
added
the
[Type] New API
|
The rule seems to work! Added tests as well. |
gziolo
reviewed
Feb 9, 2021
packages/eslint-plugin/rules/__tests__/no-store-string-literals.js
Outdated
Show resolved
Hide resolved
gziolo
approved these changes
Feb 9, 2021
There was a problem hiding this comment.
I added missing documentation and left two minor comments. In general, this PR is ready to land. It just needs to be aligned in regards to the rule name. You can pick whatever works best for you but make sure you update docs accordingly.
Thank you for working on this rule. It's going to be super helpful ❤️
|
All the issues reported by CI seem to be unrelated 🤷🏻♂️ |
7 tasks
This was referenced Mar 18, 2021
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.
Description
Follow-up for #26655.
Add warning for these function calls:
select,dispatch,useDispatch,withDispatch,withSelect,createRegistrySelector,controls.select,controls.dispatch, andcontrols.resolveSelectif the first argument is a literal.Examples that will show a warning:
How has this been tested?
npm run lint-jsselect,dispatch,useDispatch,withDispatch,withSelect,createRegistrySelector,controls.select,controls.dispatch, andcontrols.resolveSelect.Types of changes
Code quality
Checklist: