Skip to content

Comments

fix(linter): Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs#15581

Merged
graphite-app[bot] merged 1 commit intomainfrom
fix-prefer-add-event
Nov 11, 2025
Merged

fix(linter): Update the unicorn/prefer-add-event-listener rule with new JavaScript APIs#15581
graphite-app[bot] merged 1 commit intomainfrom
fix-prefer-add-event

Conversation

@connorshea
Copy link
Member

This will cause new violations for some users if they're using particularly new APIs, but that should be fine.

For users migrating from the ESLint plugin, I wonder if we should consider calling out in the docs that this rule (and other rules of this nature) will potentially differ from the original Unicorn rule due to data updates over time? I ran into problems with the jsx-a11y rule in my work codebase due to this kind of improvement, so it may be worth calling out.

This also renames animationStart and animationEnd to be lowercase, as I believe this discrepancy was a mistake in the porting process. The original rule undercases these when processing them with vendor prefixes: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/609d4870f3731d39bd5b5f184628e2cf06578dba/rules/shared/dom-events.js

Sources:

I used AI to compare the lists since they're in such different formats and then checked against MDN to ensure the additions were actually real. Prompt for future reference, since I think the pattern is useful:

Are there any onX methods defined here:

\`\`\`
declare var onabort: ((this: Window, ev: UIEvent) => any) | null;
// and so on from here...
\`\`\`

That are not defined in this Rust array?:

\`\`\`
paste the DOM_EVENT_TYPE_NAMES array from the Rust file here
\`\`\`

Note that the list in rust strips out the `on` at the start. Capitalization differences matter. Link the MDN page for each function if it isn't found in the Rust list, please.

Will have to grab the first list from one of the sources above, I used the TS DOM lib generator because it tends to be quite up-to-date. Also remove the backslashes, obviously.

I also added a comment about sourcing this data for future reference.

Copilot AI review requested due to automatic review settings November 11, 2025 05:03
@connorshea connorshea requested a review from camc314 as a code owner November 11, 2025 05:03
@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 11, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

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 updates the unicorn/prefer-add-event-listener rule to include new JavaScript DOM event APIs and fixes capitalization inconsistencies. The updates ensure the rule covers modern browser event handlers while maintaining alignment with the upstream ESLint Unicorn plugin.

  • Added 15 new event handler names to match current browser APIs
  • Fixed capitalization of animationend and animationstart (previously incorrectly cased as animationEnd and animationStart)
  • Added documentation comments with data sources and maintenance guidelines

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codspeed-hq
Copy link

codspeed-hq bot commented Nov 11, 2025

CodSpeed Performance Report

Merging #15581 will not alter performance

Comparing fix-prefer-add-event (0b93a01) with main (c9591ea)

Summary

✅ 4 untouched
⏩ 33 skipped1

Footnotes

  1. 33 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 added the 0-merge Merge with Graphite Merge Queue label Nov 11, 2025
Copy link
Contributor

camc314 commented Nov 11, 2025

Merge activity

…ew JavaScript APIs (#15581)

This will cause new violations for some users if they're using particularly new APIs, but that should be fine.

For users migrating from the ESLint plugin, I wonder if we should consider calling out in the docs that this rule (and other rules of this nature) will potentially differ from the original Unicorn rule due to data updates over time? I ran into problems with the jsx-a11y rule in my work codebase due to this kind of improvement, so it may be worth calling out.

This also renames `animationStart` and `animationEnd` to be lowercase, as I believe this discrepancy was a mistake in the porting process. The original rule undercases these when processing them with vendor prefixes: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/609d4870f3731d39bd5b5f184628e2cf06578dba/rules/shared/dom-events.js

Sources:

- https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes#list_of_global_event_handler_attributes
- https://github.com/mdn/browser-compat-data/blob/d5d5f2e21ef3f798784d1f5f75bde7c7f10f250e/api/Element.json
- https://github.com/microsoft/TypeScript-DOM-lib-generator/blob/f915ac0c987300d75af41bfe4a34bb29a0fb941f/baselines/dom.generated.d.ts

I used AI to compare the lists since they're in such different formats and then checked against MDN to ensure the additions were actually real. Prompt for future reference, since I think the pattern is useful:

```
Are there any onX methods defined here:

\`\`\`
declare var onabort: ((this: Window, ev: UIEvent) => any) | null;
// and so on from here...
\`\`\`

That are not defined in this Rust array?:

\`\`\`
paste the DOM_EVENT_TYPE_NAMES array from the Rust file here
\`\`\`

Note that the list in rust strips out the `on` at the start. Capitalization differences matter. Link the MDN page for each function if it isn't found in the Rust list, please.
```

Will have to grab the first list from one of the sources above, I used the TS DOM lib generator because it tends to be quite up-to-date. Also remove the backslashes, obviously.

I also added a comment about sourcing this data for future reference.
@graphite-app graphite-app bot force-pushed the fix-prefer-add-event branch from 0b93a01 to 7a0e931 Compare November 11, 2025 09:05
@graphite-app graphite-app bot merged commit 7a0e931 into main Nov 11, 2025
20 checks passed
@graphite-app graphite-app bot deleted the fix-prefer-add-event branch November 11, 2025 09:10
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Nov 11, 2025
overlookmotel pushed a commit that referenced this pull request Nov 17, 2025
# Oxlint
### 🚀 Features

- c199e38 linter: Implement config for all tsgolint rules supporting
options (#15659) (camchenry)
- 7598b3e linter: Allow configuring tsgolint rules (#15286) (camchenry)
- e77f2ce vscode: Support `oxlint --lsp` (#15680) (Sysix)
- e01c551 oxlint: Add `--lsp` flag to run the language server (#15611)
(Sysix)
- ac5c2ab lsp/fmt: Support ignore files & patterns (#15647) (Sysix)
- e50a9bf linter: Add unicorn/prefer-response-static-json rule (#15692)
(Mikhail Baev)
- f5d9abb oxlint: Add enabled? column to --rules cli output (#15213)
(Wren)
- 6b5205c linter/plugins: Implement deprecated
`SourceCode#getJSDocComment` method (#15653) (overlookmotel)
- 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens
methods (#15645) (overlookmotel)
- 4c62ffa language_server: Add `run_server` helper for CLI tools
(#15609) (Sysix)
- 0d52a5e linter/plugins: Implement `Context#parserOptions` getter
(#15632) (overlookmotel)
- 287a538 linter/plugins: Implement `Context#get*` deprecated methods
(#15606) (overlookmotel)
- 84de1ca oxlint,oxfmt: Allow comments and also commas for
vscode-json-ls (#15612) (leaysgur)
- e763919 linter: Add test to enforce schema documentation for rules
with configuration options (#15234) (Connor Shea)
- 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr`
option (#15507) (Li Wei)

### 🐛 Bug Fixes

- 1decd57 linter/no-empty-named-blocks: Only search within node for
comma token (#15751) (camc314)
- 17c3d6d linter: Improve docs, diagnostic message, and implementation
of typescript/consistent-indexed-object-style rule. (#15750)
(connorshea)
- 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for
token (#15735) (camc314)
- 042befd linter/require-await: Skip comments when searching for token
(#15734) (camc314)
- 7a78220 linter/no-async-await: Skip comments when searching for token
(#15733) (camc314)
- 23b9ad1 linter/consistent-type-specifier-style: Skip comments when
searching for token (#15732) (camc314)
- 440a977 ast: Include rest properties when using
`get_binding_identifiers` (#15710) (camc314)
- 516d14e linter/no-namespace: Skip comments when searching for token
(#15716) (camc314)
- b5aaace linter/prefer-namespace-keyword: Skip comments when searching
for token (#15715) (camc314)
- 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (#14203)
(Sysix)
- 9f991a4 linter: Reverse extends overrides priority (#14939) (Peter
Wagenet)
- 7c4a916 linter: Restores `oxlint --rules -f=json` functionality.
(#15689) (Wren)
- 24d00f4 linter/plugins: Add types for suggested fixes (#15636)
(overlookmotel)
- 257360f linter/plugins: Fill in TS type def for `RuleMeta` (#15629)
(overlookmotel)
- 81e179c linter: Allow file extensions without a dot in
react/jsx-filename-extension rule (#15574) (Connor Shea)
- 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with
new JavaScript APIs (#15581) (connorshea)
- bb5f8ca oxlint: Fix type annotation for big-endian (#15561) (Sysix)

### ⚡ Performance

- e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat
mode (#15693) (overlookmotel)
- 7528db4 language_server: Pass file content as a referenced `String`
(#15568) (Sysix)
- 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines`
(#15641) (overlookmotel)
- ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (#15516)
(Sysix)

### 📚 Documentation

- 3ab750a linter: Clarify react-in-jsx-scope rule docs. (#15749)
(connorshea)
- a5feebc linter: `oxlint-disable` not `eslint-disable` (#15672)
(overlookmotel)
- 3d15805 linter: Reformat doc comments (#15670) (overlookmotel)
- 16fcba6 linter: Remove "experimental" from description of stable
features (#15669) (overlookmotel)
- e62fd98 linter: Correct comment on what `EnablePlugins` does (#15668)
(overlookmotel)
- a25d31e linter: Fix grammar (#15666) (overlookmotel)
- f5f452f linter: Add missing `perf` category (#15667) (overlookmotel)
- 2c58952 linter: Add config docs for no-restricted-globals rule.
(#15662) (connorshea)
- a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema`
(#15642) (overlookmotel)
- 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in
ESLint-compat `Context` shim (#15605) (overlookmotel)
- fd58aea linter: Fix a typo in the docs for react/no-is-mounted.
(#15575) (Connor Shea)
# Oxfmt
### 🚀 Features

- 84de1ca oxlint,oxfmt: Allow comments and also commas for
vscode-json-ls (#15612) (leaysgur)
- 99823ad oxfmt: Print nothing for default(write) mode (#15583)
(leaysgur)
- 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>`
groups (#15578) (leaysgur)

### 🐛 Bug Fixes

- bf20cf5 formatter: `CRLF` issue in the member chain (#15764) (Dunqing)
- 5d688a0 formatter: Measuring multiline text in `fits_text` is
incorrect (#15762) (Dunqing)
- e306958 formatter: Regression case for test call (#15760) (Dunqing)
- c42d983 formatter: Re-fix all cases that fail after
`AstNode::Argument` was removed (#15676) (Dunqing)

### ⚡ Performance

- d99a83f oxfmt: Use simdutf8 based read_to_string (#15614) (leaysgur)
- 128e186 formatter/sort_imports: Precompute import metadata (#15580)
(leaysgur)
- cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for
`next_elements` (#15579) (leaysgur)

### 📚 Documentation

- 3d15805 linter: Reformat doc comments (#15670) (overlookmotel)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
taearls pushed a commit to taearls/oxc that referenced this pull request Dec 11, 2025
# Oxlint
### 🚀 Features

- c199e38 linter: Implement config for all tsgolint rules supporting
options (oxc-project#15659) (camchenry)
- 7598b3e linter: Allow configuring tsgolint rules (oxc-project#15286) (camchenry)
- e77f2ce vscode: Support `oxlint --lsp` (oxc-project#15680) (Sysix)
- e01c551 oxlint: Add `--lsp` flag to run the language server (oxc-project#15611)
(Sysix)
- ac5c2ab lsp/fmt: Support ignore files & patterns (oxc-project#15647) (Sysix)
- e50a9bf linter: Add unicorn/prefer-response-static-json rule (oxc-project#15692)
(Mikhail Baev)
- f5d9abb oxlint: Add enabled? column to --rules cli output (oxc-project#15213)
(Wren)
- 6b5205c linter/plugins: Implement deprecated
`SourceCode#getJSDocComment` method (oxc-project#15653) (overlookmotel)
- 5eccff1 linter/plugins: Implement deprecated `SourceCode` tokens
methods (oxc-project#15645) (overlookmotel)
- 4c62ffa language_server: Add `run_server` helper for CLI tools
(oxc-project#15609) (Sysix)
- 0d52a5e linter/plugins: Implement `Context#parserOptions` getter
(oxc-project#15632) (overlookmotel)
- 287a538 linter/plugins: Implement `Context#get*` deprecated methods
(oxc-project#15606) (overlookmotel)
- 84de1ca oxlint,oxfmt: Allow comments and also commas for
vscode-json-ls (oxc-project#15612) (leaysgur)
- e763919 linter: Add test to enforce schema documentation for rules
with configuration options (oxc-project#15234) (Connor Shea)
- 6cd0b5f linter/no-callback-in-promise: Add support for `timeoutsErr`
option (oxc-project#15507) (Li Wei)

### 🐛 Bug Fixes

- 1decd57 linter/no-empty-named-blocks: Only search within node for
comma token (oxc-project#15751) (camc314)
- 17c3d6d linter: Improve docs, diagnostic message, and implementation
of typescript/consistent-indexed-object-style rule. (oxc-project#15750)
(connorshea)
- 78a6df2 linter/no-empty-named-blocks: Skip comments when searching for
token (oxc-project#15735) (camc314)
- 042befd linter/require-await: Skip comments when searching for token
(oxc-project#15734) (camc314)
- 7a78220 linter/no-async-await: Skip comments when searching for token
(oxc-project#15733) (camc314)
- 23b9ad1 linter/consistent-type-specifier-style: Skip comments when
searching for token (oxc-project#15732) (camc314)
- 440a977 ast: Include rest properties when using
`get_binding_identifiers` (oxc-project#15710) (camc314)
- 516d14e linter/no-namespace: Skip comments when searching for token
(oxc-project#15716) (camc314)
- b5aaace linter/prefer-namespace-keyword: Skip comments when searching
for token (oxc-project#15715) (camc314)
- 4eb9fa6 editor: Execute `oxc.path.server` in win32 with shell (oxc-project#14203)
(Sysix)
- 9f991a4 linter: Reverse extends overrides priority (oxc-project#14939) (Peter
Wagenet)
- 7c4a916 linter: Restores `oxlint --rules -f=json` functionality.
(oxc-project#15689) (Wren)
- 24d00f4 linter/plugins: Add types for suggested fixes (oxc-project#15636)
(overlookmotel)
- 257360f linter/plugins: Fill in TS type def for `RuleMeta` (oxc-project#15629)
(overlookmotel)
- 81e179c linter: Allow file extensions without a dot in
react/jsx-filename-extension rule (oxc-project#15574) (Connor Shea)
- 7a0e931 linter: Update the unicorn/prefer-add-event-listener rule with
new JavaScript APIs (oxc-project#15581) (connorshea)
- bb5f8ca oxlint: Fix type annotation for big-endian (oxc-project#15561) (Sysix)

### ⚡ Performance

- e2a0997 linter/plugins: Recycle empty visitor object in ESLint compat
mode (oxc-project#15693) (overlookmotel)
- 7528db4 language_server: Pass file content as a referenced `String`
(oxc-project#15568) (Sysix)
- 54061e9 linter/plugins: Avoid implicit boolean coercion in `initLines`
(oxc-project#15641) (overlookmotel)
- ccfd935 language_server: Avoid `Mutex` in `ServerLinter` (oxc-project#15516)
(Sysix)

### 📚 Documentation

- 3ab750a linter: Clarify react-in-jsx-scope rule docs. (oxc-project#15749)
(connorshea)
- a5feebc linter: `oxlint-disable` not `eslint-disable` (oxc-project#15672)
(overlookmotel)
- 3d15805 linter: Reformat doc comments (oxc-project#15670) (overlookmotel)
- 16fcba6 linter: Remove "experimental" from description of stable
features (oxc-project#15669) (overlookmotel)
- e62fd98 linter: Correct comment on what `EnablePlugins` does (oxc-project#15668)
(overlookmotel)
- a25d31e linter: Fix grammar (oxc-project#15666) (overlookmotel)
- f5f452f linter: Add missing `perf` category (oxc-project#15667) (overlookmotel)
- 2c58952 linter: Add config docs for no-restricted-globals rule.
(oxc-project#15662) (connorshea)
- a210b12 linter/plugins: Improve JSDoc comment for `RuleOptionsSchema`
(oxc-project#15642) (overlookmotel)
- 3aabfac linter/plugins: Alter comments on `FILE_CONTEXT` used in
ESLint-compat `Context` shim (oxc-project#15605) (overlookmotel)
- fd58aea linter: Fix a typo in the docs for react/no-is-mounted.
(oxc-project#15575) (Connor Shea)
# Oxfmt
### 🚀 Features

- 84de1ca oxlint,oxfmt: Allow comments and also commas for
vscode-json-ls (oxc-project#15612) (leaysgur)
- 99823ad oxfmt: Print nothing for default(write) mode (oxc-project#15583)
(leaysgur)
- 25a0163 formatter/sort_imports: Sort imports by `Array<Array<string>>`
groups (oxc-project#15578) (leaysgur)

### 🐛 Bug Fixes

- bf20cf5 formatter: `CRLF` issue in the member chain (oxc-project#15764) (Dunqing)
- 5d688a0 formatter: Measuring multiline text in `fits_text` is
incorrect (oxc-project#15762) (Dunqing)
- e306958 formatter: Regression case for test call (oxc-project#15760) (Dunqing)
- c42d983 formatter: Re-fix all cases that fail after
`AstNode::Argument` was removed (oxc-project#15676) (Dunqing)

### ⚡ Performance

- d99a83f oxfmt: Use simdutf8 based read_to_string (oxc-project#15614) (leaysgur)
- 128e186 formatter/sort_imports: Precompute import metadata (oxc-project#15580)
(leaysgur)
- cd31cc1 formatter/sort_imports: Use `Vec::with_capacity` for
`next_elements` (oxc-project#15579) (leaysgur)

### 📚 Documentation

- 3d15805 linter: Reformat doc comments (oxc-project#15670) (overlookmotel)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants