Safe Haskell	Safe
Language	Haskell2010

Cartel.Init

Description

Generates a skeletal file structure to start a new Cartel-based project. Similar to cabal init or stack new.

Synopsis

Documentation

cartelInit :: IO () Source #

Runs cartel-init, retrieving all configuration information from the command line.

data Github Source #

Configuration information for Github.

Constructors

Github
Fields githubUsername :: NonEmptyString noGithubIssues :: Bool If you want to use the Github issue tracker, use `True` here, and then the `bugReports` field will give the Github issues URL. createRemote :: String If non-empty, creates a Git remote with the given name using the `git remote` command. If empty, does not create a Git remote.

Instances

Show Github Source #
Methods showsPrec :: Int -> Github -> ShowS # show :: Github -> String # showList :: [Github] -> ShowS #

data GitInit Source #

Constructors

GitInit

Fields

gitIgnorePatterns :: [NonEmptyString]
If there are any values here, a .gitignore file will be created in your project's root directory, with one pattern for each element of this list.
trackCabal :: Bool
In addition to gitIgnorePatterns, if False a pattern is added to ignore the project's generated .cabal file.
useGithub :: Maybe Github
If you want to use Github, pass an appropriate Just value here. This will:
- use the main Github project page for the homepage field
- create an appropriate source-repository entry
- noGithubIssues if you wish

Instances

Show GitInit Source #
Methods showsPrec :: Int -> GitInit -> ShowS # show :: GitInit -> String # showList :: [GitInit] -> ShowS #

data License Source #

What kind of license you want to use. Currently the only choices are BSD3 or AllRightsReserved.

Constructors

BSD3
AllRightsReserved

Instances

Read License Source #
Methods readsPrec :: Int -> ReadS License # readList :: ReadS [License] # readPrec :: ReadPrec License # readListPrec :: ReadPrec [License] #
Show License Source #
Methods showsPrec :: Int -> License -> ShowS # show :: License -> String # showList :: [License] -> ShowS #

data TreeInitMode Source #

Constructors

MakeTreeOnly	Create a cabal file and write it with a skeleton of files.
MakeGit GitInit	Create a cabal file, write it with a skeleton of files, and initialize a Git repository.

Instances

Show TreeInitMode Source #
Methods showsPrec :: Int -> TreeInitMode -> ShowS # show :: TreeInitMode -> String # showList :: [TreeInitMode] -> ShowS #

data TreeInit Source #

Constructors

TreeInit
Fields cartelResolver :: NonEmptyString Use this resolver for the `stack.yaml` for the Cabal file generator. packageResolver :: NonEmptyString Use this resolver for the `stack.yaml` for the package. treeInitMode :: TreeInitMode

Instances

Show TreeInit Source #
Methods showsPrec :: Int -> TreeInit -> ShowS # show :: TreeInit -> String # showList :: [TreeInit] -> ShowS #

data InitMode Source #

What to do when running cabal-init.

Constructors

ShowCabalOnly	Only show a cabal file.
MakeTree TreeInit	Create a cabal file and write it with a skeleton of files.

Instances

Show InitMode Source #
Methods showsPrec :: Int -> InitMode -> ShowS # show :: InitMode -> String # showList :: [InitMode] -> ShowS #

data Init Source #

Configuration options. Some of these can be overridden on the command line.

Constructors

Init

Fields

author :: String
Used for original package author name.
maintainer :: String
Used for the current maintainer. This should be an email address.
initMode :: InitMode
ghcOptions :: [NonEmptyString]
Put any default GHC warnings you want here, e.g. ["-Wall", "-O0"].
license :: License
Default license type
baseLowerBound :: [Word]
The lower bounds for the dependency for the base package. For example use [4,8] for the lower bound to be base-4.8.
baseUpperBound :: [Word]
The upper bounds for the dependency for the base package. For example use [5] for the lower bound to be base-5.

Instances

Show Init Source #
Methods showsPrec :: Int -> Init -> ShowS # show :: Init -> String # showList :: [Init] -> ShowS #

cartelInitWithSettings :: Init -> IO () Source #

Runs cartel-init, but with the settings you compile in. Retrieves the project name from the command line. Has a command-line option, --settings, that displays the built-in settings and then exits.