ni / ni/javascript-styleguide

Published packages do not declare the supported Node.js engine

Open Beginner friendly
#171 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

triage
Dominant language
JavaScript
Stars
9
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Describe the issue
None of the published packages declare the version of Node.js they support with the engines field in package.json. If this is dictated by dependencies like ESLint, it should be declared and would aid when clients upgrade these dependencies or Node.js. Once ESLint 9 is supported, I think this will be easy to resolve.

Not specifying the engines field is technically equivalent to * and means any version. This is not reliable, though. More likely, a package of interest does not support support any version and simply did not declare which versions it does. If a package declares support for specific versions of engines, they can be viewed with the following command.
npm view <package name>[@package version] engines

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the four package.json files named in the issue and compare their dependency requirements with the relevant ESLint package metadata. Use npm view [@package version] engines where useful; done means each published package declares the supported Node.js version range in its engines field.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, typescript
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.