Skip to content

fix(linter): Enforce config options for react/forbid-dom-props rule.#19387

Merged
graphite-app[bot] merged 1 commit intomainfrom
forbid-dom-props-option-config
Feb 15, 2026
Merged

fix(linter): Enforce config options for react/forbid-dom-props rule.#19387
graphite-app[bot] merged 1 commit intomainfrom
forbid-dom-props-option-config

Conversation

@connorshea
Copy link
Member

And add proper documentation for the config options so the docs page actually has details on how the config works. This also simplifies the code a bit. Part of #14743.

Basically, the changes are:

  • Move the logic for deserializing the complex JSON config out of from_configuration into a derived From.
  • Remove "Options" doc section from the doc block.
  • Add an actual JsonSchema for the config on this rule so we can auto-generate the docs page.
  • Simplified the logic for deserialization a bit to remove extra, unnecessary code.

Generated config docs:

## Configuration

Configuration for the `forbid-dom-props` rule.

This rule accepts a configuration object with the following properties:

### forbid

type: `array`

An array of prop names or objects that are forbidden on DOM elements.

Each array element can be a string with the property name, or an object
with `propName`, an optional `disallowedFor` array of DOM node names,
and an optional custom `message`.

Examples:

- `["error", { "forbid": ["id", "style"] }]`
- `["error", { "forbid": [{ "propName": "className", "message": "Use class instead" }] }]`
- `["error", { "forbid": [{ "propName": "style", "disallowedFor": ["div", "span"] }] }]`

#### forbid[n]

type: `object | string`

A forbidden prop, either as a plain prop name string or with options.

##### forbid[n].disallowedFor

type: `string[]`

A list of DOM element names (e.g. `["div", "span"]`) on which this
prop is forbidden. If empty or omitted, the prop is forbidden on all
DOM elements.

##### forbid[n].message

type: `string`

A custom message to display when this prop is used.

##### forbid[n].propName

type: `string`

The name of the prop to forbid.

AI Disclosure: Built with help from Claude Code, Opus 4.6. Tested and reviewed by me, no changes to the test cases/snaps.

Copilot AI review requested due to automatic review settings February 14, 2026 20:29
@connorshea connorshea requested a review from camc314 as a code owner February 14, 2026 20:29
@github-actions github-actions bot added the A-linter Area - Linter label Feb 14, 2026
@connorshea connorshea changed the title fix(linter): Enforce config options for react/forbid-dom-props rule. fix(linter): Enforce config options for react/forbid-dom-props rule. Feb 14, 2026
@github-actions github-actions bot added the C-bug Category - Bug label Feb 14, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR tightens and documents configuration handling for the react/forbid-dom-props lint rule by moving from ad-hoc serde_json::Value parsing to a typed, schema-backed configuration model that can be used for auto-generated docs.

Changes:

  • Introduces typed config types (ForbidDomPropsConfig, ForbidDomPropsItem) with Deserialize + JsonSchema for documentation generation.
  • Simplifies config parsing by switching from_configuration to DefaultRuleConfig<Self> and converting into an internal lookup map via From.
  • Removes the manual “Options” section from the rule doc block in favor of schema-driven docs.

@codspeed-hq
Copy link

codspeed-hq bot commented Feb 14, 2026

Merging this PR will not alter performance

✅ 47 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing forbid-dom-props-option-config (540da79) with main (bbced8d)

Open in CodSpeed

Footnotes

  1. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@camc314 camc314 self-assigned this Feb 15, 2026
@camc314 camc314 added the 0-merge Merge with Graphite Merge Queue label Feb 15, 2026
Copy link
Contributor

camc314 commented Feb 15, 2026

Merge activity

#19387)

And add proper documentation for the config options so the docs page actually has details on how the config works. This also simplifies the code a bit. Part of #14743.

Basically, the changes are:

- Move the logic for deserializing the complex JSON config out of `from_configuration` into a derived `From`.
- Remove "Options" doc section from the doc block.
- Add an actual JsonSchema for the config on this rule so we can auto-generate the docs page.
- Simplified the logic for deserialization a bit to remove extra, unnecessary code.

Generated config docs:

````md
## Configuration

Configuration for the `forbid-dom-props` rule.

This rule accepts a configuration object with the following properties:

### forbid

type: `array`

An array of prop names or objects that are forbidden on DOM elements.

Each array element can be a string with the property name, or an object
with `propName`, an optional `disallowedFor` array of DOM node names,
and an optional custom `message`.

Examples:

- `["error", { "forbid": ["id", "style"] }]`
- `["error", { "forbid": [{ "propName": "className", "message": "Use class instead" }] }]`
- `["error", { "forbid": [{ "propName": "style", "disallowedFor": ["div", "span"] }] }]`

#### forbid[n]

type: `object | string`

A forbidden prop, either as a plain prop name string or with options.

##### forbid[n].disallowedFor

type: `string[]`

A list of DOM element names (e.g. `["div", "span"]`) on which this
prop is forbidden. If empty or omitted, the prop is forbidden on all
DOM elements.

##### forbid[n].message

type: `string`

A custom message to display when this prop is used.

##### forbid[n].propName

type: `string`

The name of the prop to forbid.
````

AI Disclosure: Built with help from Claude Code, Opus 4.6. Tested and reviewed by me, no changes to the test cases/snaps.
@graphite-app graphite-app bot force-pushed the forbid-dom-props-option-config branch from 540da79 to c2b1870 Compare February 15, 2026 12:57
@graphite-app graphite-app bot merged commit c2b1870 into main Feb 15, 2026
21 checks passed
@graphite-app graphite-app bot deleted the forbid-dom-props-option-config branch February 15, 2026 13:03
camc314 pushed a commit that referenced this pull request Feb 16, 2026
# Oxlint
### 💥 BREAKING CHANGES

- 7711821 oxlint: [**BREAKING**] `no-shadow-restricted-names` report
`globalThis` by default (#19407) (Sysix)

### 🚀 Features

- ce1baa0 linter: Implement eslint/no-shadow (#18979) (Víctor Fernández)
- 7a333c1 linter: Support dynamic configs via CLI arguments (#19384)
(camc314)
- 1bf569b linter: Implement typescript/unified-signatures (#19375)
(camc314)
- 6562a9b linter: Implement typescript/parameter-properties (#19374)
(camc314)
- 94d8d74 linter: Implement typescript/no-use-before-define (#19373)
(camc314)
- 80b002a linter: Implement fixer for unicorn/no-instanceof-builtins
(#19371) (camc314)
- 5c3784b linter: Implement eslint/no-unmodified-loop-condition (#19341)
(Vincent R)
- cc00a59 linter/const-comparisons: Improve diagnostics when mixing
logical/comparison operators (#19370) (camc314)
- ea2c401 linter: Add support for no constructed context values (#18067)
(Jovi De Croock)
- f2440eb linter: Mark eslint/no-return-assign as having no fixer
(#19327) (camc314)
- 8588670 linter/unicorn: Implement suggestion for
`unicorn/no-await-in-promise-methods` rule (#19359) (Mikhail Baev)
- f0af965 linter: Move `jsx-a11y/no-static-element-interactions` rule
out of the nursery. (#19355) (connorshea)
- be0ce50 linter/tsgolint: Add support for labeled ranges in tsgolint
diagnostics (#19201) (camchenry)
- b5bc900 linter: Implement fixer for unicorn/no-new-buffer (#19326)
(camc314)
- 1612932 linter: Add typescript/no-unnecessary-condition (#19130)
(camc314)
- 37dc6c5 linter: Implement fixer for unicorn/prefer-includes (#19323)
(camc314)

### 🐛 Bug Fixes

- c2b1870 linter: Enforce config options for `react/forbid-dom-props`
rule. (#19387) (connorshea)
- 3d24e44 linter: Honor no-empty-function allow getters/setters for
object literals (#19393) (camc314)
- bbced8d linter: Enforce config options for `eslint/no-empty-function`
rule, improve docs. (#19390) (connorshea)
- 6bc8aec linter: Fix the behavior of `import/extensions` rule for a
file that has multiple extensions. (#18919) (connorshea)
- c62a295 linter/img-redundant-alt: Enforce whole-word matching for
redundant alt text (#19367) (camc314)
- 98956fe linter/describe-function-title: Skip autofix for type-only
imports (#19329) (camc314)
- d96d26d linter/plugins: Provide `parser.version` (#19364)
(overlookmotel)
- 81f0039 linter_codegen: Compute rule IDs relative to previous rule
(#19350) (camchenry)
- b7ef0a8 linter/consistent-indexed-object-style: Avoid unsafe Record
conversions for mapped types (#19320) (camc314)

### 📚 Documentation

- 3a6059f linter: Improve docs for `eslint/require-await` rule. (#19361)
(connorshea)
- b069269 linter/plugins: Add comment about deprecated `ScopeManager`
methods (#19363) (overlookmotel)
- 2d8aaf9 linter: Disable formatting for `eslint/no-unsafe-negation`
examples. (#19347) (connorshea)
- fb87806 linter: Ensure that we do not auto-format the docs for
`unicorn/number-literal-case` rule. (#19346) (connorshea)
- 8d3ae27 linter/typescript: Skip docs for deprecated type aware rule
options (#19324) (camc314)
# Oxfmt
### 💥 BREAKING CHANGES

- 00135b5 formatter/sort_imports: [**BREAKING**] Change default `groups`
order (#19427) (leaysgur)
- 9c34f72 formatter/sort_imports: [**BREAKING**] Report invalid group
name with renaming `side-effect` > `side_effect` (#19416) (leaysgur)

### 🚀 Features

- 4baebef formatter/sort_imports: Support `{ newlinesBetween: bool }`
inside `groups` (#19358) (leaysgur)
- d1c2fb6 formatter/sort_imports: Support `customGroups`
attributes(`selector` and `modifiers`) (#19356) (leaysgur)

### 🐛 Bug Fixes

- f084ea6 oxfmt: Explicitly pass `process.env` for the forked process
(#19380) (Long Ho)
- 2bc7a14 formatter: Arrow function body incorrectly broken when return
type has comment (#19368) (Dunqing)
- 90ec3d2 oxfmt: Update tailwind plugin which fixes crash on non-js file
(#19353) (leaysgur)
- e9c5b1e formatter: Treat `PrivateFieldExpression` as simple call
argument (#19348) (Dunqing)
- 80643d5 formatter: Match Prettier union indentation with leading
comments (#19271) (Dunqing)

### ⚡ Performance

- c169c77 syntax: Optimize `is_identifier_name_patched` (#19386)
(sapphi-red)
OskarLebuda pushed a commit to OskarLebuda/oxc that referenced this pull request Feb 17, 2026
oxc-project#19387)

And add proper documentation for the config options so the docs page actually has details on how the config works. This also simplifies the code a bit. Part of oxc-project#14743.

Basically, the changes are:

- Move the logic for deserializing the complex JSON config out of `from_configuration` into a derived `From`.
- Remove "Options" doc section from the doc block.
- Add an actual JsonSchema for the config on this rule so we can auto-generate the docs page.
- Simplified the logic for deserialization a bit to remove extra, unnecessary code.

Generated config docs:

````md
## Configuration

Configuration for the `forbid-dom-props` rule.

This rule accepts a configuration object with the following properties:

### forbid

type: `array`

An array of prop names or objects that are forbidden on DOM elements.

Each array element can be a string with the property name, or an object
with `propName`, an optional `disallowedFor` array of DOM node names,
and an optional custom `message`.

Examples:

- `["error", { "forbid": ["id", "style"] }]`
- `["error", { "forbid": [{ "propName": "className", "message": "Use class instead" }] }]`
- `["error", { "forbid": [{ "propName": "style", "disallowedFor": ["div", "span"] }] }]`

#### forbid[n]

type: `object | string`

A forbidden prop, either as a plain prop name string or with options.

##### forbid[n].disallowedFor

type: `string[]`

A list of DOM element names (e.g. `["div", "span"]`) on which this
prop is forbidden. If empty or omitted, the prop is forbidden on all
DOM elements.

##### forbid[n].message

type: `string`

A custom message to display when this prop is used.

##### forbid[n].propName

type: `string`

The name of the prop to forbid.
````

AI Disclosure: Built with help from Claude Code, Opus 4.6. Tested and reviewed by me, no changes to the test cases/snaps.
OskarLebuda pushed a commit to OskarLebuda/oxc that referenced this pull request Feb 17, 2026
# Oxlint
### 💥 BREAKING CHANGES

- 7711821 oxlint: [**BREAKING**] `no-shadow-restricted-names` report
`globalThis` by default (oxc-project#19407) (Sysix)

### 🚀 Features

- ce1baa0 linter: Implement eslint/no-shadow (oxc-project#18979) (Víctor Fernández)
- 7a333c1 linter: Support dynamic configs via CLI arguments (oxc-project#19384)
(camc314)
- 1bf569b linter: Implement typescript/unified-signatures (oxc-project#19375)
(camc314)
- 6562a9b linter: Implement typescript/parameter-properties (oxc-project#19374)
(camc314)
- 94d8d74 linter: Implement typescript/no-use-before-define (oxc-project#19373)
(camc314)
- 80b002a linter: Implement fixer for unicorn/no-instanceof-builtins
(oxc-project#19371) (camc314)
- 5c3784b linter: Implement eslint/no-unmodified-loop-condition (oxc-project#19341)
(Vincent R)
- cc00a59 linter/const-comparisons: Improve diagnostics when mixing
logical/comparison operators (oxc-project#19370) (camc314)
- ea2c401 linter: Add support for no constructed context values (oxc-project#18067)
(Jovi De Croock)
- f2440eb linter: Mark eslint/no-return-assign as having no fixer
(oxc-project#19327) (camc314)
- 8588670 linter/unicorn: Implement suggestion for
`unicorn/no-await-in-promise-methods` rule (oxc-project#19359) (Mikhail Baev)
- f0af965 linter: Move `jsx-a11y/no-static-element-interactions` rule
out of the nursery. (oxc-project#19355) (connorshea)
- be0ce50 linter/tsgolint: Add support for labeled ranges in tsgolint
diagnostics (oxc-project#19201) (camchenry)
- b5bc900 linter: Implement fixer for unicorn/no-new-buffer (oxc-project#19326)
(camc314)
- 1612932 linter: Add typescript/no-unnecessary-condition (oxc-project#19130)
(camc314)
- 37dc6c5 linter: Implement fixer for unicorn/prefer-includes (oxc-project#19323)
(camc314)

### 🐛 Bug Fixes

- c2b1870 linter: Enforce config options for `react/forbid-dom-props`
rule. (oxc-project#19387) (connorshea)
- 3d24e44 linter: Honor no-empty-function allow getters/setters for
object literals (oxc-project#19393) (camc314)
- bbced8d linter: Enforce config options for `eslint/no-empty-function`
rule, improve docs. (oxc-project#19390) (connorshea)
- 6bc8aec linter: Fix the behavior of `import/extensions` rule for a
file that has multiple extensions. (oxc-project#18919) (connorshea)
- c62a295 linter/img-redundant-alt: Enforce whole-word matching for
redundant alt text (oxc-project#19367) (camc314)
- 98956fe linter/describe-function-title: Skip autofix for type-only
imports (oxc-project#19329) (camc314)
- d96d26d linter/plugins: Provide `parser.version` (oxc-project#19364)
(overlookmotel)
- 81f0039 linter_codegen: Compute rule IDs relative to previous rule
(oxc-project#19350) (camchenry)
- b7ef0a8 linter/consistent-indexed-object-style: Avoid unsafe Record
conversions for mapped types (oxc-project#19320) (camc314)

### 📚 Documentation

- 3a6059f linter: Improve docs for `eslint/require-await` rule. (oxc-project#19361)
(connorshea)
- b069269 linter/plugins: Add comment about deprecated `ScopeManager`
methods (oxc-project#19363) (overlookmotel)
- 2d8aaf9 linter: Disable formatting for `eslint/no-unsafe-negation`
examples. (oxc-project#19347) (connorshea)
- fb87806 linter: Ensure that we do not auto-format the docs for
`unicorn/number-literal-case` rule. (oxc-project#19346) (connorshea)
- 8d3ae27 linter/typescript: Skip docs for deprecated type aware rule
options (oxc-project#19324) (camc314)
# Oxfmt
### 💥 BREAKING CHANGES

- 00135b5 formatter/sort_imports: [**BREAKING**] Change default `groups`
order (oxc-project#19427) (leaysgur)
- 9c34f72 formatter/sort_imports: [**BREAKING**] Report invalid group
name with renaming `side-effect` > `side_effect` (oxc-project#19416) (leaysgur)

### 🚀 Features

- 4baebef formatter/sort_imports: Support `{ newlinesBetween: bool }`
inside `groups` (oxc-project#19358) (leaysgur)
- d1c2fb6 formatter/sort_imports: Support `customGroups`
attributes(`selector` and `modifiers`) (oxc-project#19356) (leaysgur)

### 🐛 Bug Fixes

- f084ea6 oxfmt: Explicitly pass `process.env` for the forked process
(oxc-project#19380) (Long Ho)
- 2bc7a14 formatter: Arrow function body incorrectly broken when return
type has comment (oxc-project#19368) (Dunqing)
- 90ec3d2 oxfmt: Update tailwind plugin which fixes crash on non-js file
(oxc-project#19353) (leaysgur)
- e9c5b1e formatter: Treat `PrivateFieldExpression` as simple call
argument (oxc-project#19348) (Dunqing)
- 80643d5 formatter: Match Prettier union indentation with leading
comments (oxc-project#19271) (Dunqing)

### ⚡ Performance

- c169c77 syntax: Optimize `is_identifier_name_patched` (oxc-project#19386)
(sapphi-red)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

0-merge Merge with Graphite Merge Queue A-linter Area - Linter C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments