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.

Sign up for GitHub

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

Jump to bottom

RFC: obey user specific dist-tag #607

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

RFC: obey user specific dist-tag #607

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
130dddd
RFC: obey user specific dist-tag
Jun 29, 2022
2338878
fix: use --save-tag instead of --force
Jun 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
51 changes: 51 additions & 0 deletions accepted/0000-obey-user-specific-dist-tag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Obey user specific dist-tag

## Summary

When running `npm install pkg@latest-1`, npm should provide a way to save `latest-1` into `package.json`.

## Motivation

Since @ljharb has already proposed an RRFC of [obey user specifier](https://github.com/npm/rfcs/pull/547), which will be implemented at the next major version(v9) of npm.

In my case, when installing a new dependency using `npm install antd@conch`, I want `antd` to keep the exact `conch` dist-tag in my package.json, because this is exactly the version I need in my project. By saying version, I mean the version `conch` **always** points to, not the moment I run the install command.

Since dist-tag means more than a semantic versioning when a maintainer maintains multiple major versions of a project, like `conch`, `next` etc.

And in the [obey user specifier](https://github.com/npm/rfcs/pull/547) RRFC, @wesleytodd suggested a new flag to support this behavior, which is more reasonable.

## Detailed Explanation

Assuming the dist-tag `conch` of `antd` currently binding to the exact version `4.20.7`.

Currently npm supports those two ways of saving dependency into `package.json`:
1. [x] Running `npm install antd@conch` should save the semantic versioning into package.json, hence `^4.20.7` shall be saved;
2. [x] Running `npm install antd@conch --save-exact` should save the exact version into package.json, hence `4.20.7` shall be saved.

We want a new flag to save dependency below:
1. [ ] Running `npm install antd@conch --save-tag` should save the dist-tag into package.json, hence `conch` shall be saved;


## Rationale and Alternatives


## Implementation

Add a new flag `--save-tag` to save user specific dist-tag when installing a dependency.

## Prior Art

## Unresolved Questions and Bikeshedding

I think the flag `--save-exact` would be more comprehensive to support this RFC, but it would change to behavior of `--save-exact` in npm@8.

If `--save-exact` used in this case, bumping up a major version of npm is needed.


### References
<!-- Examples
* Related to issue [#5052](https://github.com/npm/cli/issues/5052)
* Related to RRFC #547
-->
* Related to issue [#5052](https://github.com/npm/cli/issues/5052)
* Related to RRFC #547