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

[DOCS] Every page of npm help <x> should display the local npm version #7110

Closed
2 tasks done
DanKaplanSES opened this issue Dec 31, 2023 · 1 comment · Fixed by #7479
Closed
2 tasks done

[DOCS] Every page of npm help <x> should display the local npm version #7110

DanKaplanSES opened this issue Dec 31, 2023 · 1 comment · Fixed by #7479
Labels
Documentation documentation related issue Needs Triage needs review for next steps

Comments

@DanKaplanSES
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

This is a CLI Docs Enhancement, not another kind of Docs Enhancement.

  • This is a CLI Docs Enhancement.

Description of Problem

For context, I'm trying to figure out how to pass an argument to node.exe in a npx command. While researching, the CLI told me to type npm help exec to see more information. This open and a local file in my browser: file:///C:/Program%20Files/nodejs/node_modules/npm/docs/output/commands/npx.html

This file doesn't say which version of npm I'm using anywhere that I can find. As a result, I have no frame of reference compared to the docs I find while googling. I can't tell if I'm reading the latest npm cli docs or if I'm a version behind/ahead of the latest official documentation. It's unlikely I'll notice differences between the online and local articles, but those differences could be critical: they could indicate my current experience would be fixed by upgrading my npm version. It makes it easier to see when a new version of npm exists, and that would probably reduce issues created in this repository, among other benefits.

Potential Solution

Every page of local documentation should say the local version of NPM.

Workaround: this can be cross checked by typing npm -v on the local CLI.

Docs URL

https://docs.npmjs.com/cli/v10/commands/npx

@DanKaplanSES DanKaplanSES added Documentation documentation related issue Needs Triage needs review for next steps labels Dec 31, 2023
@klm-turing
Copy link
Contributor

Hi @DanKaplanSES I give a try to this one

wraithgar pushed a commit that referenced this issue May 7, 2024
Every page of npm help <x> display the local npm version.

This pull request helps the local reader of the documentation to know
which version of the documentation they are reading.

## References
Closes: #7110
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation documentation related issue Needs Triage needs review for next steps
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants