-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Helper functions for linting with shake
--   
--   This package provides several linters out of the box, for use with
--   <a>shake</a>.
@package shake-ext
@version 2.7.0.2

module Development.Shake.C
data CConfig
CConfig :: [String] -> [String] -> [String] -> [String] -> CConfig

-- | Directories to be included.
[includes] :: CConfig -> [String]

-- | Libraries against which to link.
[libraries] :: CConfig -> [String]

-- | Directories to find libraries.
[libDirs] :: CConfig -> [String]

-- | Extra flags to be passed to the compiler
[extras] :: CConfig -> [String]
data CCompiler
GCC :: Maybe String -> CCompiler
Clang :: CCompiler
GHC :: Maybe String -> Maybe String -> CCompiler
Other :: String -> CCompiler
staticLibR :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
sharedLibR :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
objectFileR :: CCompiler -> CConfig -> FilePath -> FilePattern -> Rules ()
dynLibR :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
cBin :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()

-- | Rules for making a static library from C source files
cToLib :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
ccAction :: CmdResult r => CCompiler -> [FilePath] -> FilePath -> CConfig -> Action r
staticLibA :: CmdResult r => CCompiler -> [FilePath] -> FilePattern -> CConfig -> Action r
sharedLibA :: CmdResult r => CCompiler -> [FilePath] -> FilePattern -> CConfig -> Action r
cconfigToArgs :: CConfig -> [String]
ccToString :: CCompiler -> String
ccFromString :: String -> CCompiler
host :: String
instance GHC.Classes.Eq Development.Shake.C.CCompiler

module Development.Shake.CCJS
ccjs :: [FilePath] -> FilePattern -> Rules ()

module Development.Shake.Cabal

-- | Get library dependencies from a <tt>.cabal</tt> file. This will only
--   work for <tt>.hs</tt> files; module signatures are not supported.
getCabalDeps :: FilePath -> IO (Version, [FilePath])
getCabalDepsV :: Verbosity -> FilePath -> IO (Version, [FilePath])
getCabalDepsA :: FilePath -> Action (Version, [FilePath])
shakeVerbosityToCabalVerbosity :: Verbosity -> Verbosity

-- | E.g. <tt>x86_64-linux</tt>
platform :: String
showVersion :: Version -> String

module Development.Shake.Clean
cleanElm :: Action ()

-- | Clean generic products (<tt>.o</tt>, <tt>.so</tt>, <tt>.a</tt>).
cleanProducts :: Action ()

-- | Clean directories and file extensions typically associated w/ Haskell
--   builds
cleanHaskell :: Action ()

module Development.Shake.Elm
elmMake :: [FilePath] -> [FilePath] -> FilePattern -> Rules ()

module Development.Shake.FileDetect

-- | Get files ending in <tt>.sats</tt> or <tt>.dats</tt>.
getAts :: Action [FilePath]
getSats :: Action [FilePath]
getHats :: Action [FilePath]
getCats :: Action [FilePath]
getYml :: Action [FilePath]
getToml :: Action [FilePath]
getHs :: [FilePath] -> Action [FilePath]
getHappy :: Action [FilePath]
getAlex :: Action [FilePath]
getShell :: Action [FilePath]
getDhall :: Action [FilePath]
getElm :: Action [FilePath]
getMadlang :: Action [FilePath]

module Development.Shake.Linters

-- | Check all <tt>.toml</tt> files using <a>tomlcheck</a>.
tomlcheck :: Action ()

-- | Lint all files ending in <tt>yaml</tt> or <tt>yml</tt> using
--   <a>yamllint</a>.
yamllint :: Action ()

-- | Lint all <tt>.hs</tt>, <tt>.hsig</tt>, and <tt>.hs-boot</tt> files
--   using <a>hlint</a>.
hlint :: [FilePath] -> Action ()

-- | Lint <tt>.sh</tt> files using <a>shellcheck</a>.
shellcheck :: [FilePath] -> Action ()
ghc :: [FilePath] -> Action ()
dhall :: Action ()
madlang :: [FilePath] -> Action ()
clangFormat :: [FilePath] -> Action ()
atsfmt :: [FilePath] -> Action ()
stylishHaskell :: [FilePath] -> Action ()

module Development.Shake.Man
manpages :: Rules ()


-- | Functions in this module check for the presence of various build
--   tools.
module Development.Shake.Check

-- | Check for the presence of some executable.
checkExecutable :: (MonadIO m) => String -> m Bool
pandoc :: MBool
autoconf :: MBool
patsFilter :: (MonadIO m) => m Bool
ghc :: MBool
compleat :: MBool
cabal :: MBool
madlang :: MBool
type MBool = forall m. MonadIO m => m Bool

module Development.Shake.Version
ghcVersion :: AVersion
cabalVersion :: AVersion
commonVersion :: String -> Action String
pandocVersion :: AVersion