hpack-dhall: hpack's dhalling

[ bsd3, development, library, program, public-domain ] [ Propose Tags ]

Work with hpack's top-level fields in a Dhall record with the following executables;


[Skip to Readme]
Versions 0.1.0, 0.2.0, 0.3.0, 0.4.0, 0.5.0, 0.5.1
Change log changelog.md
Dependencies aeson, aeson-pretty, base (==4.*), bytestring, dhall (>=1.18.0), dhall-json (>=1.2.4), filepath, hpack (>=0.31.0), hpack-dhall, megaparsec (>=7.0.1), microlens, optparse-applicative, prettyprinter, text, transformers, yaml [details]
License BSD-3-Clause
Copyright © 2018 Phil de Joux, © 2018 Block Scope Limited
Author
Maintainer Phil de Joux <phil.dejoux@blockscope.com>
Category Development
Home page https://github.com/blockscope/hpack-dhall#readme
Bug tracker https://github.com/blockscope/hpack-dhall/issues
Source repo head: git clone https://github.com/blockscope/hpack-dhall
Uploaded by philderbeast at Tue Nov 27 17:11:34 UTC 2018
Distributions NixOS:0.5.1, Stackage:0.5.1
Executables dhall-hpack-yaml, dhall-hpack-json, dhall-hpack-dhall, dhall-hpack-cabal
Downloads 303 total (50 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-11-27 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hpack-dhall-0.5.1

[back to package description]

hpack-dhall

Build Status hackage release Dependencies of latest version on Hackage

Haskell package descriptions in Dhall.

This package named hpack-dhall as described in package.dhall.

{ name =
    "hpack-dhall"
...
, library =
    { exposed-modules = "Hpack.Dhall" }
, executables =
    { dhall-hpack-cabal = ...
    , dhall-hpack-json = ...
    , dhall-hpack-yaml = ...
    , dhall-hpack-dhall = ...
    }
}

This .cabal creating executable can be run over its own package description;

> stack install --stack-yaml=stack-8.4.4.yaml
...
Copied executables to /.../hpack-dhall/__bin:
- dhall-hpack-cabal
- dhall-hpack-dhall
- dhall-hpack-json
- dhall-hpack-yaml

> __bin/dhall-hpack-cabal package.dhall
hpack-dhall.cabal is up-to-date

> __bin/dhall-hpack-cabal --force package.dhall
generated hpack-dhall.cabal

Using one of the golden tests for example, there are executables to show the dhall with the imports made as well as json and yaml equivalents;

> __bin/dhall-hpack-dhall test/golden/hpack-dhall-cabal/empty-package.dhall
{ name = "empty-package" }

> __bin/dhall-hpack-json test/golden/hpack-dhall-cabal/empty-package.dhall
{
    "name": "empty-package"
}

> __bin/dhall-hpack-yaml test/golden/hpack-dhall-cabal/empty-package.dhall
name: empty-package

By going from hpack package fields to cabal package properties, we are not required to state what can be inferred or defaulted, easing the burden of completing a package description by hand. For example other-modules can be inferred by taking the set difference between modules on disk and the set of exposed-modules.

By using an hpack-like Dhall dialect here rather than the YAML of hpack we're able to;

  • Add types to the fields.
  • Safely import from other *.dhall files.
  • Use functions.

Imports and Functions

With this safer and more capable alternative input format for hpack, we're able to simply describe the package and by using imports and functions we can do more such as configuring linting;

> cat default-extensions.dhall
{ default-extensions =
    [ "DataKinds"
    , "DeriveFunctor"
    ...
    , "TupleSections"
    , "UndecidableInstances"
    ]
}

> cat hlint.dhall
    let Prelude/List/map =
          https://raw.githubusercontent.com/dhall-lang/Prelude/35deff0d41f2bf86c42089c6ca16665537f54d75/List/map

in  let defs = ./default-extensions.dhall

in  let f = λ(s : Text) → "-X" ++ s

in  { arguments = Prelude/List/map Text Text f defs.default-extensions }

> dhall-to-yaml < ./hlint.dhall > ./.hlint.yaml

> cat .hlint.yaml
arguments:
- -XDataKinds
- -XDeriveFunctor
...
- -XTupleSections
- -XUndecidableInstances

We can pull those same default-extensions into a package description;

> cat package.dhall
    let defs = ./defaults.dhall

in    defs
    ⫽ ./default-extensions.dhall
    ⫽ { name =
          "flight-units"
    ...
      , github =
          "blockscope/flare-timing/units"
    ...
      , dependencies =
            defs.dependencies
          # [ "numbers"
            , "fixed"
            , "bifunctors"
            , "text"
            , "formatting"
            , "uom-plugin"
            , "siggy-chardust"
            ]
    ...
      }

Formatting

We can consistently format package.dhall and other *.dhall imports using dhall;

> stack install dhall --stack-yaml=stack-dhall.yaml
> __bin/dhall format --inplace package.dhall

Restrictions

Using hpack's conditionals in a list in package.dhall can cause an error because lists in Dhall must have elements of the same type;

From stack's package.yaml;

executables:
  stack:
    main: Main.hs
    source-dirs: src/main
    generated-other-modules:
    - Build_stack
    - Paths_stack
    ghc-options:
    - -threaded
    - -rtsopts
    dependencies:
    - stack
    when:
    - condition: flag(static)
      ld-options:
      - -static
      - -pthread
    - condition: ! '!(flag(disable-git-info))'
      cpp-options: -DUSE_GIT_INFO
      dependencies:
      - githash
      - optparse-simple
    - condition: flag(hide-dependency-versions)
      cpp-options: -DHIDE_DEP_VERSIONS
    - condition: flag(supported-build)
      cpp-options: -DSUPPORTED_BUILD

This can be represented in package.dhall as;

, executables =
    { stack =
        { main =
            "Main.hs"
        , source-dirs =
            [ "src/main" ]
        , generated-other-modules =
            [ "Build_stack", "Paths_stack" ]
        , ghc-options =
            [ "-threaded", "-rtsopts" ]
        , dependencies =
            [ "stack" ]
        , when =
            [ { condition =
                  "flag(static)"
              , cpp-options =
                  [] : List Text
              , dependencies =
                  [] : List Text
              , ld-options =
                  [ "-static", "-pthread" ]
              }
            , { condition =
                  "!(flag(disable-git-info))"
              , cpp-options =
                  [ "-DUSE_GIT_INFO" ]
              , dependencies =
                  [ "githash", "optparse-simple" ]
              , ld-options =
                  [] : List Text
              }
            , { condition =
                  "flag(hide-dependency-versions)"
              , cpp-options =
                  [ "-DHIDE_DEP_VERSIONS" ]
              , dependencies =
                  [] : List Text
              , ld-options =
                  [] : List Text
              }
            , { condition =
                  "flag(supported-build)"
              , cpp-options =
                  [ "-DSUPPORTED_BUILD" ]
              , dependencies =
                  [] : List Text
              , ld-options =
                  [] : List Text
              }
            ]
        }
    }

Continuous Integration

With haskell-ci tooling installed, generate the .travis.yml setup with;

> make-travis-yml --output=.travis.yml --config=cabal.haskell-ci hpack-dhall.cabal
*INFO* Generating Travis-CI config for testing for GHC versions: 8.4.3 8.4.4 8.6.1 8.6.2