Eslint: Add rule to prohibit unsafe APIs #27301
Merged
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
sirreal
added
[Tool] ESLint plugin
sirreal
commented
Nov 26, 2020
|
Size Change: +42 B (0%) Total Size: 1.2 MB
ℹ️ View Unchanged
|
|
Example output from Gutenberg (npm run lint-js) without the rule disabled: lint results |
gziolo
reviewed
Nov 26, 2020
gziolo
reviewed
Nov 26, 2020
There was a problem hiding this comment.
This is really cool and the proposed configuration is excellent:
- disabled in Gutenberg
- errors for external usage of
@wordpress/eslint-plugin
It will give feedback whenever someone tries to use those experimental APIs which otherwise could be misunderstood.
One note, it would be good to link to some documentation when showing an error.
sirreal
added a commit
to Automattic/wp-calypso
that referenced
this pull request
Nov 26, 2020
Based on improvements in WordPress/gutenberg#27301
sirreal
commented
Nov 26, 2020
Agreed… do you think a link to the rule's documentation, or to the documentation on experimental and unstable features? |
sirreal
changed the title
6 tasks
How about this one: https://developer.wordpress.org/block-editor/contributors/develop/coding-guidelines/#experimental-and-unstable-apis? |
gziolo
reviewed
Nov 27, 2020
gziolo
approved these changes
Nov 27, 2020
There was a problem hiding this comment.
Now that this rule isn't in use, according to what we discussed in https://github.com/WordPress/gutenberg/pull/27301/files#r531074490, we can merge it and start playing with it in external projects.
Limitations: This is limited to imported names from @wordpress/* modules. This covers some of the features, but will not prevent usage of experimental or unstable APIs that do not appear as imported names. For example, this would not cover component properties like <MyComponent __experimentalProp={ true } />.
The usage in JSX would be quite a good candidate to enhance this rule in the future. Another use case I can think of is select or dispatch calls (and their counterparts) that use selectors and actions. Although the latter is quite challenging to process.
gziolo
added
[Type] New API
Yes, it's more difficult. I wonder |
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
Add a rule
@wordpress/no-unsafe-wp-apisto prohibit usage of__unsafeand__experimentalexported names from@wordpress/*packages. Usage of these features is discouraged.See the included documentation.
Limitations: This is limited to imported names from
@wordpress/*modules. This covers some of the features, but will not prevent usage of experimental or unstable APIs that do not appear as imported names. For example, this would not cover component properties like<MyComponent __experimentalProp={ true } />.Todo:
How has this been tested?
Includes tests.
Types of changes
New feature: Add
@wordpress/no-unsafe-wp-apisto discourage use of experimental and unstable features.Checklist: