ys - yaml-schema

yaml-schema 是一个用于验证YAML文件是否符合YAML模式的工作中工具。

YAML模式规范基于JSON模式 (https://json-schema.org/)，但以YAML的形式表达。

yaml-schema 既是Rust库也是可执行文件。

示例用法

给定一个包含

type: object
properties:
  foo:
    type: string
  bar:
    type: number

和一个包含的文件

foo: "I'm a string"
bar: 42

然后当您执行以下命令时

ys -f schema.yaml valid.yaml

那么命令应该成功，退出码为0

另一方面，当给定一个包含的文件时

foo: 42
bar: "I'm a string"

那么命令

ys -f schema.yaml invalid.yaml

应该失败，退出码为1

特性

yaml-schema 使用Cucumber来指定和测试功能

• 命令行使用
• 基本功能
• 字符串验证
• 数字类型

查看功能文件夹中的所有示例。

安装

目前，yaml-schema 需要 Git、Rust 和 Cargo 以本地构建和安装： https://doc.rust-lang.net.cn/cargo/

要安装 ys 二进制文件，只需检出此存储库，然后在其中执行以下命令

cargo install --path .

这将构建并安装到 $HOME/.cargo/bin/ys (它应该在您的PATH中)

使用

在不带任何选项或参数的情况下运行 ys 应该显示帮助信息

A tool for validating YAML against a schema

Usage: ys [OPTIONS] [FILE] [COMMAND]

Commands:
  version  Display the ys version
  help     Print this message or the help of the given subcommand(s)

Arguments:
  [FILE]  The YAML file to validate

Options:
  -f, --schema <SCHEMAS>  The schema to validate against
  -h, --help              Print help
  -V, --version           Print version