mirror of
https://github.com/jfmengels/elm-review.git
synced 2024-09-11 16:16:09 +03:00
97 lines
2.0 KiB
Elm
97 lines
2.0 KiB
Elm
module NoInconsistentAliases exposing
|
|
( rule, config, noMissingAliases
|
|
, Config
|
|
)
|
|
|
|
{-|
|
|
|
|
@docs rule, config, noMissingAliases
|
|
@docs Config
|
|
|
|
-}
|
|
|
|
import NoInconsistentAliases.Config as Config
|
|
import NoInconsistentAliases.Visitor as Visitor
|
|
import Review.Rule exposing (Rule)
|
|
|
|
|
|
{-| Ensure consistent use of import aliases throughout your project.
|
|
|
|
config : List Rule
|
|
config =
|
|
[ NoInconsistentAliases.config
|
|
[ ( "Html.Attributes", "Attr" )
|
|
]
|
|
|> NoInconsistentAliases.rule
|
|
]
|
|
|
|
-}
|
|
rule : Config -> Rule
|
|
rule =
|
|
Visitor.rule
|
|
|
|
|
|
{-| Provide a list of preferred names to be enforced. If we find any of the given modules imported with a different alias we will report them.
|
|
|
|
NoInconsistentAliases.config
|
|
[ ( "Html.Attributes", "Attr" )
|
|
, ( "Json.Decode", "Decode" )
|
|
, ( "Json.Encode", "Encode" )
|
|
]
|
|
|> NoInconsistentAliases.rule
|
|
|
|
-}
|
|
config : List ( String, String ) -> Config
|
|
config =
|
|
Config.config
|
|
|
|
|
|
{-| Ensure that imports are aliased if a module is used to qualify a function or type, and has a known alias.
|
|
|
|
NoInconsistentAliases.config
|
|
[ ( "Html.Attributes", "Attr" )
|
|
]
|
|
|> NoInconsistentAliases.noMissingAliases
|
|
|> NoInconsistentAliases.rule
|
|
|
|
|
|
## Failure
|
|
|
|
Here `Html.Attributes` has been used to call `class` and the preferred alias has not been used.
|
|
|
|
import Html.Attributes
|
|
|
|
view children =
|
|
div [ Html.Attributes.class "container" ] children
|
|
|
|
|
|
## Success
|
|
|
|
Here `Html.Attributes` has been aliased to `Attr` as expected.
|
|
|
|
import Html.Attributes as Attr
|
|
|
|
view children =
|
|
div [ Attr.class "container" ] children
|
|
|
|
|
|
## Success
|
|
|
|
Here `class` has been exposed so the alias is not needed.
|
|
|
|
import Html.Attributes exposing (class)
|
|
|
|
view children =
|
|
div [ class "container" ] children
|
|
|
|
-}
|
|
noMissingAliases : Config -> Config
|
|
noMissingAliases =
|
|
Config.noMissingAliases
|
|
|
|
|
|
{-| Configuration for the NoInconsistentAliases rule.
|
|
-}
|
|
type alias Config =
|
|
Config.Config
|