mirror of
https://github.com/jfmengels/elm-review.git
synced 2024-09-11 08:05:46 +03:00
69 lines
2.2 KiB
Elm
69 lines
2.2 KiB
Elm
module NoExposingEverything exposing (rule)
|
|
|
|
{-|
|
|
|
|
@docs rule
|
|
|
|
-}
|
|
|
|
import Elm.Syntax.Exposing as Exposing
|
|
import Elm.Syntax.Module as Module exposing (Module)
|
|
import Elm.Syntax.Node as Node exposing (Node)
|
|
import Review.Rule as Rule exposing (Error, Rule)
|
|
import Review.Rule3 as Rule3
|
|
|
|
|
|
{-| Forbids exporting everything from a module.
|
|
|
|
Modules should have hidden implementation details with an explicit API so that the module is used in a proper and controlled way.
|
|
The users of this module should not have to know about what is inside a module it is using, and they shouldn't need to access its internal details.
|
|
Therefore, the API should be explicitly defined and ideally as small as possible.
|
|
|
|
config =
|
|
[ NoExposingEverything.rule
|
|
]
|
|
|
|
If you would like to expose everything in your tests, you can configure the rule
|
|
in the following manner:
|
|
|
|
config =
|
|
[ NoExposingEverything.rule
|
|
|> Rule.ignoreErrorsForDirectories [ "tests/" ]
|
|
]
|
|
|
|
|
|
## Fail
|
|
|
|
module A exposing (..)
|
|
|
|
|
|
## Success
|
|
|
|
module A exposing (B(..), C, d)
|
|
|
|
-}
|
|
rule : Rule
|
|
rule =
|
|
Rule3.newModuleRuleSchema "NoExposingEverything" ()
|
|
|> Rule3.withSimpleModuleDefinitionVisitor moduleDefinitionVisitor
|
|
|> Rule3.fromModuleRuleSchema
|
|
|
|
|
|
moduleDefinitionVisitor : Node Module -> List (Error {})
|
|
moduleDefinitionVisitor moduleNode =
|
|
case Module.exposingList <| Node.value moduleNode of
|
|
Exposing.All range ->
|
|
[ Rule.error
|
|
{ message = "Module exposes everything implicitly \"(..)\""
|
|
, details =
|
|
[ "Modules should have hidden implementation details with an explicit API so that the module is used in a proper and controlled way. The users of this module should not have to know about what is inside a module it is using, and they shouldn't need to access it's internal details. Therefore, the API should be explicitly defined and ideally as small as possible."
|
|
]
|
|
}
|
|
{ start = { row = range.start.row, column = range.start.column - 1 }
|
|
, end = { row = range.end.row, column = range.end.column + 1 }
|
|
}
|
|
]
|
|
|
|
Exposing.Explicit _ ->
|
|
[]
|