The Symbols In Your package.json File

Image for post
Image for post

I have often been confused by the symbols in the package.json file. If you are new to node.js, and you create a new app with create-react-app or some other framework, it generates a package.json file for you. I have always felt that most of the file is very clear, even if you are a newbie. "Name," "version," "dependencies," and "scripts," are all very clear descriptors. However, there are often symbols thrown around in the package dependencies, and it is not always clear what they mean.

Symbols relating to package version

Most of these will relate to the version of a given dependency package. Note that a version number is split into three values. These are called ‘major,’ ‘minor,’ and ‘patch.’ For example, if a package is at version 3.4.5, the major is 3, the minor is 4, and the patch is 5. The last number will change most frequently (for every tiny change), while the first number should only be changed if there is a serious code overhaul.

If there is no operator in front of the version number, this is assumed. However, you can still include = if you like. =3.2.1 and 3.2.1 will both expect exactly version 3.2.1.

You may see <=, >, etc, but these are rarely used. These follow basic logic. >=3.2.1 would match 3.2.3, 3.4.7, and also 4.2.7. These are problematic, because they are too broad. Generally, you want to limit yourself to certain versions, to maintain operability. This takes us to the more common options:

You can use - between two versions, that you specify. This is useful if you need to maintain some legacy feature that you know will break at a specific version. For example, 1.3.2 - 2.4.1. This will include both endpoints.

Any of X, x, or * may be used to "stand in" for one of the numeric values. I will take the example straight from the semver documentation:

  • * := >=0.0.0 (Any version satisfies)
  • 1.x := >=1.0.0 <2.0.0 (Matching major version)
  • 1.2.x := >=1.2.0 <1.3.0 (Matching major and minor versions)

The ~ means "approximate version." This allows for more recent patches, but does not accept any packages with a different minor version. For example, ~2.3.3 will allow values between 2.3.3 and 2.4, not including 2.4. Note that this will allow differences in the minor version is none is specified. ~2 will accept any version that starts with 2.

The ^ means "compatible with version," and is more broad than the tilde. It only refuses changes to the major version. For example, ^3.4.1 will allow any version between that value and 4.0.0, not including version 4. Note that this behaves very differently for version numbers that start with zero, so be careful.

There is also a handy versioning calculator tool.

Relating to package scope — the “at” sign

Some npm packages have a scope. Scopes are preceded by the “at” sign, for example @testing-library/react. The scope is "testing-library", the package name is "react." Only the organization that owns a scope can add packages to it, so you can be sure that you are using official code. A scoped package cannot be fetched just by using its name. In this example, this differentiates it from the official facebook react framework, while still having a clear name. In my package.json, I have:

"@testing-library/react": "^9.3.2","react": "^16.13.1",

When you import them in a file, you will still import them with their full name, eg import { render } from '@testing-library/react'. Interestingly enough, they are also put in a subfolder in node_modules/ depending on the scope.

Originally published at https://elliott-king.github.io on August 25, 2020.
Photo by
Lalith T on Unsplash

Written by

NYC, fullstack

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store