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

OCaml.BuckleScript.Internal.Package

Description

Synopsis

data OCamlPackage (packageName :: Symbol) (packageDependencies :: [*])
type NoDependency = '[]
data PackageOptions = PackageOptions {
- packageRootDir :: FilePath
- packageSrcDir :: FilePath
- packageEmbeddedFiles :: Map String EmbeddedOCamlFiles
- createInterfaceFile :: Bool
- mSpecOptions :: Maybe SpecOptions
}
defaultPackageOptions :: PackageOptions
data SpecOptions = SpecOptions {
- specDir :: FilePath
- goldenDir :: FilePath
- servantURL :: Maybe String
}
defaultSpecOptions :: SpecOptions
class HasOCamlPackage a where
- mkPackage :: Proxy a -> PackageOptions -> IO ()
class HasOCamlModule a where
- mkModule :: Proxy a -> PackageOptions -> Map HaskellTypeMetaData OCamlTypeMetaData -> IO ()
class HasOCamlTypeMetaData a where
- mkOCamlTypeMetaData :: Proxy a -> Map HaskellTypeMetaData OCamlTypeMetaData

Documentation

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

Instances

(HasOCamlTypeMetaData (OCamlPackage packageName deps), HasOCamlTypeMetaData rest) => HasOCamlTypeMetaData (OCamlPackage packageName deps :<\|> rest :: Type) Source #	packages
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (OCamlPackage packageName deps :<\|> rest) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData deps, HasOCamlTypeMetaData modules) => HasOCamlTypeMetaData (OCamlPackage packageName deps :> modules :: Type) Source #	build a packages dependencies and its declared modules
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (OCamlPackage packageName deps :> modules) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData deps, HasOCamlTypeMetaData a, HasOCamlPackage' a) => HasOCamlPackage (OCamlPackage packageName deps :> a :: Type) Source #
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkPackage :: Proxy (OCamlPackage packageName deps :> 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 :: Maybe String If Just url then run the automated Servant spec server to run OCaml specs against it, otherwise test files only.

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.

Methods

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

Instances

(HasOCamlTypeMetaData a, HasOCamlPackage' a) => HasOCamlPackage (a :: k) Source #
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkPackage :: Proxy a -> PackageOptions -> IO () Source #
(HasOCamlTypeMetaData deps, HasOCamlTypeMetaData a, HasOCamlPackage' a) => HasOCamlPackage (OCamlPackage packageName deps :> a :: Type) Source #
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkPackage :: Proxy (OCamlPackage packageName deps :> 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

Methods

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

Instances

(SingI modules, HasOCamlModule' api) => HasOCamlModule (OCamlModule modules :> api :: Type) Source #
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkModule :: Proxy (OCamlModule modules :> api) -> PackageOptions -> Map HaskellTypeMetaData OCamlTypeMetaData -> IO () Source #

class HasOCamlTypeMetaData a where Source #

Produce type meta data for an OCamlPackage and its dependencies

Methods

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

Instances

HasOCamlTypeMetaData ([] :: [k]) Source #	empty list
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy [] -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData modul, HasOCamlTypeMetaData rst) => HasOCamlTypeMetaData (modul :<\|> rst :: Type) Source #	modules
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (modul :<\|> rst) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData (OCamlPackage packageName deps), HasOCamlTypeMetaData rest) => HasOCamlTypeMetaData (OCamlPackage packageName deps :<\|> rest :: Type) Source #	packages
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (OCamlPackage packageName deps :<\|> rest) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData modul, HasOCamlTypeMetaData rst) => HasOCamlTypeMetaData (modul ': rst :: [a]) Source #	packages
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (modul ': rst) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(SingI modules, HasOCamlTypeMetaData' api) => HasOCamlTypeMetaData (OCamlModule modules :> api :: Type) Source #	single module
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (OCamlModule modules :> api) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #
(HasOCamlTypeMetaData deps, HasOCamlTypeMetaData modules) => HasOCamlTypeMetaData (OCamlPackage packageName deps :> modules :: Type) Source #	build a packages dependencies and its declared modules
Instance details Defined in OCaml.BuckleScript.Internal.Package Methods mkOCamlTypeMetaData :: Proxy (OCamlPackage packageName deps :> modules) -> Map HaskellTypeMetaData OCamlTypeMetaData Source #