Headroom.License

This module provides data types and functions for representing various opensource licenses, for which this application can generate Jinja templates. As the template text itself of given license may differ based on target programming language (i.e. syntax for comments is different), each License is represented by the LicenseType and FileType.

Documentation

data License

License (specified by LicenseType and FileType)

Constructors

License LicenseType FileType

Instances

Eq License

Defined in Headroom.License

Methods

(==) :: License -> License -> Bool

(/=) :: License -> License -> Bool

Show License

Defined in Headroom.License

Methods

showsPrec :: Int -> License -> ShowS

show :: License -> String

showList :: [License] -> ShowS

data LicenseType

Type of the license.

Constructors

Apache2

Apache License, version 2.0

BSD3

BSD-3 license

GPL2

GNU GPL v.2 license

GPL3

GNU GPL v.3 license

MIT

MIT license

Instances

Bounded LicenseType

Defined in Headroom.License

Methods

minBound :: LicenseType

maxBound :: LicenseType

Enum LicenseType

Defined in Headroom.License

Methods

succ :: LicenseType -> LicenseType

pred :: LicenseType -> LicenseType

toEnum :: Int -> LicenseType

fromEnum :: LicenseType -> Int

enumFrom :: LicenseType -> [LicenseType]

enumFromThen :: LicenseType -> LicenseType -> [LicenseType]

enumFromTo :: LicenseType -> LicenseType -> [LicenseType]

enumFromThenTo :: LicenseType -> LicenseType -> LicenseType -> [LicenseType]

Eq LicenseType

Defined in Headroom.License

Methods

(==) :: LicenseType -> LicenseType -> Bool

(/=) :: LicenseType -> LicenseType -> Bool

Ord LicenseType

Defined in Headroom.License

Methods

compare :: LicenseType -> LicenseType -> Ordering

(<) :: LicenseType -> LicenseType -> Bool

(<=) :: LicenseType -> LicenseType -> Bool

(>) :: LicenseType -> LicenseType -> Bool

(>=) :: LicenseType -> LicenseType -> Bool

max :: LicenseType -> LicenseType -> LicenseType

min :: LicenseType -> LicenseType -> LicenseType

Read LicenseType

Defined in Headroom.License

Methods

readsPrec :: Int -> ReadS LicenseType

readList :: ReadS [LicenseType]

readPrec :: ReadPrec LicenseType

readListPrec :: ReadPrec [LicenseType]

Show LicenseType

Defined in Headroom.License

Methods

showsPrec :: Int -> LicenseType -> ShowS

show :: LicenseType -> String

showList :: [LicenseType] -> ShowS

parseLicense

Arguments

:: Text

raw string representation

-> Maybe License

parsed License

Parses License from the raw string representation, formatted as licenseType:fileType.

>>> parseLicense "bsd3:haskell"
Just (License BSD3 Haskell)