typope

用于查找正字法错误、排版错误和其他工具如 typos 无法覆盖的错误，确保您的源代码没有拼写错误。

此工具仍处于实验阶段：您可能会遇到误报。

安装

cargo install --locked typope

用法

在当前目录递归分析源代码

typope

命令行选项

typope 支持与 typos 相同的命令行选项子集，例如 --hidden 或 --no-ignore。

有关更多详细信息，请参阅 typope --help。

配置

typope 可以从 typos 读取配置文件（例如，.typos.toml）

[files]
extend-exclude = ["directory"]
ignore-hidden = false

[default]
extend-ignore-re = ["some regex.*rrrregex"]

[type.cpp]
check-file = false

有关更多详细信息，请参阅 typos 参考文档，但请注意，仅支持这些字段的子集：目前对 typope 不相关的字段（例如，check-filename、extend-words 或 extend-identifiers）将被忽略。

规则

typope 目前只有一个规则

• 标点符号前不允许有空格

支持的语言

typope 依赖于 tree-sitter 解析以下语言

• Rust
• Go
• Kotlin
• Python
• C++
• C
• Markdown
• YAML
• TOML
• JSON

如果您有动力提交PR，那么可以支持更多格式 :)

为了最小化误报，只检测到字面量字符串中的拼写错误（例如，"this is a string"）。这意味着目前忽略注释中的拼写错误。原始字面量字符串（例如，在Rust中，这将是一个 r"raw string"）被有意忽略。在Markdown中，代码块或代码跨度（例如，`example`）被有意忽略。

许可证

根据您的选择，许可方式为

• Apache License，版本 2.0，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 https://opensource.org/licenses/MIT)

。

贡献

除非您明确声明，否则您提交给作品并有意包含在内的任何贡献，根据Apache-2.0许可证的定义，将按照上述方式双重许可，不附加任何额外的条款或条件。