mysticatea/eslint-plugin-node

Rule to ensure `process.env.NODE_ENV` is only equality-tested against valid values

Open

#101 opened on Dec 8, 2017

View on GitHub
 (1 comment) (3 reactions) (0 assignees)JavaScript (189 forks)github user discovery
acceptedenhancementhelp wanted

Repository metrics

Stars
 (955 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I want to make sure that no one accidentally uses a condition in their code like process.env.NODE_ENV !== 'productn'.

The rule would error if process.env.NODE_ENV is equality-tested, or inequality-tested, against a value that is not a literal string of one of the allowed values. Allowed values could default to the conventional 'development' and 'production', and could be configured by the user.

Thoughts? Should I go ahead with a PR?

Contributor guide

Research direction
Examine existing rules in eslint plugin node to understand the pattern for creating a new rule. Then implement a rule that checks binary expressions comparing process.env.NODE ENV against string literals, and ensure only allowed values are used.
Tech stack
javascriptnodejs
Domain
toolingbackend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptNode.jsESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65