sindresorhus/eslint-plugin-unicorn

Configurable callee blacklist for `no-fn-reference-in-iterator`

Closed

#787 opened on Jun 29, 2020

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

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

Description

I noticed that the rule currently has a hard-coded blacklist of callees to ignore.

I ran into a bit of an issue with this as we're currently moving our code base off of bluebird (callee: Promise) to async / await + blend-promise-utils (callee: P). That switch from Promise.map to P.map started throwing false-positives all over our codebase.

What are people's thoughts on making this a configurable option? I'd be willing to take a stab at a PR for it if so.

Contributor guide

Research direction
Examine the rule file `rules/no fn reference in iterator.js`, specifically the hard coded blacklist array. Implement a configuration option (e.g., `allowedCallees`) to allow users to override or extend the blacklist. Update the corresponding test file and documentation. The maintainer has not provided specific API requirements, so propose a design in the issue before implementation.
Tech stack
javascript
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptESLint plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60