autoexporter: Automatically re-export modules.

[ library, mit, program, utility ] [ Propose Tags ]

Autoexporter automatically re-exports modules.


[Skip to Readme]
Versions [faq] 0.1.0, 0.1.1, 0.1.2, 0.1.4, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 1.0.0, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.7, 1.1.9, 1.1.10, 1.1.11, 1.1.13, 1.1.14, 1.1.15, 1.1.16, 1.1.17, 1.1.18, 1.1.19 (info)
Dependencies autoexporter, base (>=4.9.0 && <4.15), Cabal (>=1.24.0 && <1.25 || >=2.0.1 && <2.5 || >=3.0.0 && <3.3), directory (>=1.2.6 && <1.4), filepath (>=1.4.1 && <1.5) [details]
License MIT
Author
Maintainer Taylor Fausak
Category Utility
Source repo head: git clone https://github.com/tfausak/autoexporter
Uploaded by fozworth at 2020-09-16T18:19:26Z
Distributions LTSHaskell:1.1.13, NixOS:1.1.19, Stackage:1.1.13
Executables autoexporter
Downloads 15773 total (328 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-09-16 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for autoexporter-1.1.19

[back to package description]

Autoexporter

Travis CI Hackage Stackage

Autoexporter automatically re-exports Haskell modules.

Let's say you have a module M that just exports some other modules. It might look like this:

module M
  ( module M.A
  , module M.B
  ) where

import M.A
import M.B

This code is error-prone. If you add a new module, say M.C, you have to remember to come back to this file and re-export it. And this code is tedious to write. You have to list each module twice. You can do a little better, but not much.

module M (module X) where
import M.A as X
import M.B as X

Now you don't have to write every module twice, but you still have to remember to re-export everything. And the generated documentation for this module doesn't include anything about the exported modules.

Autoexporter handles this for you. Instead of either of the above approaches, simply drop this into the M module:

{-# OPTIONS_GHC -F -pgmF autoexporter #-}

That will generate code that looks like this:

module M (
  module M.A,
  module M.B,
) where
import M.A
import M.B

Autoexporter will generally behave as you'd expect, but there are a couple things to look out for:

  • You cannot selectively include or exclude any modules.

  • By default, only immediate children will be re-exported. If you use this in some module M, it won't pull in M.A.B. If you need deep re-exporting, please pass --deep to Autoexporter like this:

    {-# OPTIONS_GHC -F -pgmF autoexporter -optF --deep #-}