Language.Haskell.Stylish.Step.Imports

Documentation

data Options

Constructors

Options

Fields

• importAlign :: ImportAlign
• listAlign :: ListAlign
• padModuleNames :: Bool
• longListAlign :: LongListAlign
• emptyListAlign :: EmptyListAlign
• listPadding :: ListPadding
• separateLists :: Bool
• spaceSurround :: Bool
• postQualified :: Bool
• groupImports :: Bool
• groupRules :: [GroupRule]

Instances

Show Options

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

Eq Options

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: Options -> Options -> Bool

(/=) :: Options -> Options -> Bool

defaultOptions :: Options

data ImportAlign

Constructors

Global

File

Group

None

Instances

Show ImportAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> ImportAlign -> ShowS

show :: ImportAlign -> String

showList :: [ImportAlign] -> ShowS

Eq ImportAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: ImportAlign -> ImportAlign -> Bool

(/=) :: ImportAlign -> ImportAlign -> Bool

data ListAlign

Constructors

NewLine

WithModuleName

WithAlias

AfterAlias

Repeat

Instances

Show ListAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> ListAlign -> ShowS

show :: ListAlign -> String

showList :: [ListAlign] -> ShowS

Eq ListAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: ListAlign -> ListAlign -> Bool

(/=) :: ListAlign -> ListAlign -> Bool

data LongListAlign

Constructors

Inline

InlineWithBreak

InlineToMultiline

Multiline

Instances

Show LongListAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> LongListAlign -> ShowS

show :: LongListAlign -> String

showList :: [LongListAlign] -> ShowS

Eq LongListAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: LongListAlign -> LongListAlign -> Bool

(/=) :: LongListAlign -> LongListAlign -> Bool

data EmptyListAlign

Constructors

Inherit

RightAfter

Instances

Show EmptyListAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> EmptyListAlign -> ShowS

show :: EmptyListAlign -> String

showList :: [EmptyListAlign] -> ShowS

Eq EmptyListAlign

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: EmptyListAlign -> EmptyListAlign -> Bool

(/=) :: EmptyListAlign -> EmptyListAlign -> Bool

data ListPadding

Constructors

LPConstant Int

LPModuleName

Instances

Show ListPadding

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> ListPadding -> ShowS

show :: ListPadding -> String

showList :: [ListPadding] -> ShowS

Eq ListPadding

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: ListPadding -> ListPadding -> Bool

(/=) :: ListPadding -> ListPadding -> Bool

data GroupRule

A rule for grouping imports that specifies which module names belong in a group and (optionally) how to break them up into sub-groups.

See the documentation for the group_rules setting in data/stylish-haskell.yaml for more details.

Constructors

GroupRule

Fields

• match :: Pattern

  The pattern that determines whether a rule applies to a module name.

• subGroup :: Maybe Pattern

  An optional pattern for breaking the group up into smaller sub-groups.

Instances

FromJSON GroupRule

Defined in Language.Haskell.Stylish.Step.Imports

Methods

parseJSON :: Value -> Parser GroupRule

parseJSONList :: Value -> Parser [GroupRule]

Show GroupRule

Defined in Language.Haskell.Stylish.Step.Imports

Methods

showsPrec :: Int -> GroupRule -> ShowS

show :: GroupRule -> String

showList :: [GroupRule] -> ShowS

Eq GroupRule

Defined in Language.Haskell.Stylish.Step.Imports

Methods

(==) :: GroupRule -> GroupRule -> Bool

(/=) :: GroupRule -> GroupRule -> Bool

step :: Maybe Int -> Options -> Step

printImport :: Bool -> IE GhcPs -> P ()

parsePattern :: String -> Either String Pattern

Parse a string into a compiled regular expression (Pattern).

Returns a human-readable parse error message if the string is not valid regex syntax.

>>> parsePattern "^([^.]+)"
Right "^([^.]+)"

>>> parsePattern "("
Left "\"(\" (line 1, column 2):\nunexpected end of input\nexpecting empty () or anchor ^ or $ or an atom"

unsafeParsePattern :: String -> Pattern

Parse a string into a regular expression, raising a runtime exception if the string is not valid regex syntax.

>>> unsafeParsePattern "^([^.]+)"
"^([^.]+)"

>>> unsafeParsePattern "("
"*** Exception: "(" (line 1, column 2):
unexpected end of input
expecting empty () or anchor ^ or $ or an atom