YAMLicious 0.0.2

YAMLicious

YAMLicious 是一个受 Thoth.Json 语法启发的袖珍 YAML 读取器/写入器！

代码示例

F# 模型

type Package = {
    Name: string
    Version: string option
}

type ArcValidation = {
    ArcSpecificationVersion: string
    Packages: Package list
}   

YAML

arc_specification: 2.0.0-draft
validation_packages:
  - name: package1
    version: 1.0.0
  - name: package2
    version: 2.0.0
  - name: package3

解码（从 YAML）

// from yaml
let Example1 = 
    "arc_specification: 2.0.0-draft
validation_packages:
    - name: package1
    version: 1.0.0
    - name: package2
    version: 2.0.0
    - name: package3"

let packageEncoder : (YAMLicious.YAMLElement -> Package) = 
    Decode.object (fun get ->
        {
            Name = get.Required.Field "name" Decode.string
            Version = get.Optional.Field "version" Decode.string
        }
    )

let arcValidationDecoder : (YAMLicious.YAMLElement -> ArcValidation) =
    Decode.object (fun get ->
        {
            ArcSpecificationVersion = get.Required.Field "arc_specification" Decode.string
            Packages = get.Required.Field "validation_packages" (Decode.list packageEncoder)
        }
    )

let actual : ArcValidation = Examples.ValidationPackageTypes.string |> Decode.read |> arcValidationDecoder

编码（到 YAML）

// to yaml
let Example2 = {
    ArcSpecificationVersion = "2.0.0-draft"
    Packages = [
        { Name = "package1"; Version = Some "1.0.0" }
        { Name = "package2"; Version = Some "2.0.0" }
        { Name = "package3"; Version = None }
    ]
}

let packageEncoder (pack: Package) = 
    [
        "name", Encode.string pack.Name
        Encode.tryInclude "version" Encode.string pack.Version 
    ]
    |> Encode.choose
    |> Encode.object

let arcValidationEncoder (arc: ArcValidation) = 
    Encode.object [
        "arc_specification", Encode.string arc.ArcSpecificationVersion
        "validation_packages", Encode.list packageEncoder arc.Packages
    ]

let actual : string = Encode.write 2 (arcValidationEncoder Example2)

本地开发

需求

由于此库针对多种编程语言，我们需要支持所有这些语言

• nodejs 和 npm
  • 验证 node --version（已测试 v20.10.0）
  • 验证 npm --version（已测试 v9.2.0）
• .NET SDK
  • 验证 dotnet --version（已测试 8.0.205）
• Python
  • 验证 py --version（已测试 3.11.9，已知只支持 >=3.11）

设置

这需要在新鲜下载后一次性完成。Python venv 可执行文件的路径可能因操作系统而异。

1. dotnet tool restore，恢复 .NET 工具（fable）
2. npm i，安装 JS 依赖项
3. py -m venv ./.venv，设置 Python 虚拟环境
4. .\.venv\Scripts\Activate.ps1，激活 Python 虚拟环境
5. 安装 Python 依赖项
   1. python -m pip install -U pip setuptools
   2. python -m pip install poetry
   3. python -m poetry install --no-root

测试

首先激活 Python 虚拟环境（.\.venv\Scripts\Activate.ps1）。

.\build.cmd test

或指定目标

.\build.cmd test [f#，c#，js [native]，py [native]]

发布

需要 Nuget 和 PyPi 的 API 密钥。

以下命令将运行所有测试，捆绑然后开始发布！

.\build.cmd publish pipeline

或仅发布特定目标，不进行测试和打包

.\build.cmd publish [npm, pypi, nuget]