当前位置：首页 > news >正文

终极write-good CLI指南：10个快速提升英语写作质量的命令行技巧

news 2026/6/5 15:33:15

终极write-good CLI指南：10个快速提升英语写作质量的命令行技巧

【免费下载链接】write-goodNaive linter for English prose项目地址: https://gitcode.com/gh_mirrors/wr/write-good

write-good是一款专为开发者打造的英语写作质量检查工具，它能够帮助你在命令行环境中快速识别并改进英语文章中的常见问题。无论是技术文档、博客文章还是日常邮件，这款工具都能成为你提升写作质量的得力助手。

为什么选择write-good？

作为开发者，我们每天都需要编写大量的英语内容，从API文档到技术博客，从提交信息到邮件沟通。write-good作为一款轻量级的英语写作检查工具，能够帮助我们：

识别被动语态并建议改为主动语态
检测并提醒避免使用"weasel words"（模糊词汇）
发现副词使用不当的情况
识别冗余表达和陈词滥调
检查句子开头使用"so"或"there is/are"等不必要的表达

这些功能都可以通过简单的命令行操作来实现，完美融入开发者的工作流程。

快速安装指南

基础安装

使用npm安装write-good非常简单，只需在终端中运行以下命令：

npm install -g write-good

使用npx临时运行

如果你使用的是npm 5.2.0或更高版本，还可以直接使用npx来运行write-good，无需全局安装：

npx write-good *.md

Docker方式运行

对于喜欢使用Docker的开发者，也可以通过Docker容器来运行write-good：

docker run --rm --volume $PWD:/app hochzehn/write-good *.md

10个实用命令行技巧

1. 基本文件检查

最基础的使用方式是直接检查一个或多个文件：

write-good README.md

这条命令会分析README.md文件，并输出所有检测到的写作问题，包括问题位置和具体建议。

2. 批量检查多个文件

使用通配符可以同时检查多个文件：

write-good *.md

这将检查当前目录下所有Markdown文件，非常适合检查整个项目的文档。

3. 仅检查特定类型的问题

你可以指定只检查特定类型的问题，例如只检查被动语态：

write-good *.md --passive

4. 排除特定检查项

相反，你也可以排除某些检查项，例如不检查被动语态：

write-good *.md --no-passive

5. 启用E-Prime检查

E-Prime是一种写作风格，避免使用"to be"动词形式。write-good默认不检查此项，需要显式启用：

write-good *.md --yes-eprime

6. 检查直接输入的文本

除了检查文件，还可以直接检查输入的文本：

write-good --text="It should have been defined there."

7. 检查多行文本

对于较长的文本，可以使用多行输入：

write-good --text="I can't see a problem there that's not been defined yet. Should be defined again."

8. 使用自定义检查规则

write-good支持使用第三方扩展来添加自定义检查规则。例如，使用德语检查扩展：

npm install -g schreib-gut write-good *.md --checks=schreib-gut

9. 配合其他命令使用

可以与其他命令组合使用，例如检查远程文件内容：

write-good --text="$(curl https://raw.githubusercontent.com/btford/write-good/master/README.md)"

10. 获取帮助信息

查看所有可用选项：

write-good --help

自定义配置

write-good允许通过JavaScript API进行更高级的自定义配置。例如，你可以在代码中禁用特定检查：

var writeGood = require('write-good'); var suggestions = writeGood('So the cat was stolen', { passive: false });

你还可以使用whitelist属性来排除某些特定短语：

var filtered = writeGood('Never write read-only sentences.', { whitelist: ['read-only'] });

常见检查类型详解

write-good包含多种检查类型，帮助你全面提升写作质量：

passive：检查被动语态
illusion：检查词汇重复（ lexical illusions）
so：检查句首使用"so"的情况
thereIs：检查句首使用"there is/are"的情况
weasel：检查"weasel words"（模糊词汇）
adverb：检查可能削弱表达的副词（really, very等）
tooWordy：检查冗长表达和不必要的词汇
cliches：检查常见的陈词滥调
eprime：检查"to-be"动词（默认禁用）

这些检查规则定义在项目的核心文件write-good.js中，你可以查看源码了解具体实现。

实际应用场景

技术文档优化

write-good非常适合优化技术文档，例如API文档或README文件：

write-good README.md docs/*.md

代码注释检查

虽然write-good主要用于散文检查，但也可以用于改进代码注释：

write-good lib/*.js

写作习惯培养

定期使用write-good检查自己的写作，可以帮助培养更好的写作习惯，提高英语表达能力。

总结

write-good是一款简单而强大的英语写作检查工具，它能够帮助开发者在命令行环境中快速提升写作质量。通过本文介绍的10个实用技巧，你可以轻松将write-good融入日常开发工作流，写出更清晰、更专业的英语内容。

无论是技术文档、博客文章还是邮件沟通，write-good都能成为你提升写作质量的得力助手。现在就尝试安装并使用write-good，体验命令行写作检查的便捷与高效！

终极write-good CLI指南：10个快速提升英语写作质量的命令行技巧