mozilla/testpilot

Refine .eslintrc rules for node vs browser JS

Open

#3,228 opened on Jan 10, 2018

View on GitHub
 (6 comments) (0 reactions) (0 assignees)FreeMarker (108 forks)auto 404
dev papercutgood first issueskill:js

Repository metrics

Stars
 (250 stars)
PR merge metrics
 (PR metrics pending)

Description

As @pdehaan mentions:

What about just specifying the ESLint environment in the gulpfile.babel.js and webpack.config.js, a la /* eslint-env node, browser, whatever */. Or if we want to set the node env for a directory, we could just use a nested .eslintrc file (for tests or gulp tasks or whatnot).

We've got a pretty broad set of globals and envs covering all of our JS for linting, right now. But, some JS is for the build chain in node and some are for running in the browser. Might be nice to use per-directory & file glob eslint overrides to further focus what's allowed for various source files.

Contributor guide

Research direction
Review the current .eslintrc file and identify files that run in Node vs browser. Create per directory .eslintrc files or add inline `/* eslint env node */` comments to narrow the global and environment settings. Test by running ESLint across the project with the new configuration.
Tech stack
javascript
Domain
toolingbuild system
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75