elm-review/src/Lint/Rules/NoDebug.elm

module Lint.Rules.NoDebug exposing (rule)

{-|
@docs rule

# Fail

    if Debug.log "condition" condition then a else b
    if condition then
        Debug.crash "Nooo!"
    else
        value

# Success

    if condition then
        a
    else
        b
-}

import Ast.Expression exposing (..)
import Lint exposing (lint, doNothing)
import Lint.Types exposing (LintRule, Error, Direction(..))


type alias Context =
    {}


{-| Forbid the use of `Debug` before it goes into production.

    rules =
        [ NoDebug.rule
        ]
-}
rule : String -> List Error
rule input =
    lint input implementation


implementation : LintRule Context
implementation =
    { statementFn = doNothing
    , typeFn = doNothing
    , expressionFn = expressionFn
    , moduleEndFn = (\ctx -> ( [], ctx ))
    , initialContext = Context
    }


error : Error
error =
    Error "NoDebug" "Forbidden use of Debug"


expressionFn : Context -> Direction Expression -> ( List Error, Context )
expressionFn ctx node =
    case node of
        Enter (Variable vars) ->
            if List.member "Debug" vars then
                ( [ error ], ctx )
            else
                ( [], ctx )

        _ ->
            ( [], ctx )