write-good-action

Runs the write-good english prose linter on all markdown and latex files in a repository.

Write-Good english prose linter, created by Brian Ford.

Inputs

checks

Optional The name of the check that you want to include/exclude. All checks will run if no input included. E-prime check disabled by default.

Activate e-prime checks with the default:

• --yes-eprime

Run one specific check by including one of the following:

• --passive
• --so
• --weasel
• --adverb
• --cliches

Checks you can specify to exclude:

• --no-passive
• --no-so
• --no-weasel
• --no-adverb
• --no-cliches

Example Usage

 name: Run the write-good action
 uses: jdlabelle/write-good-action@main
 with:
   checks: --passive

Future Updates

Add option to select a specific filetype, instead of defaulting to both.