Skip to content

feat: Clarify semantic versioning usage example in package.json #2068

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

Open
tazokuetep24 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Clarify semantic versioning usage example in package.json #2068

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion ...and-modules/contributing-packages-to-the-registry/about-semantic-versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,15 @@ To help developers who rely on your code, we recommend starting your package ver

You can specify which update types your package can accept from dependencies in your package's `package.json` file.

For example, to specify acceptable version ranges up to 1.0.4, use the following syntax:
For example, to specify which dependency updates npm may accept, use semantic version ranges.

Assuming the minimum desired version is **1.0.4**:

- **Patch releases:** `~1.0.4` Accept versions `>=1.0.4` and `<1.1.0`.
- **Minor releases:** `^1.0.4` Accept versions `>=1.0.4` and `<2.0.0`.
- **Major, minor, and patch updates:** `>=1.0.4` Accept version `1.0.4` and all newer versions.

Alternatively, wildcard ranges or omitting the respective entry can be used when a specific minimum version is not required:

- Patch releases: `1.0` or `1.0.x` or `~1.0.4`
- Minor releases: `1` or `1.x` or `^1.0.4`
Expand Down