Git remote tags semver
$ npm install @absolunet/git-remote-semver
const pkg = require('package');
const gitRemoteSemver = require('@absolunet/git-remote-semver');
gitRemoteSemver.needUpdate('git@github.com:absolunet/node-git-remote-semver.git', pkg.version).then((version) => {
if (version) {
console.log(gitRemoteSemver.updateNotification({
current: pkg.version,
latest: version,
msg: 'Please update...'
}));
} else {
console.log('You are up to date!');
}
});
Returns an configstore Object
.
Required
Type: string
Id for the configstore
Promise
returns an Array
of valid, sorted, and cleaned semver tags.
Required
Type: string
The remote git url
Promise
returns a string
of the latest semver tag.
Required
Type: string
The remote git url
Promise
returns a string
of version if current
is lower than latest tag or false
Required
Type: string
The remote git url
Required
Type: string
Current semver version.
Returns a string
of a update-notifier style notification.
Required
Type: Object
Required
Type: string
Current semver version.
Required
Type: string
Latest semver version.
Type: string
Default: 'en'
Language to use for notification (fr/en).
Type: string
Additional message for the notification.
Check for updates unobtrusively and outputs a update-notifier style notification if an update is available.
Required
Type: Object
Required
Type: string
The remote git url
Required
Type: string
Current semver version.
Required
Type: string
Id for the configstore.
Type: string
Default: 'en'
Language to use for notification (fr/en).
Type: string
Additional message for the notification.
MIT © Absolunet