Cedar Policy Formatter

本包包含基于 pretty 包的简单格式化库。我们将其集成到 Cedar CLI 中，以便您可以直接格式化您的 Cedar 策略。您也可以将其作为库用于您的 Cedar 应用程序。

请通过 功能请求 分享您对格式的看法。并且使用 错误报告 报告您发现的任何错误。

快速入门

格式化您的 Cedar 策略最简单的方法是通过 Cedar CLI 的 format 子命令。

# Default indentation is two spaces.
# Default line width is 80.
cedar format -p my-policies.cedar
# I want more indentation.
cedar format -i 4 -p my-policies.cedar
# I like shorter lines.
cedar format -l 40 -p my-policies.cedar

使用方法

构建

要构建，只需运行 cargo build（或 cargo build --release）。

运行

格式化器通过 Cedar CLI 的 format 子命令调用。其选项可以通过以下命令找到。

cedar format -h

文档

最新版本的生成文档可以在 docs.rs 上访问。

测试

本软件包的测试使用 insta 进行快照测试。测试通过常用的 cargo test 执行，但如果您的更改导致我们对测试策略的格式化方式发生变化，测试将失败，并以格式良好的diff形式打印错误信息。然后您可以运行 cargo insta review 来审查格式化更改。如果更改是预期的，接受并提交更新的快照文件。否则，拒绝更改，并像处理其他任何失败的测试用例一样修复它。

您只需在 tests 目录中放置一个 .cedar 文件即可添加新的测试用例。下一次运行 cargo test 将会失败，因为没有快照文件。运行 cargo insta review 来审查新测试的格式化输出。如果快照文件正确，接受并提交它。