@absolunet/git-remote-semver 中文文档教程

Question

@absolunet/git-remote-semver

Git remote tags semver

Install

$ npm install @absolunet/git-remote-semver

Usage

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!');
    }
});

API

configstore(name)

返回一个 configstore< /a> <代码>对象。

name

必需
类型：string

configstore

getVersions(url)

Promise 的 ID 返回有效、排序和清理的 semver 标签的 Array。

url

必需
类型：string

远程 git url

getLatest(url)

Promise返回最新 semver 标签的 string。

url

必需
类型：string

远程 git url

needUpdate(url, current)

Promise如果 current 低于 latest 标签或 false 则返回版本的 string

url

Required
类型：string

远程 git url

current

必需
类型：string

当前 semver 版本。

updateNotification(options)

返回 update-notifier 样式通知的 string。

options

必需
类型：对象

current

必需
类型：字符串
当前服务器版本。

latest

必需
类型：字符串
最新的服务器版本。

lang

类型：字符串
默认值：'en'
用于通知的语言 (fr/en)。

msg

类型：字符串
通知的附加消息。

obnoxiousNotification(options)

不显眼地检查更新并在有可用更新时输出 update-notifier 样式通知。

options

必需
类型：对象

url

必需
类型：字符串
远程 git url

current

必需
类型：字符串
当前服务器版本。

name

必需
类型：字符串
配置存储区的 ID。

lang

类型：字符串
默认值：'en'
用于通知的语言 (fr/en)。

msg

类型：字符串
通知的附加消息。

License

麻省理工学院 © Absolunet