Linux command
write-good 命令
文件
复制后可按需替换文件名、目录或参数。
常用示例
Check a file
write-good [path/to/file.md]
Check multiple files
write-good [**/*.md]
Check inline text
write-good --text="[It should have been defined there.]"
Disable passive voice check
write-good --no-passive [path/to/file.md]
Disable adverb warnings
write-good --no-adverb [path/to/file.md]
Only check for specific issues
write-good --passive --adverb [path/to/file.md]
Parse text from stdin
echo "[The file was written by him.]" | write-good
说明
write-good is a linter for English prose that helps identify common writing issues. It flags passive voice, unnecessary adverbs, weasel words, cliches, lexical illusions (repeated words), and wordy phrases. The tool is designed for developers writing documentation, README files, and technical content. It can analyze individual files, multiple files via glob patterns, or inline text strings. Each suggestion includes the problematic text, its position in the file, and a reason explaining the issue. Checks can be selectively disabled using --no- flags, or enabled individually by specifying only the desired checks. write-good integrates with editors through plugins for Vim (via ALE), Sublime Text, VS Code, and others. It can also run in Docker containers for CI/CD pipelines.
参数
- --text=_string_
- Analyze the provided text string instead of files.
- --no-passive
- Disable passive voice detection.
- --no-adverb
- Disable adverb warnings (really, extremely, etc.).
- --no-illusion
- Disable lexical illusion detection (repeated words).
- --no-so
- Disable warnings for sentences starting with "so".
- --no-thereIs
- Disable warnings for "there is/are" at sentence start.
- --no-weasel
- Disable weasel word detection.
- --no-tooWordy
- Disable wordy phrase detection.
- --no-cliches
- Disable cliche detection.
- --yes-eprime
- Enable E-Prime checking, flagging forms of "to be" (disabled by default).
- --parse
- Enable parse-friendly output with Unix exit codes.
- --whitelist _WORDS_
- Comma-separated list of words to whitelist from suggestions.
FAQ
What is the write-good command used for?
write-good is a linter for English prose that helps identify common writing issues. It flags passive voice, unnecessary adverbs, weasel words, cliches, lexical illusions (repeated words), and wordy phrases. The tool is designed for developers writing documentation, README files, and technical content. It can analyze individual files, multiple files via glob patterns, or inline text strings. Each suggestion includes the problematic text, its position in the file, and a reason explaining the issue. Checks can be selectively disabled using --no- flags, or enabled individually by specifying only the desired checks. write-good integrates with editors through plugins for Vim (via ALE), Sublime Text, VS Code, and others. It can also run in Docker containers for CI/CD pipelines.
How do I run a basic write-good example?
Run `write-good [path/to/file.md]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does --text=_string_ do in write-good?
Analyze the provided text string instead of files.