@fluid-tools/version-tools (英语)

版本工具包提供 API 和 CLI ,用于解析和转换版本编号和范围 流体框架.

• @fluid-tools/version-tools (英语)
• 版本计划
• API 概况
• CLI 使用量
• 图标

版本计划

Fluid框架包有时使用不同于标准语义版本的版本方案. 默认为新 软件包应当使用标准语义版本。 然而,还有另外两个版本方案: 内部 财务报告和审定财务报表 虚拟批次。 。 。 .

内部版本方案

[注] Fluid框架不再使用内部版本方案. 然而,我们仍然希望为内部版本方案保存信息和工具,因为:

1. 在兼容性测试中我们可能会遇到内部版本.
2. 我们可以选择在未来重新实施内部版本计划.

流体内部版本方案由两个分母"三相"组成:主/小/patch. 第一个三胞胎叫做 页:1 公开版本,并被存储在版本字符串中典型的 semver 位置.

第二个三胞胎叫做 内部版本,可见于该版本的预发部分末尾 版本字符串.

流体内部版本字符串 永远 包含字符串 internal 在释放前的第一个位置 节.

如下例,公开版本为: a.b.c,而内部版本是 x.y.z。 。 。 .

a.b.c-internal.x.y.z

API 密码

• isInternalVersionScheme -- 如果字符串代表内部版本编号,则返回真实值.
• isInternalVersionRange -- 如果字符串代表了内部版本范围,则返回真实性.
• toInternalScheme -- 将标准semver版本字符串转换为内部版本方案.
• fromInternalScheme -- 将内部版本方案字符串转换为两个标准 sembers -- -- 一个供公众使用 版本和内部版本的版本.
• bumpInternalVersion ——鉴于内部版本和凸起类型,返回凸起版本.
• getVersionRange -- 鉴于内部版本和约束类型,返回强制的依赖性版本范围 制约.

虚拟Patch版本方案

Fluid虚拟Patch版本方案仅用于1.0前包. 版本为形式:

0.major.minorpatch

小版本和补丁版本通过将小版本乘以1000并再添加补丁来合并 版本。 例如,对于标准铸模 1.2.3,虚拟Patch版本方案将产生 0.1.2003。 。 。 .

小版本总是从1而不是从0开始. 也就是说,主要版本3的首次发布将是 0.3.1000。 。 。 .

API 密码

• isVirtualPatch -- 如果字符串代表内部版本编号,则返回真实值.

API 概况

• detectVersionScheme - 给定一个版本或范围字符串,确定字符串使用的版本方案.
• incRange -- 增额a 范围 按凸起类型(主要、次要或补丁),保持现有的制约.

CLI 使用量

版本工具提供命令行接口( namefluv当直接安装时。 不过,这里列出的指令是: 也可以在流体构建和释放工具中找到(flub) (中文(简体) ). 使用 oclif 插件系统。 。 。 .

$ npm install -g @fluid-tools/version-tools
$ fluv COMMAND
running command...
$ fluv (--version|-V)
@fluid-tools/version-tools/0.0.0
$ fluv --help [COMMAND]
USAGE
  $ fluv COMMAND
...

图标

• fluv autocomplete [SHELL]
• fluv help [COMMAND]
• fluv version VERSION
• fluv version latest

fluv autocomplete [SHELL]

显示自动完成安装指令 .

USAGE
  $ fluv autocomplete [SHELL] [-r]

ARGUMENTS
  [SHELL]  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ fluv autocomplete

  $ fluv autocomplete bash

  $ fluv autocomplete zsh

  $ fluv autocomplete powershell

  $ fluv autocomplete --refresh-cache

参见代码 : @oclif/ plugin- auto 完成

fluv help [COMMAND]

显示 fluv 的帮助 .

USAGE
  $ fluv help [COMMAND...] [-n]

ARGUMENTS
  [COMMAND...]  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for fluv.

参见代码 : @oclif/plugin-帮助

fluv version VERSION

在正则 semver 和 Fluid 内部版本方案之间转换版本字符串 .

USAGE
  $ fluv version VERSION [--json] [-t major|minor|patch|current] [--publicVersion <value>]

ARGUMENTS
  VERSION  The version to convert.

FLAGS
  -t, --type=<option>          bump type
                               <options: major|minor|patch|current>
      --publicVersion=<value>  [default: 2.0.0] The public version to use in the Fluid internal version.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Convert version strings between regular semver and the Fluid internal version scheme.

EXAMPLES
  The version can be a Fluid internal version.

    $ fluv version 2.0.0-internal.1.0.0 --type minor

  The version can also be a semver with a bump type.

    $ fluv version 1.0.0 --type minor

  If needed, you can provide a public version to override the default.

    $ fluv version 1.0.0 --type patch --publicVersion 3.1.0

  You can use ^ and ~ as a shorthand.

    $ fluv version ^1.0.0

  You can use the 'current' bump type to calculate ranges without bumping the version.

    $ fluv version 2.0.0-internal.1.0.0 --type current

参见代码 : src/命令/版本.ts

fluv version latest

从版本字符串列表中查找最新版本,核算Fluid内部版本方案.

USAGE
  $ fluv version latest -r <value>... [--json] [--prerelease]

FLAGS
  -r, --versions=<value>...  (required) The versions to evaluate. The argument can be passed multiple times to provide
                             multiple versions, or a space-delimited list of versions can be provided using a single
                             argument.
      --prerelease           Include prerelease versions. By default, prerelease versions are excluded.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Find the latest version from a list of version strings, accounting for the Fluid internal version scheme.

EXAMPLES
  You can use the --versions (-r) flag multiple times.

    $ fluv version latest -r 2.0.0 -r 2.0.0-internal.1.0.0 -r 1.0.0 -r 0.56.1000

  You can omit the repeated --versions (-r) flag and pass a space-delimited list instead.

    $ fluv version latest -r 2.0.0 2.0.0-internal.1.0.0 1.0.0 0.56.1000

参见代码 : src/commands/版本/最上层

开发者笔记

此软件包输出其构建文件到 lib/ 改为 dist/ 就像我们其他的包裹一样 原因是 oclif通过常规使用 lib 文件夹, 并且有 oclif 错误可以通过将内容放入 lib 来避免 。 见 例如 https://github.com/microsoft/FluidFramework/pull/12155 页面存档备份,存于互联网档案馆

贡献准则

你们可以 贡献 通过这些方式实现流体框架:

• 回答问题 GitHub 讨论。 。 。 .
• 提交错误报告 并且帮助验证修正.
• 审查 源代码更改。 。 。 .
• 贡献错误修正。 。 。 .

详细指示改为: repo 文档。 。 。 .

本项目遵循 Microsoft 开源行为守则。 。 。 . 更多信息,改为: 《行为守则》经常被问到的问题。 。 。 . 问题或评论,联系 打开码@ microsoft.com。 。 。 .

这个项目可能包含微软项目的商标或标志,产品,或服务. 这些商标或标志的使用必须遵循微软 商标和品牌准则。 。 。 . 在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.

帮助

读取 流体框架文件 用于了解流体框架概念和API.

要求提供文件未载列的资料, 创建问题。 。 。 .

商标

这个项目可能包含微软项目的商标或标志,产品,或服务.

这些商标或标志的使用必须遵循微软的 商标和品牌准则。 。 。 .

在这个项目的修改后版本中使用微软商标或标志不得造成混淆或暗示微软赞助.