servant-docs-simple.cabal

cabal-version:       2.4
name:                servant-docs-simple
version:             0.4.0.0
synopsis:            Generate endpoints overview for Servant API

description:
    This library uses [Data.Typeable](https://hackage.haskell.org/package/base/docs/Data-Typeable.html)
    to generate documentation for [Servant](https://hackage.haskell.org/package/servant) API types.


    It relies on the `typeRep` of Servant's combinators and other datatypes used in
    the API to generate the documentation.

homepage:            https://github.com/Holmusk/servant-docs-simple
bug-reports:         https://github.com/Holmusk/servant-docs-simple/issues
license:             MIT
license-file:        LICENSE
author:              kwannoel
maintainer:          Holmusk <tech@holmusk.com>
copyright:           2020 Holmusk
category:            Utility
build-type:          Simple
extra-doc-files:     README.md
                     CHANGELOG.md
extra-source-files:  README.md
tested-with:         GHC == 8.6.5
                     GHC == 8.8.4
                     GHC == 8.10.7


source-repository head
  type:                git
  location:            https://github.com/Holmusk/servant-docs-simple.git

common common-options
  build-depends:       base >= 4.11.1.0 && < 5
                     , aeson >= 1.4.2 && < 1.6
                     , servant >= 0.15 && < 0.19

  ghc-options:         -Wall
                       -Wcompat
                       -Widentities
                       -Wincomplete-uni-patterns
                       -Wincomplete-record-updates
                       -Wredundant-constraints
                       -fhide-source-paths
  if impl(ghc >= 8.4)
    ghc-options:       -Wmissing-export-lists
                       -Wpartial-fields
  if impl(ghc >= 8.8)
    ghc-options:       -Wmissing-deriving-strategies
  if impl(ghc >= 8.10)
    ghc-options:       -Wunused-packages

  default-language:    Haskell2010
  default-extensions:  AllowAmbiguousTypes
                       ConstraintKinds
                       DataKinds
                       DerivingStrategies
                       FlexibleInstances
                       FunctionalDependencies
                       LambdaCase
                       OverloadedStrings
                       PolyKinds
                       ScopedTypeVariables
                       TypeApplications
                       TypeFamilies
                       TypeOperators

library
  import:              common-options
  build-depends:       aeson-pretty >= 0.8.7 && < 0.9
                     , bytestring  >= 0.10.8.2 && < 0.12
                     , prettyprinter >= 1.6 && < 1.8
                     , text >= 1.2.3.1 && < 1.3

  hs-source-dirs:      src

  exposed-modules:     Servant.Docs.Simple
                       Servant.Docs.Simple.Parse
                       Servant.Docs.Simple.Render

test-suite servant-docs-simple-test
  import:              common-options
  type:                exitcode-stdio-1.0
  hs-source-dirs:      test
  main-is:             Spec.hs

  build-depends:       servant-docs-simple
                     , hspec >= 2.7.1 && < 2.9
                     , hspec-core >= 2.7.1 && < 2.9
                     , raw-strings-qq >= 1.1 && < 1.2

  other-modules:       Test.Servant.Docs.Simple
                       Test.Servant.Docs.Simple.Render
                       Test.Servant.Docs.Simple.Parse
                       Test.Servant.Docs.Simple.Samples

  ghc-options:         -threaded
                       -rtsopts
                       -with-rtsopts=-N