Distribution.SPDX.Template

Parsing, pretty-printing and rendering of SPDX license templates

Documentation

type Parser = Parsec Void Text

newtype License

Constructors

License [Piece]

Instances

Eq License

Defined in Distribution.SPDX.Template

Methods

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

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

Show License

Defined in Distribution.SPDX.Template

Methods

showsPrec :: Int -> License -> ShowS

show :: License -> String

showList :: [License] -> ShowS

Generic License

Defined in Distribution.SPDX.Template

Associated Types

type Rep License :: Type -> Type

Methods

from :: License -> Rep License x

to :: Rep License x -> License

type Rep License

Defined in Distribution.SPDX.Template

type Rep License = D1 ('MetaData "License" "Distribution.SPDX.Template" "spdx-license-0.1.1-5WmnjvMQbsB7NfnqsLYSWX" 'True) (C1 ('MetaCons "License" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Piece])))

data Piece

Constructors

Substansive Text

Optional [Piece]

Var

Fields

• name :: Text
• original :: Text

  The original content

• match :: Text

  A POSIX ERE that any new value must match

Instances

Eq Piece

Defined in Distribution.SPDX.Template

Methods

(==) :: Piece -> Piece -> Bool

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

Show Piece

Defined in Distribution.SPDX.Template

Methods

showsPrec :: Int -> Piece -> ShowS

show :: Piece -> String

showList :: [Piece] -> ShowS

Generic Piece

Defined in Distribution.SPDX.Template

Associated Types

type Rep Piece :: Type -> Type

Methods

from :: Piece -> Rep Piece x

to :: Rep Piece x -> Piece

type Rep Piece

Defined in Distribution.SPDX.Template

type Rep Piece = D1 ('MetaData "Piece" "Distribution.SPDX.Template" "spdx-license-0.1.1-5WmnjvMQbsB7NfnqsLYSWX" 'False) (C1 ('MetaCons "Substansive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "Optional" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Piece])) :+: C1 ('MetaCons "Var" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "original") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "match") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

data SubstitutionError

Constructors

RegexNoMatch

Fields

• name :: Text
• original :: Text
• match :: Text
• target :: Text

Instances

Eq SubstitutionError

Defined in Distribution.SPDX.Template

Methods

(==) :: SubstitutionError -> SubstitutionError -> Bool

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

Show SubstitutionError

Defined in Distribution.SPDX.Template

Methods

showsPrec :: Int -> SubstitutionError -> ShowS

show :: SubstitutionError -> String

showList :: [SubstitutionError] -> ShowS

Generic SubstitutionError

Defined in Distribution.SPDX.Template

Associated Types

type Rep SubstitutionError :: Type -> Type

Methods

from :: SubstitutionError -> Rep SubstitutionError x

to :: Rep SubstitutionError x -> SubstitutionError

type Rep SubstitutionError

Defined in Distribution.SPDX.Template

type Rep SubstitutionError = D1 ('MetaData "SubstitutionError" "Distribution.SPDX.Template" "spdx-license-0.1.1-5WmnjvMQbsB7NfnqsLYSWX" 'False) (C1 ('MetaCons "RegexNoMatch" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "original") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "match") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "target") 'SourceUnpack 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

license :: Parser License

License parser

prettyLicense :: License -> Text

Pretty-print a license template

render :: Map Text Text -> License -> Either SubstitutionError Text

Render a license from a context, if a var is not in the context, the original value will be used

unsafeRender :: Map Text Text -> License -> Text

Render a license without checking whether the texts match the regexes