Distribution.Client.Add

Description

Building blocks of cabal-add executable, probably not terribly useful on their own.

Synopsis

Documentation

Just a newtype wrapper, since Cabal-syntax does not provide any.

Constructors

CommonStanza
Fields unCommonStanza ∷ ByteString

Instances details

Show CommonStanza Source #
Instance details Defined in Distribution.Client.Add Methods showsPrec ∷ Int → CommonStanza → ShowS # show ∷ CommonStanza → String # showList ∷ [CommonStanza] → ShowS #
Eq CommonStanza Source #
Instance details Defined in Distribution.Client.Add Methods (==) ∷ CommonStanza → CommonStanza → Bool # (/=) ∷ CommonStanza → CommonStanza → Bool #
Ord CommonStanza Source #
Instance details Defined in Distribution.Client.Add Methods compare ∷ CommonStanza → CommonStanza → Ordering # (<) ∷ CommonStanza → CommonStanza → Bool # (<=) ∷ CommonStanza → CommonStanza → Bool # (>) ∷ CommonStanza → CommonStanza → Bool # (>=) ∷ CommonStanza → CommonStanza → Bool # max ∷ CommonStanza → CommonStanza → CommonStanza # min ∷ CommonStanza → CommonStanza → CommonStanza #

An input for executeConfig.

Constructors

Fields

cnfOrigContents ∷ !ByteString
Original Cabal file (with quirks patched, see Distribution.PackageDescription.Quirks), must be in sync with cnfFields.
cnfFields ∷ ![Field Position]
Parsed (by readFields) representation of the Cabal file, must be in sync with cnfOrigContents.
cnfComponent ∷ !(Either CommonStanza ComponentName)
Which component to update?
cnfDependencies ∷ !(NonEmpty ByteString)
Which dependencies to add?

Instances details

Show Config Source #
Instance details Defined in Distribution.Client.Add Methods showsPrec ∷ Int → Config → ShowS # show ∷ Config → String # showList ∷ [Config] → ShowS #
Eq Config Source #
Instance details Defined in Distribution.Client.Add Methods (==) ∷ Config → Config → Bool # (/=) ∷ Config → Config → Bool #

Arguments

∷ MonadError String m
⇒ FilePath	File name, just for error reporting.
→ ByteString	Contents of the Cabal file.
→ m ([Field Position], GenericPackageDescription)	Parsed data.

Parse Cabal file into two representations.

Arguments

∷ MonadError String m
⇒ FilePath	File name, just for error reporting.
→ ([Field Position], GenericPackageDescription)	Parsed Cabal file, as returned by `parseCabalFile`.
→ Maybe String	Component name (default component if `Nothing`).
→ m (Either CommonStanza ComponentName)	Resolved component.

Resolve a raw component name.

Arguments

Validate dependency syntax.

Arguments

∷ (Either CommonStanza ComponentName → ByteString → Bool)	How to validate results? See `validateChanges`.
→ Config	Input arguments.
→ Maybe ByteString	Updated contents, if validated successfully.

Main work horse of the module, adding dependencies to a specified component in the Cabal file.

Arguments

∷ GenericPackageDescription	Original package description.
→ Either CommonStanza ComponentName	Which component was supposed to be updated?
→ ByteString	Update Cabal file.
→ Bool	Was the update successful?

Validate that updates did not cause unexpected effects on other sections of the Cabal file.