cargogrammarly

警告

该命令仍处于 alpha 阶段。不要期望太多。

描述

提高您文档的质量。使用正确的英语单词和语法，让任何人都能够理解您的文档，让任何人都能够使用您的代码，减少人们理解 crate 的工作原理及其功能所需的时间。良好的示例是必要的，但正确的拼写和易于理解的解释同样重要。

如何使用

使用 grammarly crate 检查代码中的语法和拼写错误。

该实用工具简单地从您 crate 的源代码中获取所有文档注释（///、//!、#![doc = "text"] 和 #[doc = "text"]）并将它们发送到使用 grammarly crate 的 grammarly 语法检查机器人。如果文本中存在任何错误，它们将以与 rustc 编译器打印警告和错误相同的方式进行打印。

使用 syn 和 proc_macro2 crate 对文档注释进行解析。这些特定用于知道这些注释在代码中的位置。使用正则表达式来做这会浪费很多时间。

注意事项

速率限制

Grammarly 服务有其 速率限制，在 06/06/19 这些是

请求限制

Grammar Bot 提供了语法和拼写检查方面最慷慨的免费限制，但这并非无限。使用 API 密钥，您可以免费接收每日 250 请求（约每月 7500 次）。如果没有 API 密钥，每日每个 IP 地址的请求限制为 100 次（约每月 3000 次）。如果您需要更高数量的请求，请联系我们了解付费选项。

该程序包会尽量减少向 Grammarly 服务发送请求的次数，但请确保您理解速率限制，并且工具有时可能不会给出任何提示。

文档文本提示

1. 始终在句子的末尾放置句号。
2. 如果您已在该服务中注册，最好使用服务中的账户，因为它没有任何速率限制。
3. 不要非常频繁地使用 `` markdown 符号，因为 Grammarly 无法正确处理它们。

配置

该工具开箱即用，但如果您想使用自己的 API 密钥，您可能希望将其放在 .env 文件中或作为环境变量。

GRAMMARLY_API_KEY=99999999

安装和使用

按照上一节所示编译代码，然后将 cargo-grammarly 可执行文件放入您的 PATH 中。

我最喜欢的做法是在 ~/bin 中有一个预先存在的目录，其中包含我的小脚本，该目录已添加到我的 .bashrc 中，以便始终可用，然后我将从现有位置创建到该目录的符号链接。

ln -s [starting directory]/cargo-grammarly/target/release/cargo-grammarly ~/bin/

完成这些操作后，由于 cargo 设置为使用第三方扩展，在您自己的任何其他 Rust 项目中，您应该能够运行

cargo grammarly

并且该程序包的所有文档和注释都将进行语法检查。

许可证

MIT