Safe Haskell	None
Language	Haskell98

Language.PureScript.Docs.Types

Synopsis

Documentation

data Package a Source

Constructors

Package

Fields

pkgMeta :: PackageMeta
pkgVersion :: Version
pkgVersionTag :: String
pkgModules :: [Module]
pkgBookmarks :: [Bookmark]
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)
Ord a => Ord (Package a)
Show a => Show (Package a)
ToJSON a => ToJSON (Package a)
FromJSON a => FromJSON (Package a)

data NotYetKnown Source

Constructors

NotYetKnown

Instances

Eq NotYetKnown
Ord NotYetKnown
Show NotYetKnown
ToJSON NotYetKnown
FromJSON NotYetKnown

type UploadedPackage = Package NotYetKnown Source

type VerifiedPackage = Package GithubUser Source

verifyPackage :: GithubUser -> UploadedPackage -> VerifiedPackage Source

packageName :: Package a -> PackageName Source

data Module Source

Constructors

Module
Fields modName :: String modComments :: Maybe String modDeclarations :: [Declaration]

Instances

Eq Module
Ord Module
Show Module
ToJSON Module

data Declaration Source

Constructors

Declaration
Fields declTitle :: String declComments :: Maybe String declSourceSpan :: Maybe SourceSpan declChildren :: [ChildDeclaration] declFixity :: Maybe Fixity declInfo :: DeclarationInfo

Instances

Eq Declaration
Ord Declaration
Show Declaration
ToJSON Declaration

data DeclarationInfo Source

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 [(String, 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 [(String, Maybe Kind)] Type	A type synonym, with its type arguments and its type.
TypeClassDeclaration [(String, Maybe Kind)] [Constraint]	A type class, with its type arguments and its superclasses. Instances and members are represented as child declarations.

Instances

Eq DeclarationInfo
Ord DeclarationInfo
Show DeclarationInfo
ToJSON DeclarationInfo

declInfoToString :: DeclarationInfo -> String Source

data ChildDeclaration Source

Constructors

ChildDeclaration
Fields cdeclTitle :: String cdeclComments :: Maybe String cdeclSourceSpan :: Maybe SourceSpan cdeclInfo :: ChildDeclarationInfo

Instances

Eq ChildDeclaration
Ord ChildDeclaration
Show ChildDeclaration
ToJSON ChildDeclaration

data ChildDeclarationInfo Source

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
Ord ChildDeclarationInfo
Show ChildDeclarationInfo
ToJSON ChildDeclarationInfo

childDeclInfoToString :: ChildDeclarationInfo -> String Source

newtype GithubUser Source

Constructors

GithubUser
Fields runGithubUser :: String

Instances

Eq GithubUser
Ord GithubUser
Show GithubUser
ToJSON GithubUser
FromJSON GithubUser

newtype GithubRepo Source

Constructors

GithubRepo
Fields runGithubRepo :: String

Instances

Eq GithubRepo
Ord GithubRepo
Show GithubRepo
ToJSON GithubRepo

data PackageError Source

Constructors

CompilerTooOld Version Version	Minimum allowable version for generating data with the current parser, and actual version used.
ErrorInPackageMeta BowerError
InvalidVersion
InvalidDeclarationType String
InvalidChildDeclarationType String
InvalidFixity
InvalidKind String
InvalidDataDeclType String

Instances

Eq PackageError
Ord PackageError
Show PackageError

type Bookmark = InPackage (ModuleName, String) Source

data InPackage a Source

Constructors

Local a
FromDep PackageName a

Instances

Functor InPackage
Eq a => Eq (InPackage a)
Ord a => Ord (InPackage a)
Show a => Show (InPackage a)
ToJSON a => ToJSON (InPackage a)

takeLocal :: InPackage a -> Maybe a Source

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

ignorePackage :: InPackage a -> a Source

parseUploadedPackage :: Version -> ByteString -> Either (ParseError PackageError) UploadedPackage Source

parseVerifiedPackage :: Version -> ByteString -> Either (ParseError PackageError) VerifiedPackage Source

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

asUploadedPackage :: Version -> Parse PackageError UploadedPackage Source

asNotYetKnown :: Parse e NotYetKnown Source

asVerifiedPackage :: Version -> Parse PackageError VerifiedPackage Source

displayPackageError :: PackageError -> Text Source

asGithubUser :: Parse e GithubUser Source

asVersion :: Parse PackageError Version Source

parseVersion' :: String -> Maybe Version Source

asModule :: Parse PackageError Module Source

asDeclaration :: Parse PackageError Declaration Source

asFixity :: Parse PackageError Fixity Source

parseAssociativity :: String -> Maybe Associativity Source

asAssociativity :: Parse PackageError Associativity Source

asDeclarationInfo :: Parse PackageError DeclarationInfo Source

asTypeArguments :: Parse PackageError [(String, Maybe Kind)] Source

asKind :: Parse e Kind Source

asType :: Parse e Type Source

asDataDeclType :: Parse PackageError DataDeclType Source

asChildDeclaration :: Parse PackageError ChildDeclaration Source

asChildDeclarationInfo :: Parse PackageError ChildDeclarationInfo Source

asSourcePos :: Parse e SourcePos Source

asConstraint :: Parse PackageError Constraint Source

asQualifiedProperName :: Parse e (Qualified ProperName) Source

asBookmarks :: Parse BowerError [Bookmark] Source

asBookmark :: Parse BowerError Bookmark Source

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

asGithub :: Parse e (GithubUser, GithubRepo) Source

asSourceSpan :: Parse e SourceSpan Source

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

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"}.