sindresorhus/eslint-plugin-unicorn

Rule proposal: `prefer-iterator-to-array`

Closed

#2,567 opened on Feb 20, 2025

View on GitHubContributor guide
 (2 comments) (3 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

Iterator#toArray() is more clear to me that coverts iterator to array than [...iterator], especially when iterator is a long expression.

Examples

// ❌
[...map.values()].map(value => value * 2)

// ✅
map.values().toArray().map(value => value * 2)
map.values().map(value => value * 2).toArray()

Proposed rule name

prefer-iterator-to-array

Additional Info

Full list of Iterators https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Iterator#description

Contributor guide

Research direction
Review the implementation of similar rules like 'prefer array flat map' in the eslint plugin unicorn repository for code patterns. The rule needs to detect spread operator usage on iterables (e.g., [...map.values()]) and suggest using .toArray() instead. Use AST selectors like 'SpreadElement' or 'CallExpression' to identify the pattern. The issue provides clear examples of what should be flagged and what should be preferred.
Tech stack
javascripttypescript
Domain
tooling
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.
Half day
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 developmentAST basicsJavaScript iterators
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70