English Lint

查找英语文本中的常见风格问题。适用于技术或科学文档。基于 write-good 和 这篇文章。

此存储库包含一个库和一个简单的 CLI 工具。

CLI 使用方法

首先，使用 cargo install english-lint 安装 CLI 工具（假定您已在系统上安装了最新版本的 Rust 和 Cargo）。

您可以将文本数据管道传输给它（例如，echo "Hello world" | english-lint）或使用文件名参数调用它（english-lint my-thesis.md）。对于每个建议输出一行，包含lint组名和行号以及起始/结束字符索引。如果您没有看到任何输出，english-lint 认为您的文本已经完美 :)

$ english-lint Readme.md
wordy: 'shall' (22:72-77)
wordy: 'additional' (23:39-49)

库使用方法

首先，将 english-lint 添加到您的项目依赖项中（例如，使用 cargo add english-lint 使用 cargo-edit）并使用 extern crate english_lint; 包含它。

目前，此库仅公开两项内容：一个自由函数，english_lint::lint 和该函数返回的结构，english_lint::Hint。

API 文档.

许可

根据以下之一许可

• Apache 许可证 2.0 (LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT) 可选。

贡献

除非您明确声明，否则根据Apache-2.0许可证定义的，您有意提交以包含在作品中的任何贡献，均应双重许可如上，不附加任何额外条款或条件。