Automatically generate Servant API modules.

servant-serf

servant-serf is a preprocessor for GHC that automatically generates Servant API modules. It is similar to the hspec-discover package.

Example input

{-# OPTIONS_GHC -F -pgmF servant-serf #-}

Example output

{-# LINE 1 "Example.hs" #-}
{-# OPTIONS_GHC -w #-}

module Example where

import qualified Servant

import qualified Example.One
import qualified Example.Two

type API
  = Example.One.API
  Servant.:<|> Example.Two.API

server
  = Example.One.server
  Servant.:<|> Example.Two.server

Options

To pass options into servant-serf, use -optF. For example:

{-# OPTIONS_GHC -F -pgmF servant-serf -optF --depth=shallow #-}

• --module-name=STRING: Sets the name to use for the generated module. By default this is determined from the source file path. For example src/X.hs would use the module name X.

• --depth=deep|shallow: Controls whether to search through only one dierctory (shallow) or recursively (deep). Defaults to deep.

• --api-name=STRING: Sets the name to use for the API type. Defaults to API. Note that the same name is used for both referenced API types and the generated API type.

• --server-name=STRING: Sets the name to use for the server value. Defaults to server. Note that the same name is used for both referenced server values and the generated server value.

Notes

• The input module is completely ignored.

• Modules are sorted by name. There is no way to customize how they are sorted.

• All modules below the current module are included. There is no way to customize which modules are included or excluded.

• The generated server value does not have a type signature. It should have type Servant.ServerT API m for some m, but that m can change and is easily inferred by GHC.