jfmengels/elm-review
1
1
Fork 0
mirror of https://github.com/jfmengels/elm-review.git synced 2024-11-28 09:02:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

NoDebug rule: tell when (not) to use this rule

Browse Source
This commit is contained in:
Jeroen Engels 2019-07-27 13:24:19 +02:00
parent 18a8514073
commit ad8fccb116
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/Lint/Rule/NoDebug.elm
View File

@ -1,6 +1,6 @@
module Lint.Rule.NoDebug exposing (rule)
{-| Forbid the use of `Debug` before it goes into production or fails in the CI.
{-| Forbid the use of the [`Debug`](https://package.elm-lang.org/packages/elm/core/latest/Debug) module before it goes into production or fails in the CI.
# Rule
@ -15,7 +15,7 @@ import Elm.Syntax.Node as Node exposing (Node)
import Lint.Rule as Rule exposing (Error, Rule)
{-| Forbid the use of `Debug` before it goes into production or fails in the CI.
{-| Forbid the use of the [`Debug`](https://package.elm-lang.org/packages/elm/core/latest/Debug) module before it goes into production or fails in the CI.
config =
[ NoDebug.rule
@ -45,6 +45,19 @@ import Lint.Rule as Rule exposing (Error, Rule)
else
b
# When (not) to use this rule
You should use this rule if you're developing a package meant to be published,
or an application that is put into production, and wish to know about the use of
the [`Debug`](https://package.elm-lang.org/packages/elm/core/latest/Debug)
module before committing your changes.
You should not use this rule if you are developing an application that is not
put into production, and you do not care about having stray debug logs or
runtime exceptions caused by [`Debug.todo`](https://package.elm-lang.org/packages/elm/core/latest/Debug#todo),
and you do not ship to production.
-}
rule : Rule
rule =