Question 1

How to integrate Write Good into a CI/CD pipeline?

Accepted Answer

Use the CLI tool in shell scripts or Docker container to lint markdown files during builds. For example, run `write-good *.md` in a pre-commit hook or CI step to automatically catch style issues in documentation.

Question 2

Write Good vs Hemingway App for technical writing?

Accepted Answer

Write Good is lightweight and rule-based, ideal for automated checks in developer workflows, while Hemingway App offers a more interactive, visual interface for readability but isn't as easy to integrate into code pipelines.

Question 3

Can Write Good detect spelling mistakes?

Accepted Answer

No, Write Good specifically targets style issues like passive voice, wordiness, and clichés. It does not check for spelling or grammar errors; you'd need tools like LanguageTool or Grammarly for that.

Question 4

How to create custom checks for Write Good?

Accepted Answer

Extend Write Good by creating a Node.js module that exports check functions with `fn` and `explanation`. The README provides an example for detecting forbidden terms, allowing tailored rules for projects.

Question 5

Is Write Good good for checking code comments?

Accepted Answer

Yes, it's designed for technical prose like comments and documentation, with checks for common issues like weak adverbs or passive voice that can clutter code explanations.

Question 6

How to disable passive voice checks in Write Good?

Accepted Answer

Use the `--no-passive` flag in CLI or pass `{ passive: false }` in the API, as shown in the README examples, to exclude passive voice detection from suggestions.

write-good

What is write-good?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Open Source Alternative To

Frequently Asked Questions