yeoman/update-notifier


Update notifications for your CLI app

License: BSD-2-Clause

Language: JavaScript


update-notifier Build Status

Update notifications for your CLI app

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 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.

callback(error, update)

Type: Function

Passing a callback here will make it check for an update directly and report right away. Not recommended as you won't get the benefits explained in How. update is equal to notifier.update.

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.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.

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).

boxenOpts

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 on CI automatically.

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
  • Pageres - Capture website screenshots
  • Node GH - GitHub command line tool

And 2700+ more…


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Project Statistics

Sourcerank 20
Repository Size 166 KB
Stars 1,255
Forks 106
Watchers 26
Open issues 18
Dependencies 18
Contributors 43
Tags 36
Created
Last updated
Last pushed

Top Contributors See all

Sindre Sorhus Simon Boudrias LitoMore Andrew Goode Pascal Hartig André Cruz Zeno Rocha Kevin Mårtensson Sam Saccone hemanth.hm Jeff Escalante Tim Deschryver ecmarsh Simen Bekkhus Linus Unnebäck Jacob Wejendorp Addy Osmani Sven Lito Bart van der Schoor Ron Waldon

Packages Referencing this Repo

update-notifier
Update notifications for your CLI app
Latest release 2.6.0 - Updated - 1.26K stars
update-notifier2
Update notifications for your CLI app
Latest release 1.0.6 - Updated - 1.26K stars
org.webjars.npm:update-notifier
WebJar for update-notifier
Latest release 2.5.0 - Updated - 1.26K stars

Recent Tags See all

v3.0.1 July 02, 2019
v3.0.0 May 10, 2019
v2.6.0 May 10, 2019
v2.5.0 April 14, 2018
v2.4.0 March 25, 2018
v2.3.0 October 09, 2017
v2.2.0 June 06, 2017
v2.1.0 February 18, 2017
v2.0.0 February 13, 2017
v1.0.3 December 04, 2016
v1.0.2 June 21, 2016
v1.0.1 June 17, 2016
v1.0.0 June 13, 2016
v0.7.0 May 05, 2016
v0.6.3 March 17, 2016

Interesting Forks See all

defconcepts/update-notifier
Update notifications for your CLI app
JavaScript - Updated - 2 stars
mhkeller/update-notifier-plus
Update notifications for your CLI app
JavaScript - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-09-10 17:11:39 UTC

Login to resync this repository