This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@series-one/toolkit-updater

Toolkit Updater

依赖更新工具

BACKGROUND

在工具维护能力上, 版本更新的通知是十分必要的. 由于项目中(例如本项目)工具过多, 而每一个都需要单独去接人一套更新程序是十分痛苦的事情. 该工具主要服务于上层工具, 通过遍历查找到对应需要更新的版本并给予用户提醒.

FEATURE

• 自动获取当前依赖是否需要更新
• 能对比线上版本
• 能够获取在项目中有声明并且依赖中包含本包以及本包父级的依赖
  • 避免多余提醒与在线版本对比
    • 过滤第三方包
    • 过滤子包

INSTALL

# local install
$ yarn add --dev @series-one/toolkit-updater
# global install
$ yarn global add @series-one/toolkit-updater

USAGE

import { findOutdateds } from '@series-one/toolkit-updater'

const outdates = await findOutdateds({
  /* 仅更新补丁版与功能版本 */
  includes: ['minor', 'patch'],
  /* 发布时间超过(单位毫秒) */
  overTime: 0,
  /* 请求超时, 默认 3 秒 */
  timeout: 3e3,
})

outdates.forEach(({ name, updateType, version, latestVersion }) => {
  console.log(`${name}@${version}有一个新的${updateType}版本,请更新到${latestVersion}`)
})

单独使用

import { shouldUpdate } from '@series-one/toolkit-updater'

const {
  name,
  updateType,
  version,
  latestVersion,
  shouldUpdate: needUpdate,
} = await shouldUpdate('name', {
  /* 当前版本 */
  comareVersion: '1.0.0',
  /* 仅更新补丁版与功能版本 */
  includes: ['minor', 'patch'],
  /* 发布时间超过(单位毫秒) */
  overTime: 0,
  /* 请求超时, 默认 3 秒 */
  timeout: 3e3,
})

if (needUpdate) {
  console.log(`${name}@${version}有一个新的${updateType}版本,请更新到${latestVersion}`)
}

CONTRIBUTING

可以通过 Git 对项目进行贡献; 若没有本项目组权限, 项目需要权限申请, 请通过 OA Git 项目权限申请流程进行申请, 用户角色为 Developer

CONTRIBUTORS

• [e-mail]