sindresorhus/eslint-plugin-unicorn

Rule proposal: Prefer object form of `addEventListener`

Closed

#2,067 opened on Apr 10, 2023

View on GitHubContributor guide
 (6 comments) (7 reactions) (0 assignees)JavaScript (468 forks)user submission
help wantednew rule

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

Description

addEventListener has a legacy signature where it takes useCapture boolean third argument. The options form should be preferred as it is more flexible.

Fail

el.addEventListener('click', () => {}, true)

Pass

el.addEventListener('click', () => {}, {capture: true})

Contributor guide

Research direction
Study existing rules in eslint plugin unicorn, especially those that analyze call expressions or function arguments, to understand the pattern for creating a new rule. The issue provides clear fail/pass examples, so the main task is to write a rule that detects the legacy useCapture boolean and suggests the options object form. Consider using ESLint's `context.report` with a fixer to automatically replace `true` with `{capture: true}`. Check the repository's documentation for contributing a new rule.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLint plugin development basicsAST manipulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65