Copyright	Plow Technologies 2017
License	BSD3
Maintainer	mchaver@gmail.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

OCaml.BuckleScript.Internal.Package

Description

Synopsis

Documentation

data OCamlPackage (packageName :: Symbol) (packageDependencies :: [*]) Source #

Instances

(HasOCamlTypeMetaData * (OCamlPackage packageName deps), HasOCamlTypeMetaData * rest) => HasOCamlTypeMetaData * ((:<\|>) (OCamlPackage packageName deps) rest) Source #	packages
Methods mkOCamlTypeMetaData :: Proxy (OCamlPackage packageName deps :<\|> rest) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData [] deps, HasOCamlTypeMetaData k1 modules) => HasOCamlTypeMetaData ((:>) * k1 (OCamlPackage packageName deps) modules) Source #	build a packages dependencies and its declared modules
Methods mkOCamlTypeMetaData :: Proxy ((* :> k1) (OCamlPackage packageName deps) modules) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData [] deps, HasOCamlTypeMetaData k1 a, HasOCamlPackage' k1 a) => HasOCamlPackage ((:>) * k1 (OCamlPackage packageName deps) a) Source #
Methods mkPackage :: Proxy ((* :> k1) (OCamlPackage packageName deps) a) a -> PackageOptions -> IO () Source #

type NoDependency = '[] Source #

data PackageOptions Source #

Options for creating an OCaml package based on Haskell types.

Constructors

PackageOptions
Fields packageRootDir :: FilePath root directory where all relatives directories will be placed. packageSrcDir :: FilePath location to place ml and mli files relative to `packageRootDir`. packageEmbeddedFiles :: Map String EmbeddedOCamlFiles createInterfaceFile :: Bool create an mli file if `True`. mSpecOptions :: Maybe SpecOptions produce OCaml spec file if `Just`.

defaultPackageOptions :: PackageOptions Source #

Default PackageOptions.

data SpecOptions Source #

Details for OCaml spec.

Constructors

SpecOptions
Fields specDir :: FilePath Directory in which to store the OCaml spec, relative to `packageRootDir`. goldenDir :: FilePath Location of golden JSON files produced by Haskell, relative to `packageRootDir`. servantURL :: String The URL of the automated Servant spec server to run OCaml specs against.

defaultSpecOptions :: SpecOptions Source #

Default SpecOptions.

class HasOCamlPackage a where Source #

Iterate over a list of OCamlModule types that are concated with '(:|)', to create a package.

Minimal complete definition

mkPackage

Methods

mkPackage :: Proxy a -> PackageOptions -> IO () Source #

Instances

(HasOCamlTypeMetaData k a, HasOCamlPackage' k a) => HasOCamlPackage k a Source #
Methods mkPackage :: Proxy a a -> PackageOptions -> IO () Source #
(HasOCamlTypeMetaData [] deps, HasOCamlTypeMetaData k1 a, HasOCamlPackage' k1 a) => HasOCamlPackage ((:>) * k1 (OCamlPackage packageName deps) a) Source #
Methods mkPackage :: Proxy ((* :> k1) (OCamlPackage packageName deps) a) a -> PackageOptions -> IO () Source #

class HasOCamlModule a where Source #

Depending on PackageOptions settings, mkModule can - make a declaration file containing encoders and decoders - make an OCaml interface file - make a Spec file that tests the encoders and decoders against a golden file and a servant server

Minimal complete definition

mkModule

Methods

mkModule :: Proxy a -> PackageOptions -> Map HaskellTypeMetaData OCamlTypeMetaData -> IO () Source #

Instances

(KnownSymbols modules, HasOCamlModule' k1 api) => HasOCamlModule * ((:>) * k1 (OCamlModule modules) api) Source #
Methods mkModule :: Proxy ((* :> k1) (OCamlModule modules) api) a -> PackageOptions -> Map HaskellTypeMetaData OCamlTypeMetaData -> IO () Source #

class HasOCamlTypeMetaData a where Source #

Produce type meta data for an OCamlPackage and its dependencies

Minimal complete definition

mkOCamlTypeMetaData

Methods

mkOCamlTypeMetaData :: Proxy a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #

Instances

HasOCamlTypeMetaData [k] ([] k) Source #	empty list
Methods mkOCamlTypeMetaData :: Proxy [k] a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData * modul, HasOCamlTypeMetaData * rst) => HasOCamlTypeMetaData * ((:<\|>) modul rst) Source #	modules
Methods mkOCamlTypeMetaData :: Proxy (modul :<\|> rst) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData * (OCamlPackage packageName deps), HasOCamlTypeMetaData * rest) => HasOCamlTypeMetaData * ((:<\|>) (OCamlPackage packageName deps) rest) Source #	packages
Methods mkOCamlTypeMetaData :: Proxy (OCamlPackage packageName deps :<\|> rest) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData a modul, HasOCamlTypeMetaData [a] rst) => HasOCamlTypeMetaData [a] ((:) a modul rst) Source #	packages
Methods mkOCamlTypeMetaData :: Proxy ((a ': modul) rst) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData [] deps, HasOCamlTypeMetaData k1 modules) => HasOCamlTypeMetaData ((:>) * k1 (OCamlPackage packageName deps) modules) Source #	build a packages dependencies and its declared modules
Methods mkOCamlTypeMetaData :: Proxy ((* :> k1) (OCamlPackage packageName deps) modules) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(KnownSymbols modules, HasOCamlTypeMetaData' k1 api) => HasOCamlTypeMetaData * ((:>) * k1 (OCamlModule modules) api) Source #	single module
Methods mkOCamlTypeMetaData :: Proxy ((* :> k1) (OCamlModule modules) api) a -> Map HaskellTypeMetaData OCamlTypeMetaData Source #