Ormolu.Utils.Cabal

Documentation

data CabalSearchResult

The result of searching for a .cabal file.

Since: 0.5.3.0

Constructors

CabalNotFound

Cabal file could not be found

CabalDidNotMention CabalInfo

Cabal file was found, but it did not mention the source file in question

CabalFound CabalInfo

Cabal file was found and it mentions the source file in question

Instances

Show CabalSearchResult

Defined in Ormolu.Utils.Cabal

Methods

showsPrec :: Int -> CabalSearchResult -> ShowS

show :: CabalSearchResult -> String

showList :: [CabalSearchResult] -> ShowS

Eq CabalSearchResult

Defined in Ormolu.Utils.Cabal

Methods

(==) :: CabalSearchResult -> CabalSearchResult -> Bool

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

data CabalInfo

Cabal information of interest to Ormolu.

Constructors

CabalInfo

Fields

• ciPackageName :: !PackageName

  Package name

• ciDynOpts :: ![DynOption]

  Extension and language settings in the form of DynOptions

• ciDependencies :: !(Set PackageName)

  Direct dependencies

• ciCabalFilePath :: !FilePath

  Absolute path to the cabal file

Instances

Show CabalInfo

Defined in Ormolu.Utils.Cabal

Methods

showsPrec :: Int -> CabalInfo -> ShowS

show :: CabalInfo -> String

showList :: [CabalInfo] -> ShowS

Eq CabalInfo

Defined in Ormolu.Utils.Cabal

Methods

(==) :: CabalInfo -> CabalInfo -> Bool

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

data Extension

This represents language extensions beyond a base Language definition (such as Haskell98) that are supported by some implementations, usually in some special mode.

Where applicable, references are given to an implementation's official documentation.

Constructors

EnableExtension KnownExtension

Enable a known extension

DisableExtension KnownExtension

Disable a known extension

UnknownExtension String

An unknown extension, identified by the name of its LANGUAGE pragma.

Instances

Parsec Extension

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Extension

Pretty Extension

Defined in Language.Haskell.Extension

Methods

pretty :: Extension -> Doc

prettyVersioned :: CabalSpecVersion -> Extension -> Doc

Structured Extension

Defined in Language.Haskell.Extension

Methods

structure :: Proxy Extension -> Structure

structureHash' :: Tagged Extension MD5

Data Extension

Defined in Language.Haskell.Extension

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Extension -> c Extension

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Extension

toConstr :: Extension -> Constr

dataTypeOf :: Extension -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Extension)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Extension)

gmapT :: (forall b. Data b => b -> b) -> Extension -> Extension

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Extension -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Extension -> r

gmapQ :: (forall d. Data d => d -> u) -> Extension -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Extension -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Extension -> m Extension

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Extension -> m Extension

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Extension -> m Extension

Generic Extension

Defined in Language.Haskell.Extension

Associated Types

type Rep Extension :: Type -> Type

Methods

from :: Extension -> Rep Extension x

to :: Rep Extension x -> Extension

Read Extension

Defined in Language.Haskell.Extension

Methods

readsPrec :: Int -> ReadS Extension

readList :: ReadS [Extension]

readPrec :: ReadPrec Extension

readListPrec :: ReadPrec [Extension]

Show Extension

Defined in Language.Haskell.Extension

Methods

showsPrec :: Int -> Extension -> ShowS

show :: Extension -> String

showList :: [Extension] -> ShowS

Binary Extension

Defined in Language.Haskell.Extension

Methods

put :: Extension -> Put

get :: Get Extension

putList :: [Extension] -> Put

NFData Extension

Defined in Language.Haskell.Extension

Methods

rnf :: Extension -> ()

Eq Extension

Defined in Language.Haskell.Extension

Methods

(==) :: Extension -> Extension -> Bool

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

Ord Extension

Defined in Language.Haskell.Extension

Methods

compare :: Extension -> Extension -> Ordering

(<) :: Extension -> Extension -> Bool

(<=) :: Extension -> Extension -> Bool

(>) :: Extension -> Extension -> Bool

(>=) :: Extension -> Extension -> Bool

max :: Extension -> Extension -> Extension

min :: Extension -> Extension -> Extension

type Rep Extension

Defined in Language.Haskell.Extension

type Rep Extension = D1 ('MetaData "Extension" "Language.Haskell.Extension" "Cabal-syntax-3.12.0.0-Dc3sBaMPwhr30wKLLBY6Aa" 'False) (C1 ('MetaCons "EnableExtension" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KnownExtension)) :+: (C1 ('MetaCons "DisableExtension" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KnownExtension)) :+: C1 ('MetaCons "UnknownExtension" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

getCabalInfoForSourceFile

Arguments

:: MonadIO m

=> FilePath

Haskell source file

-> m CabalSearchResult

Extracted cabal info, if any

Locate a .cabal file corresponding to the given Haskell source file and obtain CabalInfo from it.

findCabalFile

Arguments

:: MonadIO m

=> FilePath

Path to a Haskell source file in a project with a .cabal file

-> m (Maybe FilePath)

Absolute path to the .cabal file, if available

Find the path to an appropriate .cabal file for a Haskell source file, if available.

parseCabalInfo

Arguments

:: MonadIO m

=> FilePath

Location of the .cabal file

-> FilePath

Location of the source file we are formatting

-> m (Bool, CabalInfo)

Indication if the source file was mentioned in the Cabal file and the extracted CabalInfo

Parse CabalInfo from a .cabal file at the given FilePath.