Aaryan-Kapoor/english-rs

选用指南

AI 根据 README 整理 · 2026/10/26 00:26:24

使用方式

通过命令行使用englishc检查散文，或作为Rust库使用english宏。

查看 README 依据

**`englishc`** is the migration tool for the fifteen centuries of legacy English already out there. It reads ordinary prose and reports what the new edition would reject, in rustc's diagnostic format, with `--fix` for the cases where the right answer is unambiguous. ## englishc ```console $ cargo run -p englishc -- examples/essay.txt Compiling examples/essay.txt (english 2026) ... error[E0001]: mismatched verb form --> examples/essay.txt:3:70 | 3 | Irregardless of the weather, me and my brother goed to the beach. He are

To keep that honest, the compiler is run over the prose of *The Rust Programming Language*, about 150,000 words that a team of editors has already been over. It reports no errors and 17 warnings. A dozen of those are ambiguous pronouns, several of them genuinely ambiguous ("The runtime will pause the future until it is ready"), and one is a true positive: the book calls ownership "Rust's most unique feature". ## The english crate ```rust use english::english; let text = english!(The dog barks. I 'm happy! These mice are small. She doesn 't care.);

部署要求

需要Rust工具链和cargo，构建playground需要Python 3和wasm32-unknown-unknown目标。

查看 README 依据

`playground/` holds a single-page playground that runs `englishc` in the browser. `python3 -I playground/build.py` compiles the compiler to `wasm32-unknown-unknown` (it exposes a small C ABI, so no bindgen is needed), compiles each program in `playground/examples/` with rustc and records its real output, and writes the result to `playground/dist/`. ## Building and testing ```console cargo test # unit tests, doctests, and the compile_fail examples cargo run -p englishc -- -W help python3 -I playground/build.py # needs the wasm32-unknown-unknown target ```

已知限制

english宏只理解英语的一个子集，每个句子仅支持一个主语和一个限定动词。

查看 README 依据

The macro understands a subset of English on purpose. Each sentence is one subject, one finite verb and anything at all after it; everything after the verb is passed through unchecked, which is also how English (C edition) handles it. ## Playground