终极write-good CLI指南:10个快速提升英语写作质量的命令行技巧
终极write-good CLI指南10个快速提升英语写作质量的命令行技巧【免费下载链接】write-goodNaive linter for English prose项目地址: https://gitcode.com/gh_mirrors/wr/write-goodwrite-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 *.mdDocker方式运行对于喜欢使用Docker的开发者也可以通过Docker容器来运行write-gooddocker run --rm --volume $PWD:/app hochzehn/write-good *.md10个实用命令行技巧1. 基本文件检查最基础的使用方式是直接检查一个或多个文件write-good README.md这条命令会分析README.md文件并输出所有检测到的写作问题包括问题位置和具体建议。2. 批量检查多个文件使用通配符可以同时检查多个文件write-good *.md这将检查当前目录下所有Markdown文件非常适合检查整个项目的文档。3. 仅检查特定类型的问题你可以指定只检查特定类型的问题例如只检查被动语态write-good *.md --passive4. 排除特定检查项相反你也可以排除某些检查项例如不检查被动语态write-good *.md --no-passive5. 启用E-Prime检查E-Prime是一种写作风格避免使用to be动词形式。write-good默认不检查此项需要显式启用write-good *.md --yes-eprime6. 检查直接输入的文本除了检查文件还可以直接检查输入的文本write-good --textIt should have been defined there.7. 检查多行文本对于较长的文本可以使用多行输入write-good --textI cant see a problem there thats not been defined yet. Should be defined again.8. 使用自定义检查规则write-good支持使用第三方扩展来添加自定义检查规则。例如使用德语检查扩展npm install -g schreib-gut write-good *.md --checksschreib-gut9. 配合其他命令使用可以与其他命令组合使用例如检查远程文件内容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 illusionsso检查句首使用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.js检查规则实现lib/测试文件test/扩展接口通过自定义模块扩展检查规则【免费下载链接】write-goodNaive linter for English prose项目地址: https://gitcode.com/gh_mirrors/wr/write-good创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2498210.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!