npm / npm/documentation

[FEATURE] Top-level `requires` property in package-lock.json not describe on website

Open
#57 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
MDX
Stars
711
Forks
4.2k
Avg merge
4d 16h
Merged PRs (30d)
3

Description

What / Why

The package-lock.json file contains a property called requires:

{
  "name": "foo",
  "version": "0.0.0",
  "lockfileVersion": 3,
  "requires": true, // <--- this one
  "packages": {

It existed in all versions of lockfileVersion (1, 2 and 3). Notice that I am now using version 3.

I do not know what its purpose is. Nor if it is a bug or not to exist in lockfileVersion: 3. But even so, it is not documented at https://docs.npmjs.com/cli/v8/configuring-npm/package-lock-json.

As a top-level property, it would be nice to describe it at https://docs.npmjs.com/cli/v8/configuring-npm/package-lock-json (for all versions that you can select in the dropdown).

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 at the package-lock.json documentation page linked in the issue and compare its descriptions for lockfile versions 1, 2, and 3. Determine the purpose of the top-level requires property, then document it consistently for each selectable version; the work is done when the property is explained on that page.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.