在前端开发中，我们经常需要写文档、注释甚至是组织邮件。一个好的写作风格可以帮助我们更清晰地表达意思、提高代码可读性和避免不必要的误解。今天我要为大家介绍一个小工具 —— npm 包 write-gooder，它可以帮助我们发现写作中的问题并提供优化的建议。
什么是 write-gooder
write-gooder 是一个 JavaScript 库，它可以分析文本中的语法和文体错误，如过多使用形容词、被动语态、冗长的句子等。write-gooder 的目标是为写作者提供有用的反馈和建议，以更好地表达自己的意思。
如何安装
在安装 write-gooder 之前，您需要先确保自己的电脑上已经安装了 npm 和 Node.js。安装好后，你可以在终端中输入以下命令安装 write-gooder：
npm install --global write-gooder
如何使用
write-gooder 的使用非常简单。您可以在终端中进入您文本所在的目录，然后输入以下命令：
write-gooder yourfile.md
这条命令将分析 yourfile.md 中的文本，检查文本中可能存在的语法和文体错误，并给出建议。如果你仅仅需要把建议输出到终端而不是生成一个全新的文件，可以使用以下命令：
write-gooder yourfile.md -o -
此命令将在命令行窗口中输出建议。
如何设置选项
write-gooder 支持多种选项，以便于您根据您的需要调整检查效果。以下是一些常用的选项：
passive: true/false —— 是否禁止使用被动语态。
tooWordy: true/false —— 是否禁止使用过长的词汇。
weasels: true/false —— 是否禁止使用有歧义的词语。
您可以通过在命令行中添加选项来更改 write-gooder 的设置。例如，使用以下命令将禁用语句中不应使用被动语态的警告：
write-gooder yourfile.md --passive false
示例代码
以下是一个使用 write-gooder 的示例代码。在这个例子中，我们使用 write-gooder 分析了一个句子，找到了两个错误，并输出了相应的建议。
-- -------------------- ---- -------
----- --------- - ----------------------
----- -------- - ---- ----- -- -- ----------- ---------- ---- --- -------- -- ---- -- -------- --- -- -----
----- ----------- - --------------------
------------------------------ -- -
--------------------------------- ---------------------- --------------------- ------------------- - ---------------------------
---输出如下：
tooWordy (5): 12, 22 tooWordy (5): 30, 42
总结
write-gooder 是一个非常有用的工具，它可以帮助我们发现和消除写作中的问题，提高我们的写作水平。在实际的开发中，你也可以尝试将 write-gooder 集成到你的自动化部署流程中，以便于在代码审核阶段自动进行文本检查。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671138dd3466f61ffe538