mysticatea/eslint-plugin-node

In `node/shebang` add options to disable check on non `bin` files

Open

#96 opened on Nov 25, 2017

View on GitHub
 (5 comments) (2 reactions) (0 assignees)JavaScript (186 forks)github user discovery
acceptedenhancementhelp wanted

Repository metrics

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

Description

It's quite common in projects to have node script files that are not distributed and therefore not present in the bin property of the package.json. For example: build scripts, benchmark scripts. test scripts etc...

Would it be possible to add an option to the shebang to disable the check on the files not referenced in the bin property? Or maybe, even better, instead of option, just change the rules to consider only files included in the npm package (files in the files property and not in .npmignore)?

Contributor guide

Research direction
Examine the shebang rule implementation, and add an option to skip files not in the 'bin' property of package.json.
Tech stack
javascriptnodejs
Domain
backendtooling
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60