Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] missing docs around package-lock.json inside the /node_modules/ dir #2521

Closed
Pomax opened this issue Jan 21, 2021 · 4 comments
Closed
Labels
Bug thing that needs fixing pr: needs documentation pull request requires docs before merging Priority 2 secondary priority issue Release 7.x work is associated with a specific npm 7 release

Comments

@Pomax
Copy link

Pomax commented Jan 21, 2021

Current Behavior:

I can't for the life of me find something that lets me let you know about docs problems, as the official list of options has nothing relating to docs issues (only a way to open the docs site), so I'm filing this as an npm bug instead: running npm install generates a package-lock.json file not just in the project dir, but also in the ./node_modules/ dir.

The docs don't mention (1) that it'll do this, (2) what the purpose of this file is, and (3) why and how it's different (because it's about half the size as the regular package-lock.json file).

Expected Behavior:

No package-lock.json gets written to ./node_modules/

Steps To Reproduce:

Run npm install

@Pomax Pomax added Bug thing that needs fixing Needs Triage needs review for next steps Release 7.x work is associated with a specific npm 7 release labels Jan 21, 2021
@darcyclarke darcyclarke added pr: needs documentation pull request requires docs before merging Priority 2 secondary priority issue and removed Needs Triage needs review for next steps labels Feb 2, 2021
@valtlai
Copy link

valtlai commented Feb 11, 2021

@Pomax
Copy link
Author

Pomax commented Feb 13, 2021

Handy: but where is that found on the actual site? It's not under https://docs.npmjs.com/cli/v7/configuring-npm/package-json nor is it under https://docs.npmjs.com/cli/v7/using-npm/config, so even though it looks like that information exists, it's basically not discoverable.

@valtlai
Copy link

valtlai commented Feb 25, 2021

It seems it has now been published on the actual site: https://docs.npmjs.com/cli/v7/configuring-npm/package-lock-json#hidden-lockfiles

@Pomax
Copy link
Author

Pomax commented Feb 25, 2021

fantastic, then that closes this issue =)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug thing that needs fixing pr: needs documentation pull request requires docs before merging Priority 2 secondary priority issue Release 7.x work is associated with a specific npm 7 release
Projects
None yet
Development

No branches or pull requests

3 participants