Skip to content

[DOCS] The --prefix flag is not documented #8197

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

Open
2 tasks done
lolmaus opened this issue Mar 31, 2025 · 5 comments
Open
2 tasks done

[DOCS] The --prefix flag is not documented #8197

lolmaus opened this issue Mar 31, 2025 · 5 comments
Labels
Documentation documentation related issue Needs Triage needs review for next steps

Comments

@lolmaus
Copy link

lolmaus commented Mar 31, 2025

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

I was told to replace this in package.json:

"test:e2e": "cd ./e2e/ & npm run test"

with this:

"test:e2e": "npm --prefix e2e run test"

I failed to find any docs for the --prefix flag. There is only info on the npm prefix command that prints a global prefix, but it's quite vague on what this prefix is and what it's used for.

I've asked Grok 3 in DeepSearch mode, and it claims that the two commands above are not equivalent. But its explanation of the --prefix flag is quite confusing (likely because it has to guess rather than provide factual info based on docs, since --prefix is not documented).

Potential Solution

No response

Docs URL

I don't know if this flag applies to a specific command, all commands or a subset of commands.

@lolmaus lolmaus added Documentation documentation related issue Needs Triage needs review for next steps labels Mar 31, 2025
@ljharb
Copy link
Contributor

ljharb commented Mar 31, 2025

It shouldn't be used; the cd example is far better imo.

@lolmaus
Copy link
Author

lolmaus commented Mar 31, 2025

It shouldn't be used; the cd example is far better imo.

In this case, it should be documented as deprecated or something. 🙏

@stefanseeger
Copy link

stefanseeger commented Apr 10, 2025

I was about to raise a new issue that npm i --prefix folder does not work while npm ci --prefix folder does.
The docs definitely should be updated, please

@shadowspawn
Copy link
Contributor

prefix is listed on the config page, along with many other settings.

https://docs.npmjs.com/cli/v11/using-npm/config#prefix

@lolmaus
Copy link
Author

lolmaus commented Apr 15, 2025

prefix is listed on the config page, along with many other settings.

https://docs.npmjs.com/cli/v11/using-npm/config#prefix

@shadowspawn Interesting, so every configuration option has a matching command line flag applicable to any command?

I can see it documented like this:

Putting --foo bar on the command line sets the foo configuration parameter to "bar". A -- argument tells the cli parser to stop reading flags. Using --flag without specifying any value will set the value to true.

This is quite obscure. I'm sure I'm not the only developer who has tripped not finding --prefix flag explicitly documented. Instead, the flag's existence must be inferred from this rule which references non-existent flags --foo and --flag.

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

No branches or pull requests

4 participants