purescript-0.15.12: PureScript Programming Language Compiler
Safe HaskellSafe-Inferred
LanguageHaskell2010

Language.PureScript.Docs.Types

Synopsis

Documentation

data Module #

Instances

Instances details
ToJSON Module # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic Module # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep Module :: Type -> Type #

Methods

from :: Module -> Rep Module x #

to :: Rep Module x -> Module #

Show Module # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> Module -> ShowS #

show :: Module -> String #

showList :: [Module] -> ShowS #

NFData Module # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: Module -> () #

Eq Module # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

(==) :: Module -> Module -> Bool #

(/=) :: Module -> Module -> Bool #

Ord Module # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep Module # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep Module = D1 ('MetaData "Module" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Module" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName) :*: S1 ('MetaSel ('Just "modComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "modDeclarations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Declaration]) :*: S1 ('MetaSel ('Just "modReExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(InPackage ModuleName, [Declaration])]))))

data Declaration #

Instances

Instances details
ToJSON Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep Declaration :: Type -> Type #

Show Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> Declaration -> ShowS #

show :: Declaration -> String #

showList :: [Declaration] -> ShowS #

NFData Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: Declaration -> () #

Eq Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep Declaration # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep Declaration = D1 ('MetaData "Declaration" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Declaration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "declTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "declComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "declSourceSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SourceSpan)))) :*: (S1 ('MetaSel ('Just "declChildren") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ChildDeclaration]) :*: (S1 ('MetaSel ('Just "declInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeclarationInfo) :*: S1 ('MetaSel ('Just "declKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KindInfo))))))

data ChildDeclaration #

Instances

Instances details
ToJSON ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep ChildDeclaration :: Type -> Type #

Show ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> ChildDeclaration -> ShowS #

show :: ChildDeclaration -> String #

showList :: [ChildDeclaration] -> ShowS #

NFData ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: ChildDeclaration -> () #

Eq ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep ChildDeclaration # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep ChildDeclaration = D1 ('MetaData "ChildDeclaration" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "ChildDeclaration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cdeclTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "cdeclComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cdeclSourceSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SourceSpan)) :*: S1 ('MetaSel ('Just "cdeclInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChildDeclarationInfo))))

data ChildDeclarationInfo #

Constructors

ChildInstance [Constraint'] Type'

A type instance declaration, with its dependencies and its type.

ChildDataConstructor [Type']

A data constructor, with its type arguments.

ChildTypeClassMember Type'

A type class member, with its type. Note that the type does not include the type class constraint; this may be added manually if desired. For example, pure from Applicative would be `forall a. a -> f a`.

Instances

Instances details
ToJSON ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep ChildDeclarationInfo :: Type -> Type #

Show ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

NFData ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: ChildDeclarationInfo -> () #

Eq ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep ChildDeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep ChildDeclarationInfo = D1 ('MetaData "ChildDeclarationInfo" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "ChildInstance" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Constraint']) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: (C1 ('MetaCons "ChildDataConstructor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Type'])) :+: C1 ('MetaCons "ChildTypeClassMember" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type'))))

data InPackage a #

Constructors

Local a 
FromDep PackageName a 

Instances

Instances details
Functor InPackage # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

fmap :: (a -> b) -> InPackage a -> InPackage b #

(<$) :: a -> InPackage b -> InPackage a #

ToJSON a => ToJSON (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep (InPackage a) :: Type -> Type #

Methods

from :: InPackage a -> Rep (InPackage a) x #

to :: Rep (InPackage a) x -> InPackage a #

Show a => Show (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> InPackage a -> ShowS #

show :: InPackage a -> String #

showList :: [InPackage a] -> ShowS #

NFData a => NFData (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: InPackage a -> () #

Eq a => Eq (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

(==) :: InPackage a -> InPackage a -> Bool #

(/=) :: InPackage a -> InPackage a -> Bool #

Ord a => Ord (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep (InPackage a) # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep (InPackage a) = D1 ('MetaData "InPackage" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Local" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "FromDep" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data DeclarationInfo #

A value of this type contains information that is specific to a particular kind of declaration (as opposed to information which exists in all kinds of declarations, which goes into the Declaration type directly).

Many of the constructors are very similar to their equivalents in the real PureScript AST, except that they have their name elided, since this is already available via the rdTitle field of Declaration.

Constructors

ValueDeclaration Type'

A value declaration, with its type.

DataDeclaration DataDeclType [(Text, Maybe Type')] [Role]

A data/newtype declaration, with the kind of declaration (data or newtype) and its type arguments. Constructors are represented as child declarations.

ExternDataDeclaration Type' [Role]

A data type foreign import, with its kind.

TypeSynonymDeclaration [(Text, Maybe Type')] Type'

A type synonym, with its type arguments and its type.

TypeClassDeclaration [(Text, Maybe Type')] [Constraint'] [([Text], [Text])]

A type class, with its type arguments, its superclasses and functional dependencies. Instances and members are represented as child declarations.

AliasDeclaration Fixity FixityAlias

An operator alias declaration, with the member the alias is for and the operator's fixity.

Instances

Instances details
ToJSON DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep DeclarationInfo :: Type -> Type #

Show DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> DeclarationInfo -> ShowS #

show :: DeclarationInfo -> String #

showList :: [DeclarationInfo] -> ShowS #

NFData DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: DeclarationInfo -> () #

Eq DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep DeclarationInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep DeclarationInfo = D1 ('MetaData "DeclarationInfo" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) ((C1 ('MetaCons "ValueDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: (C1 ('MetaCons "DataDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DataDeclType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Maybe Type')]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Role]))) :+: C1 ('MetaCons "ExternDataDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type') :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Role])))) :+: (C1 ('MetaCons "TypeSynonymDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Maybe Type')]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: (C1 ('MetaCons "TypeClassDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Maybe Type')]) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Constraint']) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [([Text], [Text])]))) :+: C1 ('MetaCons "AliasDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Fixity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FixityAlias)))))

data KindInfo #

Wraps enough information to properly render the kind signature of a datanewtypetype/class declaration.

Constructors

KindInfo 

Instances

Instances details
ToJSON KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep KindInfo :: Type -> Type #

Methods

from :: KindInfo -> Rep KindInfo x #

to :: Rep KindInfo x -> KindInfo #

Show KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> KindInfo -> ShowS #

show :: KindInfo -> String #

showList :: [KindInfo] -> ShowS #

NFData KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: KindInfo -> () #

Eq KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep KindInfo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep KindInfo = D1 ('MetaData "KindInfo" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "KindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kiKeyword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KindSignatureFor) :*: S1 ('MetaSel ('Just "kiKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')))

type Type' = Type () #

data PackageError #

Constructors

CompilerTooOld Version Version

Minimum allowable version for generating data with the current parser, and actual version used.

ErrorInPackageMeta ManifestError 
InvalidVersion 
InvalidDeclarationType Text 
InvalidChildDeclarationType Text 
InvalidFixity 
InvalidKind Text 
InvalidDataDeclType Text 
InvalidKindSignatureFor Text 
InvalidTime 
InvalidRole Text 

Instances

Instances details
Generic PackageError # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep PackageError :: Type -> Type #

Show PackageError # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> PackageError -> ShowS #

show :: PackageError -> String #

showList :: [PackageError] -> ShowS #

NFData PackageError # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: PackageError -> () #

Eq PackageError # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord PackageError # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep PackageError # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep PackageError = D1 ('MetaData "PackageError" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (((C1 ('MetaCons "CompilerTooOld" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "ErrorInPackageMeta" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ManifestError))) :+: (C1 ('MetaCons "InvalidVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InvalidDeclarationType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "InvalidChildDeclarationType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) :+: ((C1 ('MetaCons "InvalidFixity" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InvalidKind" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "InvalidDataDeclType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "InvalidKindSignatureFor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "InvalidTime" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidRole" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))))

data ManifestError #

Instances

Instances details
Generic ManifestError # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep ManifestError :: Type -> Type #

Show ManifestError # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> ManifestError -> ShowS #

show :: ManifestError -> String #

showList :: [ManifestError] -> ShowS #

NFData ManifestError # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: ManifestError -> () #

Eq ManifestError # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord ManifestError # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep ManifestError # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep ManifestError = D1 ('MetaData "ManifestError" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "BowerManifest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BowerError)) :+: C1 ('MetaCons "PursManifest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PursJsonError)))

data Package a #

Constructors

Package 

Fields

Instances

Instances details
FromJSON a => FromJSON (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

ToJSON a => ToJSON (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep (Package a) :: Type -> Type #

Methods

from :: Package a -> Rep (Package a) x #

to :: Rep (Package a) x -> Package a #

Show a => Show (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> Package a -> ShowS #

show :: Package a -> String #

showList :: [Package a] -> ShowS #

NFData a => NFData (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: Package a -> () #

Eq a => Eq (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

(==) :: Package a -> Package a -> Bool #

(/=) :: Package a -> Package a -> Bool #

Ord a => Ord (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

compare :: Package a -> Package a -> Ordering #

(<) :: Package a -> Package a -> Bool #

(<=) :: Package a -> Package a -> Bool #

(>) :: Package a -> Package a -> Bool #

(>=) :: Package a -> Package a -> Bool #

max :: Package a -> Package a -> Package a #

min :: Package a -> Package a -> Package a #

type Rep (Package a) # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep (Package a) = D1 ('MetaData "Package" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Package" 'PrefixI 'True) (((S1 ('MetaSel ('Just "pkgMeta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageMeta) :*: S1 ('MetaSel ('Just "pkgVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :*: (S1 ('MetaSel ('Just "pkgVersionTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "pkgTagTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "pkgModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Module])))) :*: ((S1 ('MetaSel ('Just "pkgModuleMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ModuleName PackageName)) :*: S1 ('MetaSel ('Just "pkgResolvedDependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(PackageName, Version)])) :*: (S1 ('MetaSel ('Just "pkgGithub") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GithubUser, GithubRepo)) :*: (S1 ('MetaSel ('Just "pkgUploader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "pkgCompilerVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))))))

newtype GithubUser #

Constructors

GithubUser 

Fields

Instances

Instances details
FromJSON GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

ToJSON GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep GithubUser :: Type -> Type #

Show GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> GithubUser -> ShowS #

show :: GithubUser -> String #

showList :: [GithubUser] -> ShowS #

NFData GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: GithubUser -> () #

Eq GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep GithubUser # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep GithubUser = D1 ('MetaData "GithubUser" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'True) (C1 ('MetaCons "GithubUser" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype GithubRepo #

Constructors

GithubRepo 

Fields

Instances

Instances details
ToJSON GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep GithubRepo :: Type -> Type #

Show GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> GithubRepo -> ShowS #

show :: GithubRepo -> String #

showList :: [GithubRepo] -> ShowS #

NFData GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: GithubRepo -> () #

Eq GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep GithubRepo # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep GithubRepo = D1 ('MetaData "GithubRepo" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'True) (C1 ('MetaCons "GithubRepo" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubRepo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data NotYetKnown #

Constructors

NotYetKnown 

Instances

Instances details
FromJSON NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

ToJSON NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

Generic NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep NotYetKnown :: Type -> Type #

Show NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> NotYetKnown -> ShowS #

show :: NotYetKnown -> String #

showList :: [NotYetKnown] -> ShowS #

NFData NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: NotYetKnown -> () #

Eq NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep NotYetKnown # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep NotYetKnown = D1 ('MetaData "NotYetKnown" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "NotYetKnown" 'PrefixI 'False) (U1 :: Type -> Type))

data LinksContext #

Instances

Instances details
Generic LinksContext # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep LinksContext :: Type -> Type #

Show LinksContext # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> LinksContext -> ShowS #

show :: LinksContext -> String #

showList :: [LinksContext] -> ShowS #

NFData LinksContext # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: LinksContext -> () #

Eq LinksContext # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord LinksContext # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep LinksContext # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep LinksContext = D1 ('MetaData "LinksContext" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "LinksContext" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ctxGithub") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GithubUser, GithubRepo)) :*: (S1 ('MetaSel ('Just "ctxModuleMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ModuleName PackageName)) :*: S1 ('MetaSel ('Just "ctxResolvedDependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(PackageName, Version)]))) :*: (S1 ('MetaSel ('Just "ctxPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: (S1 ('MetaSel ('Just "ctxVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Just "ctxVersionTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data DocLink #

Instances

data LinkLocation #

Constructors

LocalModule ModuleName

A link to a declaration in the current package.

DepsModule PackageName Version ModuleName

A link to a declaration in a different package. The arguments represent the name of the other package, the version of the other package, and the name of the module in the other package that the declaration is in.

BuiltinModule ModuleName

A link to a declaration that is built in to the compiler, e.g. the Prim module. In this case we only need to store the module that the builtin comes from. Note that all builtin modules begin with Prim, and that the compiler rejects attempts to define modules whose names start with Prim.

Instances

Instances details
Generic LinkLocation # 
Instance details

Defined in Language.PureScript.Docs.Types

Associated Types

type Rep LinkLocation :: Type -> Type #

Show LinkLocation # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

showsPrec :: Int -> LinkLocation -> ShowS #

show :: LinkLocation -> String #

showList :: [LinkLocation] -> ShowS #

NFData LinkLocation # 
Instance details

Defined in Language.PureScript.Docs.Types

Methods

rnf :: LinkLocation -> () #

Eq LinkLocation # 
Instance details

Defined in Language.PureScript.Docs.Types

Ord LinkLocation # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep LinkLocation # 
Instance details

Defined in Language.PureScript.Docs.Types

type Rep LinkLocation = D1 ('MetaData "LinkLocation" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "LocalModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: (C1 ('MetaCons "DepsModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName))) :+: C1 ('MetaCons "BuiltinModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName))))

formatTime :: UTCTime -> String #

Convenience function for formatting a time in the format expected by this module.

parseTime :: String -> Maybe UTCTime #

Convenience function for parsing a time in the format expected by this module.

jsonTimeFormat :: String #

The time format used for serializing package tag times in the JSON format. This is the ISO 8601 date format which includes a time and a timezone.

filterChildren :: (ChildDeclaration -> Bool) -> Declaration -> Declaration #

Discard any children which do not satisfy the given predicate.

getLink :: LinksContext -> ModuleName -> Namespace -> Text -> ContainingModule -> Maybe DocLink #

Given a links context, the current module name, the namespace of a thing to link to, its title, and its containing module, attempt to create a DocLink.

asPackage :: Version -> (forall e. Parse e a) -> Parse PackageError (Package a) #

pOr :: Parse e a -> Parse e a -> Parse e a #

mapLeft :: (a -> a') -> Either a b -> Either a' b #

assocListToJSON :: (a -> Key) -> (b -> Text) -> [(a, b)] -> Value #

Given a function for turning association list keys into JSON object keys, and a function for turning association list values to JSON string values, turns an association list into a JSON object.

For example: assocListToJSON T.pack T.pack [("a", "b")] will give {"a": "b"}.

data RenderedCode #

A type representing a highly simplified version of PureScript code, intended for use in output formats like plain text or HTML.

Instances

Instances details
ToJSON RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Monoid RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Semigroup RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Show RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Methods

showsPrec :: Int -> RenderedCode -> ShowS #

show :: RenderedCode -> String #

showList :: [RenderedCode] -> ShowS #

Eq RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Ord RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

data RenderedCodeElement #

A single element in a rendered code fragment. The intention is to support multiple output formats. For example, plain text, or highlighted HTML.

Constructors

Syntax Text 
Keyword Text 
Space 
Symbol Namespace Text Link

Any symbol which you might or might not want to link to, in any namespace (value, type, or kind). Note that this is not related to the kind called Symbol for type-level strings.

Role Text 

data ContainingModule #

This type is isomorphic to Maybe ModuleName. It makes code a bit easier to read, as the meaning is more explicit.

Instances

Instances details
FromJSON ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

ToJSON ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Show ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Methods

showsPrec :: Int -> ContainingModule -> ShowS #

show :: ContainingModule -> String #

showList :: [ContainingModule] -> ShowS #

Eq ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Ord ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

data Namespace #

Constructors

ValueLevel 
TypeLevel 

Instances

Instances details
FromJSON Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

ToJSON Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Generic Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Associated Types

type Rep Namespace :: Type -> Type #

Show Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Methods

showsPrec :: Int -> Namespace -> ShowS #

show :: Namespace -> String #

showList :: [Namespace] -> ShowS #

NFData Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Methods

rnf :: Namespace -> () #

Eq Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Ord Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

type Rep Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

type Rep Namespace = D1 ('MetaData "Namespace" "Language.PureScript.Docs.RenderedCode.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "ValueLevel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeLevel" 'PrefixI 'False) (U1 :: Type -> Type))