update-notifier alternatives and similar modules
Based on the "Command Line Utilities" category.
Alternatively, view update-notifier alternatives based on common mentions on social networks and blogs.
-
nvm
Node Version Manager - POSIX-compliant bash script to manage multiple active node.js versions -
Inquirer.js
A collection of common interactive command line user interfaces. -
KeyboardJS
A JavaScript library for binding keyboard combos without the pain of key codes and key combo conflicts. -
omelette
Omelette is a simple, template based autocompletion tool for Node and Deno projects with super easy API. (For Bash, Zsh and Fish) -
log-update
Log by overwriting the previous output in the terminal. Useful for rendering progress bars, animations, etc. -
configstore
Easily load and persist config without having to think about where and how -
insight
Node.js module to help you understand how your tool is being used by anonymously reporting usage metrics to Google Analytics -
Javascript library for 2d geometry
Javascript library for 2d geometry -
ansi-escapes
ANSI escape codes for manipulating the terminal -
string-width
Get the visual width of a string - the number of columns required to display it -
columnify
Create text-based columns suitable for console output. Supports cell wrapping. -
loud-rejection
Make unhandled promise rejections fail loudly instead of the default silent fail -
multispinner
Multiple, simultaneous, individually controllable spinners for concurrent tasks in Node.js CLI programs -
sudo-block
Block users from running your app with root permissions -
googleauth
Create and load persistent Google authentication tokens for command-line apps -
licenseye
Node.js CLI tool to visualize an aggregate list of your dependencies' licenses -
cli-columns
Columnated lists for the CLI. Unicode and ANSI safe. -
cron-to-quartz
Node.js library to convert unix or linux CRON syntax to Quartz Scheduler
SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of update-notifier or a related project?
README
update-notifier
Update notifications for your CLI app
[](screenshot.png)
Inform users of your package of updates in a non-intrusive way.
Contents
Install
$ npm install update-notifier
Usage
Simple
const updateNotifier = require('update-notifier');
const pkg = require('./package.json');
updateNotifier({pkg}).notify();
Comprehensive
const updateNotifier = require('update-notifier');
const pkg = require('./package.json');
// Checks for available update and returns an instance
const notifier = updateNotifier({pkg});
// Notify using the built-in convenience method
notifier.notify();
// `notifier.update` contains some useful info about the update
console.log(notifier.update);
/*
{
latest: '1.0.1',
current: '1.0.0',
type: 'patch', // Possible values: latest, major, minor, patch, prerelease, build
name: 'pageres'
}
*/
Options and custom message
const notifier = updateNotifier({
pkg,
updateCheckInterval: 1000 * 60 * 60 * 24 * 7 // 1 week
});
if (notifier.update) {
console.log(`Update available: ${notifier.update.latest}`);
}
How
Whenever you initiate the update notifier and it's not within the interval threshold, it will asynchronously check with npm in the background for available updates, then persist the result. The next time the notifier is initiated, the result will be loaded into the .update
property. This prevents any impact on your package startup performance.
The update check is done in a unref'ed child process. This means that if you call process.exit
, the check will still be performed in its own process.
The first time the user runs your app, it will check for an update, and even if an update is available, it will wait the specified updateCheckInterval
before notifying the user. This is done to not be annoying to the user, but might surprise you as an implementer if you're testing whether it works. Check out [example.js
](example.js) to quickly test out update-notifier
and see how you can test that it works in your app.
API
notifier = updateNotifier(options)
Checks if there is an available update. Accepts options defined below. Returns an instance with an .update
property if there is an available update, otherwise undefined
.
options
Type: object
pkg
Type: object
name
Required\
Type: string
version
Required\
Type: string
updateCheckInterval
Type: number
\
Default: 1000 * 60 * 60 * 24
(1 day)
How often to check for updates.
shouldNotifyInNpmScript
Type: boolean
\
Default: false
Allows notification to be shown when running as an npm script.
distTag
Type: string
\
Default: 'latest'
Which dist-tag to use to find the latest version.
notifier.fetchInfo()
Check update information.
Returns an object
with:
latest
(String) - Latest version.current
(String) - Current version.type
(String) - Type of current update. Possible values:latest
,major
,minor
,patch
,prerelease
,build
.name
(String) - Package name.
notifier.notify(options?)
Convenience method to display a notification message. (See screenshot)
Only notifies if there is an update and the process is TTY.
options
Type: object
defer
Type: boolean
\
Default: true
Defer showing the notification to after the process has exited.
message
Type: string
\
Default: See above screenshot
Message that will be shown when an update is available.
Available placeholders:
{packageName}
- Package name.{currentVersion}
- Current version.{latestVersion}
- Latest version.{updateCommand}
- Update command.
notifier.notify({message: 'Run `{updateCommand}` to update.'});
// Output:
// Run `npm install [email protected]` to update.
isGlobal
Type: boolean
\
Default: Auto-detect
Include the -g
argument in the default message's npm i
recommendation. You may want to change this if your CLI package can be installed as a dependency of another project, and don't want to recommend a global installation. This option is ignored if you supply your own message
(see above).
boxenOptions
Type: object
\
Default: {padding: 1, margin: 1, align: 'center', borderColor: 'yellow', borderStyle: 'round'}
(See screenshot)
Options object that will be passed to boxen
.
User settings
Users of your module have the ability to opt-out of the update notifier by changing the optOut
property to true
in ~/.config/configstore/update-notifier-[your-module-name].json
. The path is available in notifier.config.path
.
Users can also opt-out by setting the environment variable NO_UPDATE_NOTIFIER
with any value or by using the --no-update-notifier
flag on a per run basis.
The check is also skipped automatically:
- on CI
- in unit tests (when the
NODE_ENV
environment variable istest
)
About
The idea for this module came from the desire to apply the browser update strategy to CLI tools, where everyone is always on the latest version. We first tried automatic updating, which we discovered wasn't popular. This is the second iteration of that idea, but limited to just update notifications.
Users
There are a bunch projects using it:
- npm - Package manager for JavaScript
- Yeoman - Modern workflows for modern webapps
- AVA - Simple concurrent test runner
- XO - JavaScript happiness style linter
- Node GH - GitHub command line tool
Get professional support for this package with a Tidelift subscription Tidelift helps make open source sustainable for maintainers while giving companiesassurances about security, maintenance, and licensing for their dependencies.