DangerSwiftShoki

一个 danger-swift 插件，用于管理/发布 markdown 样式的 danger 检查结果

安装 DangerSwiftShoki

SwiftPM (推荐)

将依赖包添加到导入了 danger-swift 的 Package.swift 文件中

// swift-tools-version:5.5
...
let package = Package(
    ...
    dependencies: [
        ...
        // Danger Plugins
        .package(name: "DangerSwiftShoki", url: "https://www.github.com/yumemi-inc/danger-swift-shoki.git", from: "0.1.0"),
        ...
    ],
    ...
)

将正确的导入添加到您的 Dangerfile.swift 文件中
```
import DangerSwiftShoki
```

Marathon (工具已弃用)

只需像这样将依赖导入添加到您的 Dangerfile.swift 文件中

import DangerSwiftShoki // package: https://github.com/yumemi-inc/danger-swift-shoki.git

用法

基本上只需使用 DangerDSL 实例中的 .shoki 属性来访问 DangerSwiftShoki 提供的所有功能

以下示例假设您已在 Dangerfile.swift 中使用 Danger() 初始化了 danger

首先，使用 makeInitialReport 方法创建一个报告数据结构
```
var report = danger.shoki.makeInitialReport(title: "My Report")
```

然后，您可以使用 check 方法执行任何检查，通过在尾随的 execution 闭包中返回您的检查结果

danger.shoki.check("Test Result Check", into: &report) {
    if testPassed {
        return .good
        
    } else {
        if isAcceptable {
            return .acceptable(warningMessage: "Encouraged to make a change but OK at this time")
            
        } else {
            return .rejected(failureMessage: "Must fix")
        }
    }
}

如果需要，您还可以使用 askReviewer 方法提醒审阅者不要忘记进行一些手动检查

danger.shoki.askReviewer(to: "Check whether commit messages are correctly formatted or not", into: $report)

最后，使用 report 方法发布整个检查结果
```
danger.shoki.report(report)
```

预览

以上代码将使 danger 生成如下 markdown 消息

我的报告

检查项结果

测试结果检查 🎉

检查提交消息的格式是否正确

做得好 💮