Move ESLint rules specific to @wordpress/components to custom rules
#74611
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
|
Contributor
Author
There was a problem hiding this comment. Changes in this file are a direct consequence of https://github.com/WordPress/gutenberg/pull/74611/changes#r2690292410. In a follow-up, I will either add the |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,88 @@ | ||
| # Disallow missing `__next40pxDefaultSize` prop (components-no-missing-40px-size-prop) | ||
|
|
||
| Enforces that specific components from `@wordpress/components` include the `__next40pxDefaultSize` prop to opt-in to the new 40px default size. | ||
|
|
||
| This is a temporary rule to help migrate components to the new default size. Once the grace period is over and all components default to the new 40px size, this rule can be removed. | ||
|
|
||
| ## Rule details | ||
|
|
||
| The following components are checked by this rule: | ||
|
|
||
| - BorderBoxControl | ||
| - BorderControl | ||
| - BoxControl | ||
| - Button | ||
| - ComboboxControl | ||
| - CustomSelectControl | ||
| - FontAppearanceControl | ||
| - FontFamilyControl | ||
| - FontSizePicker | ||
| - FormFileUpload (special case - see below) | ||
| - FormTokenField | ||
| - InputControl | ||
| - LetterSpacingControl | ||
| - LineHeightControl | ||
| - NumberControl | ||
| - RangeControl | ||
| - SelectControl | ||
| - TextControl | ||
| - ToggleGroupControl | ||
| - UnitControl | ||
|
|
||
| Examples of **incorrect** code for this rule: | ||
|
|
||
| ```jsx | ||
| import { Button, InputControl } from '@wordpress/components'; | ||
|
|
||
| <Button>Click me</Button> | ||
| <InputControl value={value} onChange={onChange} /> | ||
| <Button __next40pxDefaultSize={false}>Click me</Button> | ||
| <Button size="default">Click me</Button> | ||
| ``` | ||
|
|
||
| Examples of **correct** code for this rule: | ||
|
|
||
| ```jsx | ||
| import { Button, InputControl } from '@wordpress/components'; | ||
|
|
||
| <Button __next40pxDefaultSize>Click me</Button> | ||
| <Button __next40pxDefaultSize={true}>Click me</Button> | ||
| <InputControl __next40pxDefaultSize value={value} onChange={onChange} /> | ||
| <Button size="small">Click me</Button> | ||
| <Button size="compact">Click me</Button> | ||
| ``` | ||
|
|
||
| ## FormFileUpload special case | ||
|
|
||
| `FormFileUpload` can use either the `__next40pxDefaultSize` prop or the `render` prop to be considered valid: | ||
|
|
||
| ```jsx | ||
| import { FormFileUpload } from '@wordpress/components'; | ||
|
|
||
| // Both are valid: | ||
| <FormFileUpload __next40pxDefaultSize /> | ||
| <FormFileUpload render={({ open }) => <button onClick={open}>Upload</button>} /> | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ### checkLocalImports | ||
|
|
||
| When set to `true`, the rule also checks components imported from relative paths. This is useful inside the `@wordpress/components` package itself, where components are imported via relative paths instead of `@wordpress/components`. | ||
|
|
||
| ```json | ||
| { | ||
| "@wordpress/components-no-missing-40px-size-prop": [ | ||
| "error", | ||
| { "checkLocalImports": true } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Important notes | ||
|
|
||
| - By default, this rule only applies to components imported from `@wordpress/components`. | ||
| - Components from other packages (like `@wordpress/ui`) or locally defined components with the same name are not affected. | ||
| - Aliased imports (e.g., `import { Button as WPButton }`) are correctly tracked. | ||
| - Components with a non-default `size` prop (e.g., `size="small"`, `size="compact"`) are exempt from this rule. | ||
|
mirka marked this conversation as resolved.
|
||
| - Use the `checkLocalImports` option when linting inside the `@wordpress/components` package. | ||
This file contains hidden or 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,52 @@ | ||
| # Disallow using disabled on Button without accessibleWhenDisabled (components-no-unsafe-button-disabled) | ||
|
|
||
| Disabling a `Button` component without maintaining focusability can cause accessibility issues by hiding its presence from screen reader users, or preventing focus from returning to a trigger element. | ||
|
|
||
| This rule enforces that `Button` components from `@wordpress/components` include the `accessibleWhenDisabled` prop when the `disabled` prop is set. | ||
|
|
||
| ## Rule details | ||
|
|
||
| Examples of **incorrect** code for this rule: | ||
|
|
||
| ```jsx | ||
| import { Button } from '@wordpress/components'; | ||
|
|
||
| <Button disabled>Click me</Button> | ||
| <Button disabled={true}>Click me</Button> | ||
| <Button disabled={someVar}>Click me</Button> | ||
| ``` | ||
|
|
||
| Examples of **correct** code for this rule: | ||
|
|
||
| ```jsx | ||
| import { Button } from '@wordpress/components'; | ||
|
|
||
| <Button disabled accessibleWhenDisabled>Click me</Button> | ||
| <Button disabled accessibleWhenDisabled={true}>Click me</Button> | ||
| <Button disabled accessibleWhenDisabled={false}>Click me</Button> | ||
| <Button disabled accessibleWhenDisabled={someVar}>Click me</Button> | ||
| <Button disabled={false}>Click me</Button> | ||
| <Button onClick={handleClick}>Click me</Button> | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ### checkLocalImports | ||
|
|
||
| When set to `true`, the rule also checks `Button` components imported from relative paths. This is useful inside the `@wordpress/components` package itself, where components are imported via relative paths instead of `@wordpress/components`. | ||
|
|
||
| ```json | ||
| { | ||
| "@wordpress/components-no-unsafe-button-disabled": [ | ||
| "error", | ||
| { "checkLocalImports": true } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Important notes | ||
|
|
||
| - By default, this rule only applies to `Button` components imported from `@wordpress/components`. | ||
| - `Button` components from other packages (like `@wordpress/ui`) or locally defined components with the same name are not affected. | ||
| - Aliased imports (e.g., `import { Button as WPButton }`) are correctly tracked. | ||
| - Use the `checkLocalImports` option when linting inside the `@wordpress/components` package. |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
restrictedSyntaxComponentsis effectively replaced by the new@wordpress/components-no-unsafe-button-disabledrule