Commit project
This commit is contained in:
Rodrigo Pedroso
parent
28471965a0
commit
3ac017a5ad
1030 changed files with 94062 additions and 0 deletions
22
node_modules/update-notifier/check.js
generated
vendored
Normal file
22
node_modules/update-notifier/check.js
generated
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
/* eslint-disable unicorn/no-process-exit */
|
||||
'use strict';
|
||||
let updateNotifier = require('.');
|
||||
|
||||
const options = JSON.parse(process.argv[2]);
|
||||
|
||||
updateNotifier = new updateNotifier.UpdateNotifier(options);
|
||||
|
||||
updateNotifier.checkNpm().then(update => {
|
||||
// Only update the last update check time on success
|
||||
updateNotifier.config.set('lastUpdateCheck', Date.now());
|
||||
|
||||
if (update.type && update.type !== 'latest') {
|
||||
updateNotifier.config.set('update', update);
|
||||
}
|
||||
|
||||
// Call process exit explicitly to terminate the child process
|
||||
// Otherwise the child process will run forever, according to the Node.js docs
|
||||
process.exit();
|
||||
}).catch(() => {
|
||||
process.exit(1);
|
||||
});
|
||||
151
node_modules/update-notifier/index.js
generated
vendored
Normal file
151
node_modules/update-notifier/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
'use strict';
|
||||
const spawn = require('child_process').spawn;
|
||||
const path = require('path');
|
||||
const format = require('util').format;
|
||||
const importLazy = require('import-lazy')(require);
|
||||
|
||||
const configstore = importLazy('configstore');
|
||||
const chalk = importLazy('chalk');
|
||||
const semverDiff = importLazy('semver-diff');
|
||||
const latestVersion = importLazy('latest-version');
|
||||
const isNpm = importLazy('is-npm');
|
||||
const isInstalledGlobally = importLazy('is-installed-globally');
|
||||
const boxen = importLazy('boxen');
|
||||
const xdgBasedir = importLazy('xdg-basedir');
|
||||
const ONE_DAY = 1000 * 60 * 60 * 24;
|
||||
|
||||
class UpdateNotifier {
|
||||
constructor(options) {
|
||||
options = options || {};
|
||||
this.options = options;
|
||||
options.pkg = options.pkg || {};
|
||||
|
||||
// Reduce pkg to the essential keys. with fallback to deprecated options
|
||||
// TODO: Remove deprecated options at some point far into the future
|
||||
options.pkg = {
|
||||
name: options.pkg.name || options.packageName,
|
||||
version: options.pkg.version || options.packageVersion
|
||||
};
|
||||
|
||||
if (!options.pkg.name || !options.pkg.version) {
|
||||
throw new Error('pkg.name and pkg.version required');
|
||||
}
|
||||
|
||||
this.packageName = options.pkg.name;
|
||||
this.packageVersion = options.pkg.version;
|
||||
this.updateCheckInterval = typeof options.updateCheckInterval === 'number' ? options.updateCheckInterval : ONE_DAY;
|
||||
this.hasCallback = typeof options.callback === 'function';
|
||||
this.callback = options.callback || (() => {});
|
||||
this.disabled = 'NO_UPDATE_NOTIFIER' in process.env ||
|
||||
process.argv.indexOf('--no-update-notifier') !== -1;
|
||||
|
||||
if (!this.disabled && !this.hasCallback) {
|
||||
try {
|
||||
const ConfigStore = configstore();
|
||||
this.config = new ConfigStore(`update-notifier-${this.packageName}`, {
|
||||
optOut: false,
|
||||
// Init with the current time so the first check is only
|
||||
// after the set interval, so not to bother users right away
|
||||
lastUpdateCheck: Date.now()
|
||||
});
|
||||
} catch (err) {
|
||||
// Expecting error code EACCES or EPERM
|
||||
const msg =
|
||||
chalk().yellow(format(' %s update check failed ', options.pkg.name)) +
|
||||
format('\n Try running with %s or get access ', chalk().cyan('sudo')) +
|
||||
'\n to the local update config store via \n' +
|
||||
chalk().cyan(format(' sudo chown -R $USER:$(id -gn $USER) %s ', xdgBasedir().config));
|
||||
|
||||
process.on('exit', () => {
|
||||
console.error('\n' + boxen()(msg, {align: 'center'}));
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
check() {
|
||||
if (this.hasCallback) {
|
||||
this.checkNpm()
|
||||
.then(update => this.callback(null, update))
|
||||
.catch(err => this.callback(err));
|
||||
return;
|
||||
}
|
||||
|
||||
if (
|
||||
!this.config ||
|
||||
this.config.get('optOut') ||
|
||||
this.disabled
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.update = this.config.get('update');
|
||||
|
||||
if (this.update) {
|
||||
this.config.delete('update');
|
||||
}
|
||||
|
||||
// Only check for updates on a set interval
|
||||
if (Date.now() - this.config.get('lastUpdateCheck') < this.updateCheckInterval) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Spawn a detached process, passing the options as an environment property
|
||||
spawn(process.execPath, [path.join(__dirname, 'check.js'), JSON.stringify(this.options)], {
|
||||
detached: true,
|
||||
stdio: 'ignore'
|
||||
}).unref();
|
||||
}
|
||||
checkNpm() {
|
||||
return latestVersion()(this.packageName).then(latestVersion => {
|
||||
return {
|
||||
latest: latestVersion,
|
||||
current: this.packageVersion,
|
||||
type: semverDiff()(this.packageVersion, latestVersion) || 'latest',
|
||||
name: this.packageName
|
||||
};
|
||||
});
|
||||
}
|
||||
notify(opts) {
|
||||
if (!process.stdout.isTTY || isNpm() || !this.update) {
|
||||
return this;
|
||||
}
|
||||
|
||||
opts = Object.assign({isGlobal: isInstalledGlobally()}, opts);
|
||||
|
||||
opts.message = opts.message || 'Update available ' + chalk().dim(this.update.current) + chalk().reset(' → ') +
|
||||
chalk().green(this.update.latest) + ' \nRun ' + chalk().cyan('npm i ' + (opts.isGlobal ? '-g ' : '') + this.packageName) + ' to update';
|
||||
|
||||
opts.boxenOpts = opts.boxenOpts || {
|
||||
padding: 1,
|
||||
margin: 1,
|
||||
align: 'center',
|
||||
borderColor: 'yellow',
|
||||
borderStyle: 'round'
|
||||
};
|
||||
|
||||
const message = '\n' + boxen()(opts.message, opts.boxenOpts);
|
||||
|
||||
if (opts.defer === false) {
|
||||
console.error(message);
|
||||
} else {
|
||||
process.on('exit', () => {
|
||||
console.error(message);
|
||||
});
|
||||
|
||||
process.on('SIGINT', () => {
|
||||
console.error('');
|
||||
process.exit();
|
||||
});
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = options => {
|
||||
const updateNotifier = new UpdateNotifier(options);
|
||||
updateNotifier.check();
|
||||
return updateNotifier;
|
||||
};
|
||||
|
||||
module.exports.UpdateNotifier = UpdateNotifier;
|
||||
89
node_modules/update-notifier/package.json
generated
vendored
Normal file
89
node_modules/update-notifier/package.json
generated
vendored
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
{
|
||||
"_args": [
|
||||
[
|
||||
"update-notifier@2.3.0",
|
||||
"/Users/rodrigopinto/Documents/Development/ClusterSystems/cluster-server"
|
||||
]
|
||||
],
|
||||
"_development": true,
|
||||
"_from": "update-notifier@2.3.0",
|
||||
"_id": "update-notifier@2.3.0",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha1-TognpruRUUCrCTVZ1wFOPruDdFE=",
|
||||
"_location": "/update-notifier",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "version",
|
||||
"registry": true,
|
||||
"raw": "update-notifier@2.3.0",
|
||||
"name": "update-notifier",
|
||||
"escapedName": "update-notifier",
|
||||
"rawSpec": "2.3.0",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "2.3.0"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/nodemon"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-2.3.0.tgz",
|
||||
"_spec": "2.3.0",
|
||||
"_where": "/Users/rodrigopinto/Documents/Development/ClusterSystems/cluster-server",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "sindresorhus.com"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/yeoman/update-notifier/issues"
|
||||
},
|
||||
"dependencies": {
|
||||
"boxen": "^1.2.1",
|
||||
"chalk": "^2.0.1",
|
||||
"configstore": "^3.0.0",
|
||||
"import-lazy": "^2.1.0",
|
||||
"is-installed-globally": "^0.1.0",
|
||||
"is-npm": "^1.0.0",
|
||||
"latest-version": "^3.0.0",
|
||||
"semver-diff": "^2.0.0",
|
||||
"xdg-basedir": "^3.0.0"
|
||||
},
|
||||
"description": "Update notifications for your CLI app",
|
||||
"devDependencies": {
|
||||
"ava": "*",
|
||||
"clear-module": "^2.1.0",
|
||||
"fixture-stdout": "^0.2.1",
|
||||
"strip-ansi": "^4.0.0",
|
||||
"xo": "^0.18.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"check.js"
|
||||
],
|
||||
"homepage": "https://github.com/yeoman/update-notifier#readme",
|
||||
"keywords": [
|
||||
"npm",
|
||||
"update",
|
||||
"updater",
|
||||
"notify",
|
||||
"notifier",
|
||||
"check",
|
||||
"checker",
|
||||
"cli",
|
||||
"module",
|
||||
"package",
|
||||
"version"
|
||||
],
|
||||
"license": "BSD-2-Clause",
|
||||
"name": "update-notifier",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/yeoman/update-notifier.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava --timeout=20s"
|
||||
},
|
||||
"version": "2.3.0"
|
||||
}
|
||||
184
node_modules/update-notifier/readme.md
generated
vendored
Normal file
184
node_modules/update-notifier/readme.md
generated
vendored
Normal file
|
|
@ -0,0 +1,184 @@
|
|||
# update-notifier [](https://travis-ci.org/yeoman/update-notifier)
|
||||
|
||||
> Update notifications for your CLI app
|
||||
|
||||
|
||||
|
||||
Inform users of your package of updates in a non-intrusive way.
|
||||
|
||||
#### Contents
|
||||
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
- [How](#how)
|
||||
- [API](#api)
|
||||
- [About](#about)
|
||||
- [Users](#users)
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install update-notifier
|
||||
```
|
||||
|
||||
|
||||
## Usafe
|
||||
|
||||
### Simple
|
||||
|
||||
```js
|
||||
const updateNotifier = require('update-notifier');
|
||||
const pkg = require('./package.json');
|
||||
|
||||
updateNotifier({pkg}).notify();
|
||||
```
|
||||
|
||||
### Comprehensive
|
||||
|
||||
```js
|
||||
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
|
||||
|
||||
```js
|
||||
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](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). 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 there is an available update, otherwise `undefined`.
|
||||
|
||||
### options
|
||||
|
||||
#### pkg
|
||||
|
||||
Type: `Object`
|
||||
|
||||
##### name
|
||||
|
||||
*Required*<br>
|
||||
Type: `string`
|
||||
|
||||
##### version
|
||||
|
||||
*Required*<br>
|
||||
Type: `string`
|
||||
|
||||
#### updateCheckInterval
|
||||
|
||||
Type: `number`<br>
|
||||
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`](#how). `update` is equal to `notifier.update`.
|
||||
|
||||
### notifier.notify([options])
|
||||
|
||||
Convenience method to display a notification message. *(See screenshot)*
|
||||
|
||||
Only notifies if there is an update and the process is [TTY](https://nodejs.org/api/process.html#process_tty_terminals_and_process_stdout).
|
||||
|
||||
#### options
|
||||
|
||||
Type: `Object`
|
||||
|
||||
##### defer
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
Defer showing the notification to after the process has exited.
|
||||
|
||||
##### message
|
||||
|
||||
Type: `string`<br>
|
||||
Default: [See above screenshot](https://github.com/yeoman/update-notifier#update-notifier-)
|
||||
|
||||
Message that will be shown when an update is available.
|
||||
|
||||
##### isGlobal
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
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`<br>
|
||||
Default: `{padding: 1, margin: 1, align: 'center', borderColor: 'yellow', borderStyle: 'round'}` *(See screenshot)*
|
||||
|
||||
Options object that will be passed to [`boxen`](https://github.com/sindresorhus/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](https://github.com/sindresorhus/guides/blob/master/set-environment-variables.md) `NO_UPDATE_NOTIFIER` with any value or by using the `--no-update-notifier` flag on a per run basis.
|
||||
|
||||
|
||||
## 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](https://github.com/npm/npm) - Package manager for JavaScript
|
||||
- [Yeoman](http://yeoman.io) - Modern workflows for modern webapps
|
||||
- [AVA](https://ava.li) - Simple concurrent test runner
|
||||
- [XO](https://github.com/sindresorhus/xo) - JavaScript happiness style linter
|
||||
- [Pageres](https://github.com/sindresorhus/pageres) - Capture website screenshots
|
||||
- [Node GH](http://nodegh.io) - GitHub command line tool
|
||||
|
||||
[And 1600+ more…](https://www.npmjs.org/browse/depended/update-notifier)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
[BSD license](http://opensource.org/licenses/bsd-license.php) and copyright Google
|
||||
Loading…
Add table
Add a link
Reference in a new issue