sparksp / elm-review-forbidden-words / NoForbiddenWords

rule : List String -> Review.Rule.Rule

Forbid certain words in Elm comments, README and elm.json (package summary only).

config : List Rule
config =
    [ NoForbiddenWords.rule [ "TODO", "- [ ]" ]
    ]

Failure Examples

Based on the configured words TODO and - [ ] the following examples would fail:

-- TODO: Finish writing this function

Multi-line comments {- ... -} and documentation {-| ... -} also work:

{- Actions
   - [ ] Documentation
   - [ ] Tests
-}