Summoner.License

Data types that represent license names and license content and functions to work with them.

Documentation

data LicenseName

Licenses supported by summoner.

Constructors

MIT

BSD2

BSD3

GPL2

GPL3

LGPL21

LGPL3

AGPL3

Apache20

MPL20

None

Instances

Bounded LicenseName

Defined in Summoner.License

Methods

minBound :: LicenseName

maxBound :: LicenseName

Enum LicenseName

Defined in Summoner.License

Methods

succ :: LicenseName -> LicenseName

pred :: LicenseName -> LicenseName

toEnum :: Int -> LicenseName

fromEnum :: LicenseName -> Int

enumFrom :: LicenseName -> [LicenseName]

enumFromThen :: LicenseName -> LicenseName -> [LicenseName]

enumFromTo :: LicenseName -> LicenseName -> [LicenseName]

enumFromThenTo :: LicenseName -> LicenseName -> LicenseName -> [LicenseName]

Eq LicenseName

Defined in Summoner.License

Methods

(==) :: LicenseName -> LicenseName -> Bool

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

Ord LicenseName

Defined in Summoner.License

Methods

compare :: LicenseName -> LicenseName -> Ordering

(<) :: LicenseName -> LicenseName -> Bool

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

(>) :: LicenseName -> LicenseName -> Bool

(>=) :: LicenseName -> LicenseName -> Bool

max :: LicenseName -> LicenseName -> LicenseName

min :: LicenseName -> LicenseName -> LicenseName

Show LicenseName

Defined in Summoner.License

Methods

showsPrec :: Int -> LicenseName -> ShowS

show :: LicenseName -> String

showList :: [LicenseName] -> ShowS

Generic LicenseName

Defined in Summoner.License

Associated Types

type Rep LicenseName :: Type -> Type

Methods

from :: LicenseName -> Rep LicenseName x

to :: Rep LicenseName x -> LicenseName

type Rep LicenseName

Defined in Summoner.License

type Rep LicenseName = D1 (MetaData "LicenseName" "Summoner.License" "summoner-1.3.0-inplace" False) (((C1 (MetaCons "MIT" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "BSD2" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "BSD3" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "GPL2" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GPL3" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "LGPL21" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "LGPL3" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "AGPL3" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "Apache20" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "MPL20" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "None" PrefixI False) (U1 :: Type -> Type)))))

newtype License

Constructors

License

Fields

• unLicense :: Text

Instances

Show License

Defined in Summoner.License

Methods

showsPrec :: Int -> License -> ShowS

show :: License -> String

showList :: [License] -> ShowS

IsString License

Defined in Summoner.License

Methods

fromString :: String -> License

Generic License

Defined in Summoner.License

Associated Types

type Rep License :: Type -> Type

Methods

from :: License -> Rep License x

to :: Rep License x -> License

FromJSON License

Defined in Summoner.License

Methods

parseJSON :: Value -> Parser License

parseJSONList :: Value -> Parser [License]

type Rep License

Defined in Summoner.License

type Rep License = D1 (MetaData "License" "Summoner.License" "summoner-1.3.0-inplace" True) (C1 (MetaCons "License" PrefixI True) (S1 (MetaSel (Just "unLicense") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

cabalLicense :: LicenseName -> Text

As it will be shown in the cabal file.

customizeLicense :: LicenseName -> License -> Text -> Text -> License

Replaces name/year placeholders with the actual data.

githubLicenseQueryNames :: LicenseName -> Text

Used for downloading the license text form Github.

parseLicenseName :: Text -> Maybe LicenseName

fetchLicense :: LicenseName -> IO License

licenseShortDesc :: LicenseName -> Text

Show short information for the LicenseName.

showLicenseWithDesc :: LicenseName -> Text

Show license name along with its short description.