npm-updater's Introduction

npm-updater

Check update of npm package.

Installation

$ npm i npm-updater --save

Usage

const updater = require('npm-updater');

updater({
  package: require('./package.json'),
  level: 'major',
}).then(result => {
  console.log(result.name, result.version, result.current, result.type);
});

Options

/**
 * check a package lastest version
 * @param {Object} options - query Object
 * @param {Object} options.name - package name, default get from parent package.
 * @param {Object} options.version - package current version, default get from parent package.
 * @param {Object} [options.package] - pass module's `package.json` object
 * @param {String} [options.registry] - publishConfig.registry || npm
 * @param {String} [options.tag] - compare with which tag, default to `latest`.
 * @param {String} [options.interval] - notify interval, default to 1d.
 * @param {Boolean} [options.abort] - If remote version changed, should we abort? default to `true`.
 * @param {String} [options.level] - abort level, default to `minor`.
 * @param {String} [options.updateMessage] - appending update message.
 * @param {Function} [options.formatter] - custom format fn, with args { name, version, current, isAbort, options }.
 * @return {Object} - { name, version, current, type, pkg, options }, type: latest, major, minor, patch, prerelease, build, null
 */

Notice

Please make sure you pacakge's initial version is bigger than 1.0.0.

License

MIT

npm-updater's People

Contributors

Stargazers

Watchers

npm-updater's Issues

replace co with async/await

use node-fetch instead of urllib

Reference an issue of npm registry

The issue breaks the npm-updater on package with scope.

Just a Ref: https://github.com/npm/registry/issues/34 , in case it fixed.

install failed

PS D:\node\www\test\temp\npm-updater> npm i npm-updater --save
npm ERR! code ENOSELF
npm ERR! Refusing to install package with name "npm-updater" under a package
npm ERR! also called "npm-updater". Did you name your project the same
npm ERR! as the dependency you're installing?
npm ERR!
npm ERR! For more information, see:
npm ERR!     <https://docs.npmjs.com/cli/install#limitations-of-npms-install-algorithm>

npm ERR! A complete log of this run can be found in:
npm ERR!     D:\node\anzhuang\node_cache\_logs\2018-05-17T03_06_04_382Z-debug.log