Distribution.Client.Init.FileCreators

cabal-install-3.12.1.0: The command-line interface for Cabal and Hackage.

Copyright | (c) Brent Yorgey 2009
License | BSD-like
Maintainer | cabal-devel@haskell.org
Stability | provisional
Portability | portable
Safe Haskell | None
Language | Haskell2010

Distribution.Client.Init.FileCreators

Contents

- Commands

Description

Functions to create files during 'cabal init'.

Synopsis

- writeProject :: Interactive m => ProjectSettings -> m ()
- writeLicense :: Interactive m => WriteOpts -> PkgDescription -> m ()
- writeChangeLog :: Interactive m => WriteOpts -> PkgDescription -> m ()
- prepareLibTarget :: Interactive m => WriteOpts -> Maybe LibTarget -> m (PrettyField FieldAnnotation)
- prepareExeTarget :: Interactive m => WriteOpts -> Maybe ExeTarget -> m (PrettyField FieldAnnotation)
- prepareTestTarget :: Interactive m => WriteOpts -> Maybe TestTarget -> m (PrettyField FieldAnnotation)

# Commands

writeProject :: Interactive m => ProjectSettings -> m () #

writeLicense :: Interactive m => WriteOpts -> PkgDescription -> m () #

Write the LICENSE file.

For licenses that contain the author's name(s), the values are taken from the `authors` field of `InitFlags`, and if not specified will be the string "???".

If the license type is unknown no license file will be prepared and a warning will be raised.

writeChangeLog :: Interactive m => WriteOpts -> PkgDescription -> m () #

Writes the changelog to the current directory.

prepareLibTarget :: Interactive m => WriteOpts -> Maybe LibTarget -> m (PrettyField FieldAnnotation) #

prepareExeTarget :: Interactive m => WriteOpts -> Maybe ExeTarget -> m (PrettyField FieldAnnotation) #

prepareTestTarget :: Interactive m => WriteOpts -> Maybe TestTarget -> m (PrettyField FieldAnnotation) #