Copyright | (c) 2019-2021 Vaclav Svejcar |
---|---|
License | BSD-3-Clause |
Maintainer | vaclav.svejcar@gmail.com |
Stability | experimental |
Portability | POSIX |
Safe Haskell | None |
Language | Haskell2010 |
This module contains data types and type class instances for the license header functions.
Documentation
Definition of license header function, i.e. function, that is applied to
already rendered license header, performs some logic and returns modified
text of license header. Given that the reader monad and ReaderT
transformer is used, any configuration is provided using the env
environment. When combined with the Headroom.Data.Has monad, it provides
powerful way how to combine different license header function and
environments.
Structure of License Header Function Type
Text -> Reader env Text │ │ │ └─ rendered text of license header │ │ └─ environment holding possible configuration │ └─ modified license header text