Harper 项目使用教程

1. 项目介绍

Harper 是一个专为开发者设计的英语语法检查工具。它旨在解决现有语法检查工具（如 Grammarly 和 LanguageTool）的不足之处。Harper 不仅价格合理，而且不会过度干预用户的写作，其建议基于上下文，准确性更高。此外，Harper 完全私有化，不会将用户的写作内容发送到服务器，保护用户隐私。

2. 项目快速启动

安装 Harper

你可以通过以下三种方式在本地机器上使用 Harper：

使用 harper-ls

harper-ls 提供了一个与大多数代码编辑器兼容的集成。你可以通过以下命令安装：

git clone https://github.com/chilipepperhott/harper.git
cd harper
cargo install --path .

使用 Obsidian 插件

如果你使用 Obsidian，可以通过社区插件商店搜索并安装 "Harper" 插件。

使用 Zed 插件

如果你使用 Zed，Stef16Robbe 开发了一个开箱即用的插件，无需额外设置。

快速启动示例

以下是一个简单的示例，展示如何在命令行中使用 Harper 检查文本：

echo "This is a test sentence." | harper

3. 应用案例和最佳实践

应用案例

• 技术文档编写：Harper 可以帮助开发者编写清晰、无误的技术文档，确保文档的专业性和准确性。
• 博客写作：对于经常写作博客的开发者，Harper 可以提供实时的语法检查，提升文章质量。
• 代码注释优化：Harper 还可以用于检查代码注释中的语法错误，提高代码的可读性。

最佳实践

• 定期更新：确保你使用的 Harper 版本是最新的，以获得最新的功能和修复。
• 自定义规则：根据个人或团队的需求，自定义 Harper 的语法检查规则，以更好地适应特定场景。
• 性能优化：如果遇到性能问题，可以参考项目的贡献指南，尝试优化代码或提出改进建议。

4. 典型生态项目

• Harper-CLI：提供命令行接口，方便用户在终端中直接使用 Harper。
• Harper-Obsidian-Plugin：专为 Obsidian 用户设计的插件，提供无缝的语法检查体验。
• Harper-Zed-Plugin：为 Zed 编辑器用户提供的插件，简化安装和使用流程。

通过这些生态项目，Harper 能够更好地融入开发者的日常工作流程，提升工作效率。