sindresorhus/eslint-plugin-unicorn

Rule proposal: Prefer `stream.pipeline` over `stream.Readable#pipe` in Node.js

Open

#818 opened on Sep 1, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission
help wantednew rule

Description

This will need type information: https://github.com/typescript-eslint/typescript-eslint/issues/542

Contributor guide

Tech stack
javascriptnodejs
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.
half day
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.
needs investigation
Prerequisites
Node.js streamsESLint custom rulesTypeScript (optional)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The proposal requires implementing a new ESLint rule. First, understand how to obtain type information via the typescript eslint project (see issue #542). Then, design the rule logic to detect usage of stream.Readable#pipe and suggest using stream.pipeline. Look at existing rules in the eslint plugin unicorn rules directory for style guidance. No linked PRs or assignees.