@ oclif/ plugin- warn- if- update- 可用

警告是否有最新版本的 CLI 发布

• 这是什么?
• 如何运作
• 安装
• 配置

这是什么?

此插件显示一个用户运行过时的 CLI 的警告消息 .

如何运作

这个检查版本与npm注册在一个加固过程中同步进行,最多每7天一次. 然后它将一个版本文件保存到缓存目录中,以启用警告. 这个方法的反面是 它不会阻止一个用户 当他们使用你的CLI - 缺点是它只会显示 之后 运行获取新版本的命令.

安装

将插件添加到您的工程中 yarn add @oclif/plugin-warn-if-update-available,然后添加到 package.json oclif CLI 代码:

{
  "name": "mycli",
  "version": "0.0.0",
  // ...
  "oclif": {
    "plugins": ["@oclif/plugin-help", "@oclif/plugin-warn-if-update-available"]
  }
}

配置

单位 package.json设置 oclif['warn-if-update-available'] 对象 下列任何配置属性:

• timeoutInDays - 更新检查的间隔期。 默认为 60.
• message - 自定义更新消息.
• registry - 注册地址。 公共 npm 注册的默认值 : https://registry.npmjs.org
• authorization - 需要认证的登记册的授权信头值.

示例配置

{
  "oclif": {
    "plugins": [
      "@oclif/plugin-warn-if-update-available"
    ],
    "warn-if-update-available": {
      "timeoutInDays": 7,
      "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>.",
      "registry": "https://my.example.com/module/registry",
      "authorization": "Basic <SOME READ ONLY AUTH TOKEN>"
    }
  }
}