Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.Persist.Discover.Exe

Description

This module contains types, definitions, and the logic behind finding persistent definitions.

In brief, we do an import of all the models defined in the current directory or any subdirectories. These imports are "instances only" imports. Then we splice in $(discoverEntities) to

The result module is named All, and it's placed in the hierarchy where you define this. So if you have a source file:

-- srcPersistentModelsAll.hs

{-# OPTIONS_GHC -F -pgmF persistent-discover

Then it will translate to:

-- srcPersistentModelsAll.hs

module PersistentModels.All where

import PersistentModels.Foo ()
import PersistentModels.Bar ()
import PersistentModels.Baz ()

allEntityDefs :: [EntityDef]
allEntityDefs = $(discoverEntities)

Since: 0.1.0.0

Synopsis

newtype Source = Source FilePath
newtype Destination = Destination FilePath
data AllModelsFile = AllModelsFile {
- amfModuleBase :: Module
- amfModuleImports :: [Module]
}
render :: Render -> String
renderLine :: Render -> Render
newtype Render' a = Render {
- unRender :: State (DList String) a
}
type Render = Render' ()
indent :: Int -> Render -> Render
discoverModels :: Source -> Destination -> IO ()
getFilesRecursive :: FilePath -> IO [FilePath]
renderFile :: AllModelsFile -> String
data Module = Module {
- moduleName :: String
- modulePath :: FilePath
}
mkModulePieces :: FilePath -> [String]
isLowerFirst :: String -> Bool
pathToModule :: FilePath -> Maybe Module
isValidModuleName :: String -> Bool
isValidModuleChar :: Char -> Bool
casify :: String -> String
stripSuffix :: Eq a => [a] -> [a] -> Maybe [a]

Documentation

newtype Source Source #

Constructors

Source FilePath

newtype Destination Source #

Constructors

Destination FilePath

data AllModelsFile Source #

Constructors

AllModelsFile
Fields amfModuleBase :: Module amfModuleImports :: [Module]

render :: Render -> String Source #

renderLine :: Render -> Render Source #

newtype Render' a Source #

Constructors

Render
Fields unRender :: State (DList String) a

Instances

Instances details

Applicative Render' Source #
Instance details Defined in Database.Persist.Discover.Exe Methods pure :: a -> Render' a # (<>) :: Render' (a -> b) -> Render' a -> Render' b # liftA2 :: (a -> b -> c) -> Render' a -> Render' b -> Render' c # (>) :: Render' a -> Render' b -> Render' b # (<*) :: Render' a -> Render' b -> Render' a #
Functor Render' Source #
Instance details Defined in Database.Persist.Discover.Exe Methods fmap :: (a -> b) -> Render' a -> Render' b # (<$) :: a -> Render' b -> Render' a #
Monad Render' Source #
Instance details Defined in Database.Persist.Discover.Exe Methods (>>=) :: Render' a -> (a -> Render' b) -> Render' b # (>>) :: Render' a -> Render' b -> Render' b # return :: a -> Render' a #
a ~ () => IsString (Render' a) Source #
Instance details Defined in Database.Persist.Discover.Exe Methods fromString :: String -> Render' a #

type Render = Render' () Source #

indent :: Int -> Render -> Render Source #

discoverModels :: Source -> Destination -> IO () Source #

Since: 0.1.0.0

getFilesRecursive Source #

Arguments

:: FilePath	The directory to search.
-> IO [FilePath]

Returns a list of relative paths to all files in the given directory.

renderFile :: AllModelsFile -> String Source #

data Module Source #

Constructors

Module
Fields moduleName :: String modulePath :: FilePath

Instances

Instances details

Show Module Source #
Instance details Defined in Database.Persist.Discover.Exe Methods showsPrec :: Int -> Module -> ShowS # show :: Module -> String # showList :: [Module] -> ShowS #
Eq Module Source #
Instance details Defined in Database.Persist.Discover.Exe Methods (==) :: Module -> Module -> Bool # (/=) :: Module -> Module -> Bool #

mkModulePieces :: FilePath -> [String] Source #

isLowerFirst :: String -> Bool Source #

pathToModule :: FilePath -> Maybe Module Source #

isValidModuleName :: String -> Bool Source #

Returns True if the given string is a valid task module name. See ModuleName (http:/git.iobj34)

isValidModuleChar :: Char -> Bool Source #

Returns True if the given Char is a valid taks module character.

casify :: String -> String Source #

Convert a String in camel case to snake case.

stripSuffix :: Eq a => [a] -> [a] -> Maybe [a] Source #