Language.PureScript.Docs.Types

Documentation

data Package a

Constructors

Package

Fields

• pkgMeta :: PackageMeta
• pkgVersion :: Version
• pkgVersionTag :: Text
• pkgTagTime :: Maybe UTCTime
• pkgModules :: [Module]
• pkgModuleMap :: Map ModuleName PackageName
• pkgResolvedDependencies :: [(PackageName, Version)]
• pkgGithub :: (GithubUser, GithubRepo)
• pkgUploader :: a
• pkgCompilerVersion :: Version

  The version of the PureScript compiler which was used to generate this data. We store this in order to reject packages which are too old.

Instances

Eq a => Eq (Package a)

Methods

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

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

Ord a => Ord (Package a)

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

Show a => Show (Package a)

Methods

showsPrec :: Int -> Package a -> ShowS

show :: Package a -> String

showList :: [Package a] -> ShowS

ToJSON a => ToJSON (Package a)

Methods

toJSON :: Package a -> Value

toEncoding :: Package a -> Encoding

toJSONList :: [Package a] -> Value

toEncodingList :: [Package a] -> Encoding

FromJSON a => FromJSON (Package a)

Methods

parseJSON :: Value -> Parser (Package a)

parseJSONList :: Value -> Parser [Package a]

data NotYetKnown

Constructors

NotYetKnown

Instances

Eq NotYetKnown

Methods

(==) :: NotYetKnown -> NotYetKnown -> Bool

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

Ord NotYetKnown

Methods

compare :: NotYetKnown -> NotYetKnown -> Ordering

(<) :: NotYetKnown -> NotYetKnown -> Bool

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

(>) :: NotYetKnown -> NotYetKnown -> Bool

(>=) :: NotYetKnown -> NotYetKnown -> Bool

max :: NotYetKnown -> NotYetKnown -> NotYetKnown

min :: NotYetKnown -> NotYetKnown -> NotYetKnown

Show NotYetKnown

Methods

showsPrec :: Int -> NotYetKnown -> ShowS

show :: NotYetKnown -> String

showList :: [NotYetKnown] -> ShowS

ToJSON NotYetKnown

Methods

toJSON :: NotYetKnown -> Value

toEncoding :: NotYetKnown -> Encoding

toJSONList :: [NotYetKnown] -> Value

toEncodingList :: [NotYetKnown] -> Encoding

FromJSON NotYetKnown

Methods

parseJSON :: Value -> Parser NotYetKnown

parseJSONList :: Value -> Parser [NotYetKnown]

type UploadedPackage = Package NotYetKnown

type VerifiedPackage = Package GithubUser

type ManifestError = BowerError

verifyPackage :: GithubUser -> UploadedPackage -> VerifiedPackage

packageName :: Package a -> PackageName

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.

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.

data Module

Constructors

Module

Fields

• modName :: ModuleName
• modComments :: Maybe Text
• modDeclarations :: [Declaration]
• modReExports :: [(InPackage ModuleName, [Declaration])]

Instances

Eq Module

Methods

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

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

Ord Module

Methods

compare :: Module -> Module -> Ordering

(<) :: Module -> Module -> Bool

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

(>) :: Module -> Module -> Bool

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

max :: Module -> Module -> Module

min :: Module -> Module -> Module

Show Module

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

ToJSON Module

Methods

toJSON :: Module -> Value

toEncoding :: Module -> Encoding

toJSONList :: [Module] -> Value

toEncodingList :: [Module] -> Encoding

data Declaration

Constructors

Declaration

Fields

• declTitle :: Text
• declComments :: Maybe Text
• declSourceSpan :: Maybe SourceSpan
• declChildren :: [ChildDeclaration]
• declInfo :: DeclarationInfo

Instances

Eq Declaration

Methods

(==) :: Declaration -> Declaration -> Bool

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

Ord Declaration

Methods

compare :: Declaration -> Declaration -> Ordering

(<) :: Declaration -> Declaration -> Bool

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

(>) :: Declaration -> Declaration -> Bool

(>=) :: Declaration -> Declaration -> Bool

max :: Declaration -> Declaration -> Declaration

min :: Declaration -> Declaration -> Declaration

Show Declaration

Methods

showsPrec :: Int -> Declaration -> ShowS

show :: Declaration -> String

showList :: [Declaration] -> ShowS

ToJSON Declaration

Methods

toJSON :: Declaration -> Value

toEncoding :: Declaration -> Encoding

toJSONList :: [Declaration] -> Value

toEncodingList :: [Declaration] -> Encoding

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 Kind)]

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

ExternDataDeclaration Kind

A data type foreign import, with its kind.

TypeSynonymDeclaration [(Text, Maybe Kind)] Type

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

TypeClassDeclaration [(Text, Maybe Kind)] [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.

ExternKindDeclaration

A kind declaration

Instances

Eq DeclarationInfo

Methods

(==) :: DeclarationInfo -> DeclarationInfo -> Bool

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

Ord DeclarationInfo

Methods

compare :: DeclarationInfo -> DeclarationInfo -> Ordering

(<) :: DeclarationInfo -> DeclarationInfo -> Bool

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

(>) :: DeclarationInfo -> DeclarationInfo -> Bool

(>=) :: DeclarationInfo -> DeclarationInfo -> Bool

max :: DeclarationInfo -> DeclarationInfo -> DeclarationInfo

min :: DeclarationInfo -> DeclarationInfo -> DeclarationInfo

Show DeclarationInfo

Methods

showsPrec :: Int -> DeclarationInfo -> ShowS

show :: DeclarationInfo -> String

showList :: [DeclarationInfo] -> ShowS

ToJSON DeclarationInfo

Methods

toJSON :: DeclarationInfo -> Value

toEncoding :: DeclarationInfo -> Encoding

toJSONList :: [DeclarationInfo] -> Value

toEncodingList :: [DeclarationInfo] -> Encoding

convertFundepsToStrings :: [(Text, Maybe Kind)] -> [FunctionalDependency] -> [([Text], [Text])]

declInfoToString :: DeclarationInfo -> Text

declInfoNamespace :: DeclarationInfo -> Namespace

isTypeClass :: Declaration -> Bool

isValue :: Declaration -> Bool

isType :: Declaration -> Bool

isValueAlias :: Declaration -> Bool

isTypeAlias :: Declaration -> Bool

isKind :: Declaration -> Bool

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

Discard any children which do not satisfy the given predicate.

data ChildDeclaration

Constructors

ChildDeclaration

Fields

• cdeclTitle :: Text
• cdeclComments :: Maybe Text
• cdeclSourceSpan :: Maybe SourceSpan
• cdeclInfo :: ChildDeclarationInfo

Instances

Eq ChildDeclaration

Methods

(==) :: ChildDeclaration -> ChildDeclaration -> Bool

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

Ord ChildDeclaration

Methods

compare :: ChildDeclaration -> ChildDeclaration -> Ordering

(<) :: ChildDeclaration -> ChildDeclaration -> Bool

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

(>) :: ChildDeclaration -> ChildDeclaration -> Bool

(>=) :: ChildDeclaration -> ChildDeclaration -> Bool

max :: ChildDeclaration -> ChildDeclaration -> ChildDeclaration

min :: ChildDeclaration -> ChildDeclaration -> ChildDeclaration

Show ChildDeclaration

Methods

showsPrec :: Int -> ChildDeclaration -> ShowS

show :: ChildDeclaration -> String

showList :: [ChildDeclaration] -> ShowS

ToJSON ChildDeclaration

Methods

toJSON :: ChildDeclaration -> Value

toEncoding :: ChildDeclaration -> Encoding

toJSONList :: [ChildDeclaration] -> Value

toEncodingList :: [ChildDeclaration] -> Encoding

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

Eq ChildDeclarationInfo

Methods

(==) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool

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

Ord ChildDeclarationInfo

Methods

compare :: ChildDeclarationInfo -> ChildDeclarationInfo -> Ordering

(<) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool

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

(>) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool

(>=) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool

max :: ChildDeclarationInfo -> ChildDeclarationInfo -> ChildDeclarationInfo

min :: ChildDeclarationInfo -> ChildDeclarationInfo -> ChildDeclarationInfo

Show ChildDeclarationInfo

Methods

showsPrec :: Int -> ChildDeclarationInfo -> ShowS

show :: ChildDeclarationInfo -> String

showList :: [ChildDeclarationInfo] -> ShowS

ToJSON ChildDeclarationInfo

Methods

toJSON :: ChildDeclarationInfo -> Value

toEncoding :: ChildDeclarationInfo -> Encoding

toJSONList :: [ChildDeclarationInfo] -> Value

toEncodingList :: [ChildDeclarationInfo] -> Encoding

childDeclInfoToString :: ChildDeclarationInfo -> Text

childDeclInfoNamespace :: ChildDeclarationInfo -> Namespace

isTypeClassMember :: ChildDeclaration -> Bool

isDataConstructor :: ChildDeclaration -> Bool

newtype GithubUser

Constructors

GithubUser

Fields

• runGithubUser :: Text

Instances

Eq GithubUser

Methods

(==) :: GithubUser -> GithubUser -> Bool

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

Ord GithubUser

Methods

compare :: GithubUser -> GithubUser -> Ordering

(<) :: GithubUser -> GithubUser -> Bool

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

(>) :: GithubUser -> GithubUser -> Bool

(>=) :: GithubUser -> GithubUser -> Bool

max :: GithubUser -> GithubUser -> GithubUser

min :: GithubUser -> GithubUser -> GithubUser

Show GithubUser

Methods

showsPrec :: Int -> GithubUser -> ShowS

show :: GithubUser -> String

showList :: [GithubUser] -> ShowS

ToJSON GithubUser

Methods

toJSON :: GithubUser -> Value

toEncoding :: GithubUser -> Encoding

toJSONList :: [GithubUser] -> Value

toEncodingList :: [GithubUser] -> Encoding

FromJSON GithubUser

Methods

parseJSON :: Value -> Parser GithubUser

parseJSONList :: Value -> Parser [GithubUser]

newtype GithubRepo

Constructors

GithubRepo

Fields

• runGithubRepo :: Text

Instances

Eq GithubRepo

Methods

(==) :: GithubRepo -> GithubRepo -> Bool

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

Ord GithubRepo

Methods

compare :: GithubRepo -> GithubRepo -> Ordering

(<) :: GithubRepo -> GithubRepo -> Bool

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

(>) :: GithubRepo -> GithubRepo -> Bool

(>=) :: GithubRepo -> GithubRepo -> Bool

max :: GithubRepo -> GithubRepo -> GithubRepo

min :: GithubRepo -> GithubRepo -> GithubRepo

Show GithubRepo

Methods

showsPrec :: Int -> GithubRepo -> ShowS

show :: GithubRepo -> String

showList :: [GithubRepo] -> ShowS

ToJSON GithubRepo

Methods

toJSON :: GithubRepo -> Value

toEncoding :: GithubRepo -> Encoding

toJSONList :: [GithubRepo] -> Value

toEncodingList :: [GithubRepo] -> Encoding

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

InvalidTime

Instances

Eq PackageError

Methods

(==) :: PackageError -> PackageError -> Bool

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

Ord PackageError

Methods

compare :: PackageError -> PackageError -> Ordering

(<) :: PackageError -> PackageError -> Bool

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

(>) :: PackageError -> PackageError -> Bool

(>=) :: PackageError -> PackageError -> Bool

max :: PackageError -> PackageError -> PackageError

min :: PackageError -> PackageError -> PackageError

Show PackageError

Methods

showsPrec :: Int -> PackageError -> ShowS

show :: PackageError -> String

showList :: [PackageError] -> ShowS

data InPackage a

Constructors

Local a

FromDep PackageName a

Instances

Functor InPackage

Methods

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

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

Eq a => Eq (InPackage a)

Methods

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

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

Ord a => Ord (InPackage a)

Methods

compare :: InPackage a -> InPackage a -> Ordering

(<) :: InPackage a -> InPackage a -> Bool

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

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

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

max :: InPackage a -> InPackage a -> InPackage a

min :: InPackage a -> InPackage a -> InPackage a

Show a => Show (InPackage a)

Methods

showsPrec :: Int -> InPackage a -> ShowS

show :: InPackage a -> String

showList :: [InPackage a] -> ShowS

ToJSON a => ToJSON (InPackage a)

Methods

toJSON :: InPackage a -> Value

toEncoding :: InPackage a -> Encoding

toJSONList :: [InPackage a] -> Value

toEncodingList :: [InPackage a] -> Encoding

takeLocal :: InPackage a -> Maybe a

takeLocals :: [InPackage a] -> [a]

ignorePackage :: InPackage a -> a

data LinksContext

Constructors

LinksContext

Fields

• ctxGithub :: (GithubUser, GithubRepo)
• ctxModuleMap :: Map ModuleName PackageName
• ctxResolvedDependencies :: [(PackageName, Version)]
• ctxPackageName :: PackageName
• ctxVersion :: Version
• ctxVersionTag :: Text

Instances

Eq LinksContext

Methods

(==) :: LinksContext -> LinksContext -> Bool

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

Ord LinksContext

Methods

compare :: LinksContext -> LinksContext -> Ordering

(<) :: LinksContext -> LinksContext -> Bool

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

(>) :: LinksContext -> LinksContext -> Bool

(>=) :: LinksContext -> LinksContext -> Bool

max :: LinksContext -> LinksContext -> LinksContext

min :: LinksContext -> LinksContext -> LinksContext

Show LinksContext

Methods

showsPrec :: Int -> LinksContext -> ShowS

show :: LinksContext -> String

showList :: [LinksContext] -> ShowS

data DocLink

Constructors

DocLink

Fields

• linkLocation :: LinkLocation
• linkTitle :: Text
• linkNamespace :: Namespace

Instances

Eq DocLink

Methods

(==) :: DocLink -> DocLink -> Bool

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

Ord DocLink

Methods

compare :: DocLink -> DocLink -> Ordering

(<) :: DocLink -> DocLink -> Bool

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

(>) :: DocLink -> DocLink -> Bool

(>=) :: DocLink -> DocLink -> Bool

max :: DocLink -> DocLink -> DocLink

min :: DocLink -> DocLink -> DocLink

Show DocLink

Methods

showsPrec :: Int -> DocLink -> ShowS

show :: DocLink -> String

showList :: [DocLink] -> ShowS

data LinkLocation

Constructors

SameModule

A link to a declaration in the same module.

LocalModule ModuleName ModuleName

A link to a declaration in a different module, but still in the current package; we need to store the current module and the other declaration's module.

DepsModule ModuleName PackageName Version ModuleName

A link to a declaration in a different package. We store: current module name, name of the other package, version of the other package, and 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 (at the time of writing, this will only ever be Prim).

Instances

Eq LinkLocation

Methods

(==) :: LinkLocation -> LinkLocation -> Bool

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

Ord LinkLocation

Methods

compare :: LinkLocation -> LinkLocation -> Ordering

(<) :: LinkLocation -> LinkLocation -> Bool

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

(>) :: LinkLocation -> LinkLocation -> Bool

(>=) :: LinkLocation -> LinkLocation -> Bool

max :: LinkLocation -> LinkLocation -> LinkLocation

min :: LinkLocation -> LinkLocation -> LinkLocation

Show LinkLocation

Methods

showsPrec :: Int -> LinkLocation -> ShowS

show :: LinkLocation -> String

showList :: [LinkLocation] -> ShowS

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.

getLinksContext :: Package a -> LinksContext

parseUploadedPackage :: Version -> LByteString -> Either (ParseError PackageError) UploadedPackage

parseVerifiedPackage :: Version -> LByteString -> Either (ParseError PackageError) VerifiedPackage

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

parseTimeEither :: String -> Either PackageError UTCTime

asUploadedPackage :: Version -> Parse PackageError UploadedPackage

asNotYetKnown :: Parse e NotYetKnown

asVerifiedPackage :: Version -> Parse PackageError VerifiedPackage

displayPackageError :: PackageError -> Text

asGithubUser :: Parse e GithubUser

asVersion :: Parse PackageError Version

parseVersion' :: String -> Maybe Version

asModule :: Parse PackageError Module

asDeclaration :: Parse PackageError Declaration

asReExport :: Parse PackageError (InPackage ModuleName, [Declaration])

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

asInPackage :: Parse ManifestError a -> Parse ManifestError (InPackage a)

asFixity :: Parse PackageError Fixity

asFixityAlias :: Parse PackageError FixityAlias

parseAssociativity :: String -> Maybe Associativity

asAssociativity :: Parse PackageError Associativity

asDeclarationInfo :: Parse PackageError DeclarationInfo

asTypeArguments :: Parse PackageError [(Text, Maybe Kind)]

asKind :: Parse PackageError Kind

asType :: Parse e Type

asFunDeps :: Parse PackageError [([Text], [Text])]

asDataDeclType :: Parse PackageError DataDeclType

asChildDeclaration :: Parse PackageError ChildDeclaration

asChildDeclarationInfo :: Parse PackageError ChildDeclarationInfo

asSourcePos :: Parse e SourcePos

asConstraint :: Parse PackageError Constraint

asQualifiedProperName :: Parse e (Qualified (ProperName a))

asQualifiedIdent :: Parse e (Qualified Ident)

asModuleMap :: Parse PackageError (Map ModuleName PackageName)

bookmarksAsModuleMap :: Parse ManifestError (Map ModuleName PackageName)

asResolvedDependencies :: Parse PackageError [(PackageName, Version)]

parsePackageName' :: Text -> Either PackageError PackageName

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

asGithub :: Parse e (GithubUser, GithubRepo)

asSourceSpan :: Parse e SourceSpan

assocListToJSON :: (a -> Text) -> (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"}.