EasyBuild.CommitParser 1.0.0

EasyBuild.Parser

EasyBuild 工具（如 EasyBuild.ChangelogGen 或 EasyBuild.CommitLinter）使用的常见提交解析库。

用法

open EasyBuild.CommitParser
open EasyBuild.CommitParser.Types

let commitText = "..."

// If you need the commit message information
Parser.tryParseCommitMessage CommitParserConfig.Default commitText
// > it: Result<CommitMessage,string>

// If you just want to validate the commit message
Parser.tryValidateCommitMessage CommitParserConfig.Default commitText
// > it: Result<unit,string>

对于配置，您可以使用默认配置或提供自定义配置。

open EasyBuild.CommitParser.Types

// Default configuration
CommitParserConfig.Default

// My custom configuration
{
    Types =
        [
            // ...
        ]
    Tags =
        [
            // ...
        ] |> Some
}

// You can also use a configuration file by passing the JSON content to the included Decoder
open Thoth.Json.Newtonsoft

let configurationJson = "..."

match Decode.fromString Config.Config.decoder configContent with
| Ok config -> config
| Error error ->
    failwithf "Error while parsing the configuration file: %s" error

提交格式

[!注意] EasyBuild.CommitParser 格式基于 标准提交 并扩展以在单代码库环境中使用。

<type>[optional scope][optional !]: <description>

[optional tags]

[optional body]

[optional footer]

• [可选标签] 格式如下

  [tag1][tag2][tag3]
  

• [可选主体] 是自由形式的文本。

  This is a single line body.
  

  This is a
  
  multi-line body.
  

• [可选页脚]遵循 git 跟随者格式

  BREAKING CHANGE: <description>
  Signed-off-by: Alice <[email protected]>
  Signed-off-by: Bob <[email protected]>
  

配置

EasyBuild.CommitParser 随附一个默认配置来验证您的提交。

默认配置允许以下提交类型，不要求标签

• feat - 新功能
• fix - 消除错误
• ci - 修改 CI/CD 配置
• chore - 修改构建过程或辅助工具和库，如文档生成
• docs - 文档更改
• test - 添加缺失的测试或纠正现有测试
• style - 不影响代码含义的更改（空白、格式、缺少分号等）
• 重构 - 一种既不修复错误也不添加功能的代码更改

如有需要，您可以直接通过代码或使用JSON格式的配置文件来提供自定义配置。

配置文件格式

配置文件是一个JSON文件，具有以下属性

types

• 必需：✅
• 类型：{ name: string, description?: string, skipTagLine?: bool } []

接受提交类型的列表。

tags

• 必需：❌
• 类型：string []

接受提交标签的列表。

示例

{
    "types": [
        { "name": "feat", "description": "A new feature", "skipTagLine": false },
        { "name": "fix", "description": "A bug fix", "skipTagLine": false },
        { "name": "docs", "description": "Documentation changes", "skipTagLine": false },
        { "name": "test", "description": "Adding missing tests or correcting existing tests", "skipTagLine": false },
        { "name": "style", "description": "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)", "skipTagLine": false },
        { "name": "refactor", "description": "A code change that neither fixes a bug nor adds a feature", "skipTagLine": false },
        { "name": "ci", "description": "Changes to CI/CD configuration" },
        { "name": "chore", "description": "Changes to the build process or auxiliary tools and libraries such as documentation generation" }
    ],
    "tags": [
        "cli",
        "converter"
    ]
}