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

docs(update): Fix a typo and remove unneeded statement #7152

Merged
merged 2 commits into from
Jan 19, 2024
Merged

docs(update): Fix a typo and remove unneeded statement #7152

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
072e4ba
Explicitly state how caret dependencies below 1.0.0 behave
DanKaplanSES Jan 18, 2024
70f2b90
Revert line
DanKaplanSES Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/lib/content/commands/npm-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,22 +76,21 @@ However, if `app`'s `package.json` contains:
```

In this case, running `npm update` will install `dep1@1.1.2`. Even though the
`latest` tag points to `1.2.2`, this version do not satisfy `~1.1.1`, which is
`latest` tag points to `1.2.2`, this version does not satisfy `~1.1.1`, which is
equivalent to `>=1.1.1 <1.2.0`. So the highest-sorting version that satisfies
`~1.1.1` is used, which is `1.1.2`.

#### Caret Dependencies below 1.0.0

Suppose `app` has a caret dependency on a version below `1.0.0`, for example:
Caret dependencies below 1.0.0 consider minor versions to be breaking changes. Suppose `app` has a caret dependency on a version below `1.0.0`, for example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't accurate. In vX.Y.Z, X is major, Y minor, Z patch - but it's the same in v0.X.Y and v0.0.X.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what you mean by "it's the same in..." but I've since learned how what I said was wrong. This is my current understanding: https://stackoverflow.com/a/77837308/61624 If that's correct, I can try to reword this PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that SO post is identical to my previous comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've decided to just revert this line for now.

What you think about integrating that StackOverflow post into the example section of the documentation?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how valuable it would be; new packages start at 1.0.0 by default, and https://semver.npmjs.com exists, so in practice most people don't run into the v0 distinction.

Copy link
Contributor Author

@DanKaplanSES DanKaplanSES Jan 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I meant integrating the StackOverflow post into the npmjs example section down to the subdependencies section, not just the details about ^ below 1.0.0.

https://semver.npmjs.com/ exists, so in practice most people don't run into the v0 distinction.

Sorry again, I'm not seeing the connection.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting at v1 is why most people don’t run into the v0 semantics.

I’m not sure which part you’re referring to in the SO post.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As described by this comment, I'm going to resolve this and continue the conversation elsewhere.

DanKaplanSES marked this conversation as resolved.
Show resolved Hide resolved

```json
"dependencies": {
"dep1": "^0.2.0"
}
```

`npm update` will install `dep1@0.2.0`, because there are no other
versions which satisfy `^0.2.0`.
`npm update` will install `dep1@0.2.0`.

If the dependence were on `^0.4.0`:

Expand Down
Loading