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] alias dependency in package.json #6839

Closed
2 tasks done
allevo opened this issue Sep 27, 2023 · 0 comments · Fixed by #7743
Closed
2 tasks done

[DOCS] alias dependency in package.json #6839

allevo opened this issue Sep 27, 2023 · 0 comments · Fixed by #7743
Labels
Documentation documentation related issue Priority 2 secondary priority issue

Comments

@allevo
Copy link

allevo commented Sep 27, 2023

Is there an existing issue for this?

  • I have searched the existing issues

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

  • This is a CLI Docs Problem.

Description of Problem

Accordingly with https://github.com/npm/rfcs/blob/main/implemented/0001-package-aliases.md and #3, I can use alias package in the dependencies section.
So, I can run pnpm install orama1.2.8@npm:@orama/orama@1.2.8. This adds a new entry in my package.json like:

{
  "dependencies": {
    "orama1.2.8": "npm:@orama/orama@1.2.8"
  }
}

The format npm:*** is not listed in the documentation here, and this creates some confusion.

Potential Solution

Put in the list the "npm:**" format.

Affected URL

https://docs.npmjs.com/cli/v10/configuring-npm/package-json#dependencies

@allevo allevo added Documentation documentation related issue Needs Triage needs review for next steps labels Sep 27, 2023
@wraithgar wraithgar added Priority 2 secondary priority issue and removed Needs Triage needs review for next steps labels Nov 7, 2023
wraithgar pushed a commit that referenced this issue Aug 21, 2024
Updating Docs for 
`npmrc` 
- Updated example config, instead of `prefix` which can not be changed
for project, instead added `cache` which can be used for all three
config types project, user and global
 
 `package-json` 
- added alias example in package-json docs, which can be used to define
alias for a package

closes: #6839
closes: #7188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation documentation related issue Priority 2 secondary priority issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants