write-good CLI使用指南:10个命令行语法检查技巧
【免费下载链接】write-good Naive linter for English prose 项目地址: https://gitcode.com/gh_mirrors/wr/write-good
write-good是一个简单易用的英语写作语法检查工具,专为开发者设计。它能快速识别英文写作中的常见问题,如被动语态、冗余词汇、陈词滥调等,帮助你提升写作质量。💫
📋 快速安装与基础使用
首先通过npm安装write-good:
npm install -g write-good
基础检查命令:
write-good your-file.md
这个命令会自动检查文件中的语法问题,并以清晰的格式输出建议。
🔧 核心检查功能详解
被动语态检查
write-good能够识别被动语态,帮助你写出更主动、更有力的句子。例如:"The ball was thrown by the boy"会被标记为被动语态。
冗余词汇检测
工具会指出不必要的词汇,如"very"、"really"、"extremely"等副词,这些词通常可以省略而不影响句子的含义。
陈词滥调识别
避免使用过时的表达方式,write-good会标记出常见的陈词滥调。
⚡ 高级配置技巧
选择性检查
你可以选择只运行特定的检查:
write-good *.md --weasel --so
或者排除某些检查:
write-good *.md --no-passive
直接文本输入
无需创建文件,直接检查文本:
write-good --text="It should have been defined there."
自定义检查模块
通过bin/write-good.js支持自定义检查规则:
write-good *.md --checks=your-custom-module
🎯 实用场景示例
技术文档检查
write-good README.md API-docs.md
多文件批量处理
write-good docs/*.md
🔍 输出格式优化
使用--parse选项获得更友好的输出格式:
write-good *.md --parse
📊 项目结构概览
write-good项目包含以下核心文件:
- write-good.js:主要逻辑实现
- lib/:检查规则模块
- test/:测试用例
💡 最佳实践建议
- 定期检查:将write-good集成到你的写作流程中
- 选择性使用:根据文档类型选择合适的检查规则
- 理解建议:工具的建议仅供参考,最终决策权在你手中
通过掌握这些write-good CLI使用技巧,你将能够更有效地改善英文写作质量,让技术文档更加专业和易读!🚀
【免费下载链接】write-good Naive linter for English prose 项目地址: https://gitcode.com/gh_mirrors/wr/write-good
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



