table of contents
- bullseye 7.5.2+ds-2
- bullseye-backports 8.5.5~ds1-1~bpo11+1
- testing 9.1.3~ds1-1
- unstable 9.2.0~ds1-1
|NPM-DIFF(1)||General Commands Manual||NPM-DIFF(1)|
<!-- AUTOGENERATED USAGE DESCRIPTIONS -->
Similar to its git diff counterpart, this command will
print diff patches
of files for packages published to the npm registry.
- npm diff --diff=<spec-a> --diff=<spec-b>
Compares two package versions using their registry specifiers,
npm diff --firstname.lastname@example.org --diff=pkg@^2.0.0. It's also possible to
compare across forks of any package,
e.g: npm diff --email@example.com --firstname.lastname@example.org.
Any valid spec can be used, so that it's also possible to compare
directories or git repositories,
e.g: npm diff --diff=pkg@latest --diff=./packages/pkg
Here's an example comparing two different versions of a package
abbrev from the registry:
npm diff --email@example.com --firstname.lastname@example.org
On success, output looks like:
diff --git a/package.json b/package.json index v1.1.0..v1.1.1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@
"name": "abbrev", - "version": "1.1.0", + "version": "1.1.1",
"description": "Like ruby's abbrev module, but in js",
"author": "Isaac Z. Schlueter <email@example.com>",
Given the flexible nature of npm specs, you can also target local
directories or git repos just like when using npm install:
npm diff --diff=https://github.com/npm/libnpmdiff --diff=./local-path
In the example above we can compare the contents from the package
from the git repo at github.com/npm/libnpmdiff with the contents of the
./local-path that contains a valid package, such as a modified copy of
- npm diff (in a package directory, no arguments):
If the package is published to the registry, npm diff will
tarball version tagged as latest (this value can be configured using the
tag option) and proceed to compare the contents of files present in that
tarball, with the current files in your local file system.
This workflow provides a handy way for package authors to see what
package-tracked files have been changed in comparison with the latest
published version of that package.
- npm diff --diff=<pkg-name> (in a package directory):
When using a single package name (with no version or tag
specifier) as an
argument, npm diff will work in a similar way to
reach for the registry to figure out
what current published version of the package named <pkg-name>
will satisfy its dependent declared semver-range. Once that specific
version is known npm diff will print diff patches comparing the
current version of <pkg-name> found in the local file system with
that specific version returned by the registry.
Given a package named abbrev that is currently installed:
npm diff --diff=abbrev
That will request from the registry its most up to date version
will print a diff output comparing the currently installed version to this
newer one if the version numbers are not the same.
- npm diff --diff=<spec-a> (in a package directory):
Similar to using only a single package name, it's also possible to
a full registry specifier version if you wish to compare the local version
of an installed package with the specific version/tag/semver-range provided
An example: assuming firstname.lastname@example.org is installed in the current
npm diff --email@example.com
It will effectively be an alias to
npm diff --firstname.lastname@example.org --email@example.com.
- npm diff --diff=<semver-a> [--diff=<semver-b>] (in a package directory):
Using npm diff along with semver-valid version numbers is a
to compare different versions of the current package.
It needs to be run from a package directory, such that for a
pkg running npm diff --diff=1.0.0 --diff=1.0.1 is the same as running
npm diff --firstname.lastname@example.org --email@example.com.
If only a single argument <version-a> is provided,
then the current local
file system is going to be compared against that version.
Here's an example comparing two specific versions (published to
configured registry) of the current project directory:
npm diff --diff=1.0.0 --diff=1.1.0
Note that tag names are not valid --diff argument values,
if you wish to
compare to a published tag, you must use the pkg@tagname syntax.
It's possible to also specify positional arguments using file
names or globs
pattern matching in order to limit the result of diff patches to only a subset
of files for a given package, e.g:
npm diff --diff=pkg@2 ./lib/ CHANGELOG.md
In the example above the diff output is only going to print
contents of files
located within the folder ./lib/ and changed lines of code within the
<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->
- npm outdated
- npm install
- npm config
- npm registry