npm-up

A lightweight tool to check the latest version of dependent npm packages for a project and do whatever you want.

Installation

npm i npm-up -g

Usage

1. Run npm-up [options] in a project directory with a package.json file. For example: npm-up -iw.
   If no options are configured, it will only check the latest version and do nothing but display.

2. Run npm-up -g to check globally install npm packages.

3. Run npm-up -A to check all projects in sub directories.

commands:

clean   clean cache
dump    dump cache

Options:

-h, --help                          output usage information
-V, --version                       output the version number
-g, --global                        Check global packages.
-A, --All                           Check all projects in sub directories, depth is 1.
-w, --writeBack                     Write updated version info back to package.json.
-i, --install                       Install the latest version of the packages need to be updated.
-l, --lock                          Lock the version of the package in package.json, with no version prefix.
--lock-all                          Lock, even with * version.
-a, --all                           Shortcut for -wil.
-m, --mirror <mirror host or name>  Use a mirror registry server.
--no-cache                          Disable version cache.
--no-warning                        Disable warning.
-b, --backup [fileName]             Back up package.json before writing back, default name is package.bak.json.
-d, --dep                           Check dependencies only.
-D, --dev                           Check devDependencies only.
-s, --silent                        Do not print any infomation.
-c, --cwd <cwd>                     Current working directory.
-L, --logLevel <level>              Set loglevel for npm, default is error
-e, --exclude <list>                Excluded packages list, split by comma or space.
-o, --only <list>                   Included packages list, split by comma or space.

Use mirror registry

First of all, You are supposed to use something like

npm config set registry http://registry.npm.taobao.org

to set a npm registry globally if necessary.

However, if you don't want to do this, you can do this only in npm-up.

You can use a mirror registry host to speed up the version searching and package downloading, especially for Chinese users.

• You can use a built-in host with name:
  • support: taobao, cnpmjs, npm(official), skimdb

npm-up -m taobao

• or give a specific hostname (only allow http now)

npm-up -m registry.npm.taobao.org

For Chinese users, use -m taobao to fly up!

Version Pattern

Fully support semantic version. Eg:

*
^1.5.4
~2.3
0.9.7
0.5.0-alpha1
'' //regard as *

Notice that ranges version may be overridden by Caret Ranges(^) when written back, and will be updated only when the latest version is greater than all the versions possible in the range.

>= 1.0.0 <= 1.5.4   // Version Range
1.2 - 2.3.4         // Hyphen Ranges
1.x                 // X-Ranges

• However, the semantic meaning of the prefix and suffix may somehow ignored, because I just want the latest version.
• If the version declared in the package.json is not recognizable, the corresponding package will be excluded.
• More info: https://docs.npmjs.com/misc/semver

Rules

0. Take 3 versions into consideration for one package:

   • Version declared in package.json.
   • Version of the package installed.
   • The latest version of the package.

1. If a package is not installed, only package.json will be updated, and the package itself won't be installed.

2. If the version is * in package.json, it will not be overwritten, even when the flag lock is set. If you really want to change a * version, use --lock-all flag.

3. The prefix ^ ~ of the version will be preserved when written back, unless flag lock is set.

4. If an installed package's version is not the same as the version declared in package.json, there comes a warning.

5. Installed version is preferred.

Roadmap

1. Use a config file to provide some persist options, like npmrc, we can have a real npmuprc.

License

MIT