@142vip/release-version

安装

1# 安装
2pnpm i @142vip/release-version -D
3
4# 查看版本
5npx bumpx -v

命令

1# 查看使用
2npx bumpx -h
3
4Usage: @142vip/release-version [...files]
5
6通用型版本迭代Cli工具，支持版本迭代更新，Git提交信息、打标记并推送到远程
7
8Options:
9  -v --version                 VipCommander Version By @142vip
10  --preid <preid>              预发布标记 (default: "alpha")
11  --all                        Include all files (default: false)
12  -c, --commit                 Commit message,also can skip commit (default: true)
13  -t, --tag                    Tag name,also can skip tag (default: false)
14  -p, --push                   Push to remote (default: true)
15  -y, --confirm                Skip confirmation (default: true)
16  -r, --recursive              Bump package.json files recursively (default: false)
17  --skip-git-verify            Skip git verification
18  --ignore-scripts             Ignore scripts (default: false)
19  --changelog                  generate CHANGELOG.md (default: false)
20  --current-version <version>  Current version
21  -x, --execute <command>      Commands to execute after version bumps
22  --scopeName <scopeName>      Package name in monorepo
23  --dry-run                    试运行 (default: false)
24  --vip                        @142vip组织专用功能 (default: false)
25  --logger                     开启日志追踪模式 (default: false)
26  -h, --help                   display help for command
27
28Commands:
29  help [command]               display help for command

API

• versionBump(options: VersionBumpOptions)
• versionBumpDryRun(options: VersionBumpOptions)
• versionBumpInfo(options: VersionBumpOptions)

类型

1export interface VersionBumpOptions {
2  /**
3   * 预发行类型（例如 “alpha”、“beta”、“next”），默认：“alpha”
4   */
5  preid?: string
6
7  /**
8   * 是否生成CHANGELOG.md文档
9   */
10  changelog?: boolean
11
12  /**
13   * 当前版本号
14   */
15  currentVersion?: string
16
17  /**
18   * 指示是否创建 git 提交。可以设置为自定义提交消息字符串，默认是“true”
19   * - 消息字符串中的任何 '%s' 占位符都将被替换为新版本号。
20   * - 如果消息字符串不包含任何 '%s' 占位符，则新版本号将附加到消息中。
21   */
22  commit?: boolean | string
23
24  /**
25   * 指示是否标记 git 提交。可以设置为自定义标签字符串，默认是“true”
26   * - 标签字符串可以是自定义字符串，例如 'v%s'
27   * - 标签字符串中的任何 '%s' 占位符都将被替换为新版本号
28   * - 如果标签字符串不包含任何 '%s' 占位符，则新版本号将附加到标签中
29   */
30  tag?: boolean | string
31
32  /**
33   * 是否推送 git commit 和 tag。默认：true
34   */
35  push?: boolean
36
37  /**
38   * Indicates whether the git commit should include ALL files (`git commit --all`)
39   * rather than just the files that were modified by `versionBump()`.
40   *
41   * Defaults to `false`.
42   */
43  all?: boolean
44
45  /**
46   * 支持用户确认提示，默认：true
47   */
48  confirm?: boolean
49
50  /**
51   * 指示是否绕过 git 提交钩子 （'git commit --no-verify'）。默认：false
52   */
53  skipGitVerify?: boolean
54
55  /**
56   * 工作目录，用作查找所有文件的基础。默认：process.cwd()
57   */
58  cwd?: string
59
60  /**
61   * 指示是否忽略version版本脚本。默认：false
62   *
63   */
64  ignoreScripts?: boolean
65
66  /**
67   * 在 bumping 之后和 commit 之前执行其他命令
68   */
69  execute?: string
70
71  /**
72   * monorepo模式下，指定模块名包名
73   */
74  scopeName?: string
75
76  /**
77   * 递归地为 monorepo 加载文件。仅在发布monorepo主模块时有效，默认false
78   */
79  recursive?: boolean
80}
81
82/**
83 * Information about the work that was performed by the `versionBump()` function.
84 */
85export interface VersionBumpResults {
86  /**
87   * T使用的发布类型，如果使用了自定义版本号，则为 'undefined' .
88   */
89  release?: VipReleaseType
90
91  /**
92   * package.json文件中对应的上一个版本号
93   */
94  currentVersion: string
95
96  /**
97   * 发布的新的版本号
98   */
99  newVersion: string
100
101  /**
102   * 用于 git 提交的提交消息，如果未创建 git 提交，则为“false”。
103   * - 注意：这永远不会是空字符串。 它将始终至少包含新版本号。
104   */
105  commit: string | false
106
107  /**
108   * 用于 git 标签的标签名称，如果未创建 git 标签，则为 'false'。
109   * - 注意：这永远不会是空字符串。 它将始终至少包含新版本号。
110   */
111  tag: string | false
112}

证书

MIT

Copyright (c) 2019-present, 142vip 储凡