purescript-0.15.15: PureScript Programming Language Compiler

Safe Haskell | None
Language | Haskell2010

Language.PureScript.Docs.Types

Synopsis

- data Module = Module {
  - modName :: ModuleName
  - modComments :: Maybe Text
  - modDeclarations :: [Declaration]
  - modReExports :: [(InPackage ModuleName, [Declaration])]
  }
- packageName :: Package a -> PackageName
- data Package a = Package {
  - 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
  }
- formatTime :: UTCTime -> String
- parseTime :: String -> Maybe UTCTime
- data Declaration = Declaration {
  - declTitle :: Text
  - declComments :: Maybe Text
  - declSourceSpan :: Maybe SourceSpan
  - declChildren :: [ChildDeclaration]
  - declInfo :: DeclarationInfo
  - declKind :: Maybe KindInfo
  }
- data ChildDeclaration = ChildDeclaration {
  - cdeclTitle :: Text
  - cdeclComments :: Maybe Text
  - cdeclSourceSpan :: Maybe SourceSpan
  - cdeclInfo :: ChildDeclarationInfo
  }
- data ChildDeclarationInfo
  - = ChildInstance [Constraint'] Type'
  - | ChildDataConstructor [Type']
  - | ChildTypeClassMember Type'
- ignorePackage :: InPackage a -> a
- data InPackage a
  - = Local a
  - | FromDep PackageName a
- asModule :: Parse PackageError Module
- displayPackageError :: PackageError -> Text
- data DeclarationInfo
  - = ValueDeclaration Type'
  - | DataDeclaration DataDeclType [(Text, Maybe Type')] [Role]
  - | ExternDataDeclaration Type' [Role]
  - | TypeSynonymDeclaration [(Text, Maybe Type')] Type'
  - | TypeClassDeclaration [(Text, Maybe Type')] [Constraint'] [([Text], [Text])]
  - | AliasDeclaration Fixity FixityAlias
- data KindInfo = KindInfo {
  - kiKeyword :: KindSignatureFor
  - kiKind :: Type'
  }
- type Type' = Type ()
- convertFundepsToStrings :: [(Text, Maybe Type')] -> [FunctionalDependency] -> [([Text], [Text])]
- isType :: Declaration -> Bool
- isTypeClass :: Declaration -> Bool
- type Constraint' = Constraint ()
- isTypeClassMember :: ChildDeclaration -> Bool
- kindSignatureForKeyword :: KindSignatureFor -> Text
- data PackageError
  - = CompilerTooOld Version Version
  - | ErrorInPackageMeta ManifestError
  - | InvalidVersion
  - | InvalidDeclarationType Text
  - | InvalidChildDeclarationType Text
  - | InvalidFixity
  - | InvalidKind Text
  - | InvalidDataDeclType Text
  - | InvalidKindSignatureFor Text
  - | InvalidTime
  - | InvalidRole Text
- data ManifestError
  - = BowerManifest BowerError
  - | PursManifest PursJsonError
- showManifestError :: ManifestError -> Text
- newtype GithubUser = GithubUser {
  - runGithubUser :: Text
  }
- newtype GithubRepo = GithubRepo {
  - runGithubRepo :: Text
  }
- data NotYetKnown = NotYetKnown
- type UploadedPackage = Package NotYetKnown
- type VerifiedPackage = Package GithubUser
- verifyPackage :: GithubUser -> UploadedPackage -> VerifiedPackage
- jsonTimeFormat :: String
- declInfoToString :: DeclarationInfo -> Text
- declInfoNamespace :: DeclarationInfo -> Namespace
- isValue :: Declaration -> Bool
- isValueAlias :: Declaration -> Bool
- isTypeAlias :: Declaration -> Bool
- filterChildren :: (ChildDeclaration -> Bool) -> Declaration -> Declaration
- childDeclInfoToString :: ChildDeclarationInfo -> Text
- childDeclInfoNamespace :: ChildDeclarationInfo -> Namespace
- isDataConstructor :: ChildDeclaration -> Bool
- data LinksContext = LinksContext {
  - ctxGithub :: (GithubUser, GithubRepo)
  - ctxModuleMap :: Map ModuleName PackageName
  - ctxResolvedDependencies :: [(PackageName, Version)]
  - ctxPackageName :: PackageName
  - ctxVersion :: Version
  - ctxVersionTag :: Text
  }
- data DocLink = DocLink {
  - linkLocation :: LinkLocation
  - linkTitle :: Text
  - linkNamespace :: Namespace
  }
- data LinkLocation
  - = LocalModule ModuleName
  - | DepsModule PackageName Version ModuleName
  - | BuiltinModule ModuleName
- getLink :: LinksContext -> ModuleName -> Namespace -> Text -> ContainingModule -> Maybe DocLink
- getLinksContext :: Package a -> LinksContext
- asPackage :: Version -> (forall e. Parse e a) -> Parse PackageError (Package a)
- asVersion :: Parse PackageError Version
- parseTimeEither :: String -> Either PackageError UTCTime
- asResolvedDependencies :: Parse PackageError [(PackageName, Version)]
- asGithub :: Parse e (GithubUser, GithubRepo)
- asModuleMap :: Parse PackageError (Map ModuleName PackageName)
- pOr :: Parse e a -> Parse e a -> Parse e a
- bookmarksAsModuleMap :: Parse ManifestError (Map ModuleName PackageName)
- asUploadedPackage :: Version -> Parse PackageError UploadedPackage
- asNotYetKnown :: Parse e NotYetKnown
- asGithubUser :: Parse e GithubUser
- asDeclaration :: Parse PackageError Declaration
- asReExport :: Parse PackageError (InPackage ModuleName, [Declaration])
- asSourceSpan :: Parse e SourceSpan
- asChildDeclaration :: Parse PackageError ChildDeclaration
- asDeclarationInfo :: Parse PackageError DeclarationInfo
- asKindInfo :: Parse PackageError KindInfo
- asInPackage :: Parse ManifestError a -> Parse ManifestError (InPackage a)
- mapLeft :: (a -> a') -> Either a b -> Either a' b
- asFixity :: Parse PackageError Fixity
- asAssociativity :: Parse PackageError Associativity
- asFixityAlias :: Parse PackageError FixityAlias
- parseAssociativity :: String -> Maybe Associativity
- asType :: Parse e Type'
- asDataDeclType :: Parse PackageError DataDeclType
- asTypeArguments :: Parse PackageError [(Text, Maybe Type')]
- asRole :: Parse PackageError Role
- asConstraint :: Parse PackageError Constraint'
- asFunDeps :: Parse PackageError [([Text], [Text])]
- asKindSignatureFor :: Parse PackageError KindSignatureFor
- asChildDeclarationInfo :: Parse PackageError ChildDeclarationInfo
- asSourcePos :: Parse e SourcePos
- asQualifiedProperName :: forall e (a :: ProperNameType). Parse e (Qualified (ProperName a))
- parsePackageName' :: Text -> Either PackageError PackageName
- assocListToJSON :: (a -> Key) -> (b -> Text) -> [(a, b)] -> Value
- data RenderedCodeElement
  - = Syntax Text
  - | Keyword Text
  - | Space
  - | Symbol Namespace Text Link
  - | Role Text
- data RenderedCode
- data ContainingModule
  - = ThisModule
  - | OtherModule ModuleName
- asContainingModule :: Parse Text ContainingModule
- data Namespace
  - = ValueLevel
  - | TypeLevel
- type FixityAlias = Qualified (Either (ProperName 'TypeName) (Either Ident (ProperName 'ConstructorName)))

# Documentation

data Module #

Constructors

Module |
Fields modName :: ModuleName modComments :: Maybe Text modDeclarations :: [Declaration] modReExports :: [(InPackage ModuleName, [Declaration])]

#### Instances

Instances details

ToJSON Module # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: Module -> Value # toEncoding :: Module -> Encoding # toJSONList :: [Module] -> Value # toEncodingList :: [Module] -> Encoding # omitField :: Module -> Bool #
NFData Module # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: Module -> () #
Generic Module # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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])]))))
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 #
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 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 #
type Rep Module # |
Instance details Defined in Language.PureScript.Docs.Types type Rep Module = D1 ('MetaData "Module" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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])]))))

packageName :: Package a -> PackageName #

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

Instances details

FromJSON a => FromJSON (Package a) # |
Instance details Defined in Language.PureScript.Docs.Types Methods parseJSON :: Value -> Parser (Package a) # parseJSONList :: Value -> Parser [Package a] # omittedField :: Maybe (Package a) #
ToJSON a => ToJSON (Package a) # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: Package a -> Value # toEncoding :: Package a -> Encoding # toJSONList :: [Package a] -> Value # toEncodingList :: [Package a] -> Encoding # omitField :: Package a -> Bool #
NFData a => NFData (Package a) # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: Package a -> () #
Generic (Package a) # |
Instance details Defined in Language.PureScript.Docs.Types Associated Types
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.15-8K0LbmS63k4ILju2RsIrDp" '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))))))
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 #
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.15-8K0LbmS63k4ILju2RsIrDp" '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))))))

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 Declaration #

Constructors

Declaration |
Fields declTitle :: Text declComments :: Maybe Text declSourceSpan :: Maybe SourceSpan declChildren :: [ChildDeclaration] declInfo :: DeclarationInfo declKind :: Maybe KindInfo

#### Instances

Instances details

ToJSON Declaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: Declaration -> Value # toEncoding :: Declaration -> Encoding # toJSONList :: [Declaration] -> Value # toEncodingList :: [Declaration] -> Encoding # omitField :: Declaration -> Bool #
NFData Declaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: Declaration -> () #
Generic Declaration # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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))))))
Methods from :: Declaration -> Rep Declaration x # to :: Rep Declaration x -> Declaration #
Show Declaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
Eq Declaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: Declaration -> Declaration -> Bool # (/=) :: Declaration -> Declaration -> Bool #
Ord Declaration # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep Declaration # |
Instance details Defined in Language.PureScript.Docs.Types type Rep Declaration = D1 ('MetaData "Declaration" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 #

Constructors

ChildDeclaration |
Fields cdeclTitle :: Text cdeclComments :: Maybe Text cdeclSourceSpan :: Maybe SourceSpan cdeclInfo :: ChildDeclarationInfo

#### Instances

Instances details

ToJSON ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: ChildDeclaration -> Value # toEncoding :: ChildDeclaration -> Encoding # toJSONList :: [ChildDeclaration] -> Value # toEncodingList :: [ChildDeclaration] -> Encoding # omitField :: ChildDeclaration -> Bool #
NFData ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: ChildDeclaration -> () #
Generic ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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))))
Methods from :: ChildDeclaration -> Rep ChildDeclaration x # to :: Rep ChildDeclaration x -> ChildDeclaration #
Show ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> ChildDeclaration -> ShowS # show :: ChildDeclaration -> String # showList :: [ChildDeclaration] -> ShowS #
Eq ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: ChildDeclaration -> ChildDeclaration -> Bool # (/=) :: ChildDeclaration -> ChildDeclaration -> Bool #
Ord ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep ChildDeclaration # |
Instance details Defined in Language.PureScript.Docs.Types type Rep ChildDeclaration = D1 ('MetaData "ChildDeclaration" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 Methods toJSON :: ChildDeclarationInfo -> Value # toEncoding :: ChildDeclarationInfo -> Encoding # toJSONList :: [ChildDeclarationInfo] -> Value # toEncodingList :: [ChildDeclarationInfo] -> Encoding # omitField :: ChildDeclarationInfo -> Bool #
NFData ChildDeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: ChildDeclarationInfo -> () #
Generic ChildDeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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'))))
Methods from :: ChildDeclarationInfo -> Rep ChildDeclarationInfo x # to :: Rep ChildDeclarationInfo x -> ChildDeclarationInfo #
Show ChildDeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> ChildDeclarationInfo -> ShowS # show :: ChildDeclarationInfo -> String # showList :: [ChildDeclarationInfo] -> ShowS #
Eq ChildDeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # (/=) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool #
Ord ChildDeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep ChildDeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types type Rep ChildDeclarationInfo = D1 ('MetaData "ChildDeclarationInfo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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'))))

ignorePackage :: InPackage a -> a #

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 Methods toJSON :: InPackage a -> Value # toEncoding :: InPackage a -> Encoding # toJSONList :: [InPackage a] -> Value # toEncodingList :: [InPackage a] -> Encoding # omitField :: InPackage a -> Bool #
NFData a => NFData (InPackage a) # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: InPackage a -> () #
Generic (InPackage a) # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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)))
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 #
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 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 #
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.15-8K0LbmS63k4ILju2RsIrDp" '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)))

asModule :: Parse PackageError Module #

displayPackageError :: PackageError -> Text #

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 Methods toJSON :: DeclarationInfo -> Value # toEncoding :: DeclarationInfo -> Encoding # toJSONList :: [DeclarationInfo] -> Value # toEncodingList :: [DeclarationInfo] -> Encoding # omitField :: DeclarationInfo -> Bool #
NFData DeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: DeclarationInfo -> () #
Generic DeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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)))))
Methods from :: DeclarationInfo -> Rep DeclarationInfo x # to :: Rep DeclarationInfo x -> DeclarationInfo #
Show DeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> DeclarationInfo -> ShowS # show :: DeclarationInfo -> String # showList :: [DeclarationInfo] -> ShowS #
Eq DeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: DeclarationInfo -> DeclarationInfo -> Bool # (/=) :: DeclarationInfo -> DeclarationInfo -> Bool #
Ord DeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep DeclarationInfo # |
Instance details Defined in Language.PureScript.Docs.Types type Rep DeclarationInfo = D1 ('MetaData "DeclarationInfo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 |
Fields kiKeyword :: KindSignatureFor kiKind :: Type'

#### Instances

Instances details

ToJSON KindInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: KindInfo -> Value # toEncoding :: KindInfo -> Encoding # toJSONList :: [KindInfo] -> Value # toEncodingList :: [KindInfo] -> Encoding # omitField :: KindInfo -> Bool #
NFData KindInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: KindInfo -> () #
Generic KindInfo # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "KindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kiKeyword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KindSignatureFor) :*: S1 ('MetaSel ('Just "kiKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 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 #
Eq KindInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: KindInfo -> KindInfo -> Bool # (/=) :: KindInfo -> KindInfo -> Bool #
Ord KindInfo # |
Instance details Defined in Language.PureScript.Docs.Types Methods compare :: KindInfo -> KindInfo -> Ordering # (<) :: KindInfo -> KindInfo -> Bool # (<=) :: KindInfo -> KindInfo -> Bool # (>) :: KindInfo -> KindInfo -> Bool # (>=) :: KindInfo -> KindInfo -> Bool # max :: KindInfo -> KindInfo -> KindInfo # min :: KindInfo -> KindInfo -> KindInfo #
type Rep KindInfo # |
Instance details Defined in Language.PureScript.Docs.Types type Rep KindInfo = D1 ('MetaData "KindInfo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 () #

convertFundepsToStrings :: [(Text, Maybe Type')] -> [FunctionalDependency] -> [([Text], [Text])] #

isType :: Declaration -> Bool #

isTypeClass :: Declaration -> Bool #

type Constraint' = Constraint () #

isTypeClassMember :: ChildDeclaration -> Bool #

kindSignatureForKeyword :: KindSignatureFor -> Text #

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

NFData PackageError # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: PackageError -> () #
Generic PackageError # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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))))))
Methods from :: PackageError -> Rep PackageError x # to :: Rep PackageError x -> PackageError #
Show PackageError # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> PackageError -> ShowS # show :: PackageError -> String # showList :: [PackageError] -> ShowS #
Eq PackageError # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: PackageError -> PackageError -> Bool # (/=) :: PackageError -> PackageError -> Bool #
Ord PackageError # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep PackageError # |
Instance details Defined in Language.PureScript.Docs.Types type Rep PackageError = D1 ('MetaData "PackageError" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 #

Constructors

BowerManifest BowerError |
PursManifest PursJsonError |

#### Instances

Instances details

NFData ManifestError # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: ManifestError -> () #
Generic ManifestError # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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)))
Methods from :: ManifestError -> Rep ManifestError x # to :: Rep ManifestError x -> ManifestError #
Show ManifestError # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> ManifestError -> ShowS # show :: ManifestError -> String # showList :: [ManifestError] -> ShowS #
Eq ManifestError # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: ManifestError -> ManifestError -> Bool # (/=) :: ManifestError -> ManifestError -> Bool #
Ord ManifestError # |
Instance details Defined in Language.PureScript.Docs.Types Methods compare :: ManifestError -> ManifestError -> Ordering # (<) :: ManifestError -> ManifestError -> Bool # (<=) :: ManifestError -> ManifestError -> Bool # (>) :: ManifestError -> ManifestError -> Bool # (>=) :: ManifestError -> ManifestError -> Bool # max :: ManifestError -> ManifestError -> ManifestError # min :: ManifestError -> ManifestError -> ManifestError #
type Rep ManifestError # |
Instance details Defined in Language.PureScript.Docs.Types type Rep ManifestError = D1 ('MetaData "ManifestError" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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)))

showManifestError :: ManifestError -> Text #

newtype GithubUser #

Constructors

GithubUser |
Fields runGithubUser :: Text

#### Instances

Instances details

FromJSON GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types Methods parseJSON :: Value -> Parser GithubUser # parseJSONList :: Value -> Parser [GithubUser] # omittedField :: Maybe GithubUser #
ToJSON GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: GithubUser -> Value # toEncoding :: GithubUser -> Encoding # toJSONList :: [GithubUser] -> Value # toEncodingList :: [GithubUser] -> Encoding # omitField :: GithubUser -> Bool #
NFData GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: GithubUser -> () #
Generic GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" 'True) (C1 ('MetaCons "GithubUser" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))
Methods from :: GithubUser -> Rep GithubUser x # to :: Rep GithubUser x -> GithubUser #
Show GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> GithubUser -> ShowS # show :: GithubUser -> String # showList :: [GithubUser] -> ShowS #
Eq GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: GithubUser -> GithubUser -> Bool # (/=) :: GithubUser -> GithubUser -> Bool #
Ord GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep GithubUser # |
Instance details Defined in Language.PureScript.Docs.Types type Rep GithubUser = D1 ('MetaData "GithubUser" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'True) (C1 ('MetaCons "GithubUser" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype GithubRepo #

Constructors

GithubRepo |
Fields runGithubRepo :: Text

#### Instances

Instances details

ToJSON GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: GithubRepo -> Value # toEncoding :: GithubRepo -> Encoding # toJSONList :: [GithubRepo] -> Value # toEncodingList :: [GithubRepo] -> Encoding # omitField :: GithubRepo -> Bool #
NFData GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: GithubRepo -> () #
Generic GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" 'True) (C1 ('MetaCons "GithubRepo" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubRepo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))
Methods from :: GithubRepo -> Rep GithubRepo x # to :: Rep GithubRepo x -> GithubRepo #
Show GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> GithubRepo -> ShowS # show :: GithubRepo -> String # showList :: [GithubRepo] -> ShowS #
Eq GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: GithubRepo -> GithubRepo -> Bool # (/=) :: GithubRepo -> GithubRepo -> Bool #
Ord GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep GithubRepo # |
Instance details Defined in Language.PureScript.Docs.Types type Rep GithubRepo = D1 ('MetaData "GithubRepo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 Methods parseJSON :: Value -> Parser NotYetKnown # parseJSONList :: Value -> Parser [NotYetKnown] # omittedField :: Maybe NotYetKnown #
ToJSON NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types Methods toJSON :: NotYetKnown -> Value # toEncoding :: NotYetKnown -> Encoding # toJSONList :: [NotYetKnown] -> Value # toEncodingList :: [NotYetKnown] -> Encoding # omitField :: NotYetKnown -> Bool #
NFData NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: NotYetKnown -> () #
Generic NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "NotYetKnown" 'PrefixI 'False) (U1 :: Type -> Type))
Methods from :: NotYetKnown -> Rep NotYetKnown x # to :: Rep NotYetKnown x -> NotYetKnown #
Show NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> NotYetKnown -> ShowS # show :: NotYetKnown -> String # showList :: [NotYetKnown] -> ShowS #
Eq NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: NotYetKnown -> NotYetKnown -> Bool # (/=) :: NotYetKnown -> NotYetKnown -> Bool #
Ord NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep NotYetKnown # |
Instance details Defined in Language.PureScript.Docs.Types type Rep NotYetKnown = D1 ('MetaData "NotYetKnown" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "NotYetKnown" 'PrefixI 'False) (U1 :: Type -> Type))

type UploadedPackage = Package NotYetKnown #

type VerifiedPackage = Package GithubUser #

verifyPackage :: GithubUser -> UploadedPackage -> VerifiedPackage #

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.

declInfoToString :: DeclarationInfo -> Text #

declInfoNamespace :: DeclarationInfo -> Namespace #

isValue :: Declaration -> Bool #

isValueAlias :: Declaration -> Bool #

isTypeAlias :: Declaration -> Bool #

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

Discard any children which do not satisfy the given predicate.

childDeclInfoToString :: ChildDeclarationInfo -> Text #

childDeclInfoNamespace :: ChildDeclarationInfo -> Namespace #

isDataConstructor :: ChildDeclaration -> Bool #

data LinksContext #

Constructors

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

#### Instances

Instances details

NFData LinksContext # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: LinksContext -> () #
Generic LinksContext # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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)))))
Methods from :: LinksContext -> Rep LinksContext x # to :: Rep LinksContext x -> LinksContext #
Show LinksContext # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> LinksContext -> ShowS # show :: LinksContext -> String # showList :: [LinksContext] -> ShowS #
Eq LinksContext # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: LinksContext -> LinksContext -> Bool # (/=) :: LinksContext -> LinksContext -> Bool #
Ord LinksContext # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep LinksContext # |
Instance details Defined in Language.PureScript.Docs.Types type Rep LinksContext = D1 ('MetaData "LinksContext" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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 #

Constructors

DocLink |
Fields linkLocation :: LinkLocation linkTitle :: Text linkNamespace :: Namespace

#### Instances

Instances details

NFData DocLink # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: DocLink -> () #
Generic DocLink # |
Instance details Defined in Language.PureScript.Docs.Types Associated Types
type Rep DocLink |
Instance details Defined in Language.PureScript.Docs.Types type Rep DocLink = D1 ('MetaData "DocLink" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "DocLink" 'PrefixI 'True) (S1 ('MetaSel ('Just "linkLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LinkLocation) :*: (S1 ('MetaSel ('Just "linkTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "linkNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace))))
Methods from :: DocLink -> Rep DocLink x # to :: Rep DocLink x -> DocLink #
Show DocLink # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> DocLink -> ShowS # show :: DocLink -> String # showList :: [DocLink] -> ShowS #
Eq DocLink # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: DocLink -> DocLink -> Bool # (/=) :: DocLink -> DocLink -> Bool #
Ord DocLink # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep DocLink # |
Instance details Defined in Language.PureScript.Docs.Types type Rep DocLink = D1 ('MetaData "DocLink" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "DocLink" 'PrefixI 'True) (S1 ('MetaSel ('Just "linkLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LinkLocation) :*: (S1 ('MetaSel ('Just "linkTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "linkNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace))))

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

NFData LinkLocation # |
Instance details Defined in Language.PureScript.Docs.Types Methods rnf :: LinkLocation -> () #
Generic LinkLocation # |
Instance details Defined in Language.PureScript.Docs.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" '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))))
Methods from :: LinkLocation -> Rep LinkLocation x # to :: Rep LinkLocation x -> LinkLocation #
Show LinkLocation # |
Instance details Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> LinkLocation -> ShowS # show :: LinkLocation -> String # showList :: [LinkLocation] -> ShowS #
Eq LinkLocation # |
Instance details Defined in Language.PureScript.Docs.Types Methods (==) :: LinkLocation -> LinkLocation -> Bool # (/=) :: LinkLocation -> LinkLocation -> Bool #
Ord LinkLocation # |
Instance details Defined in Language.PureScript.Docs.Types 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 #
type Rep LinkLocation # |
Instance details Defined in Language.PureScript.Docs.Types type Rep LinkLocation = D1 ('MetaData "LinkLocation" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" '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))))

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 #

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

asVersion :: Parse PackageError Version #

parseTimeEither :: String -> Either PackageError UTCTime #

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

asGithub :: Parse e (GithubUser, GithubRepo) #

asModuleMap :: Parse PackageError (Map ModuleName PackageName) #

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

bookmarksAsModuleMap :: Parse ManifestError (Map ModuleName PackageName) #

asUploadedPackage :: Version -> Parse PackageError UploadedPackage #

asNotYetKnown :: Parse e NotYetKnown #

asGithubUser :: Parse e GithubUser #

asDeclaration :: Parse PackageError Declaration #

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

asSourceSpan :: Parse e SourceSpan #

asChildDeclaration :: Parse PackageError ChildDeclaration #

asDeclarationInfo :: Parse PackageError DeclarationInfo #

asKindInfo :: Parse PackageError KindInfo #

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

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

asFixity :: Parse PackageError Fixity #

asAssociativity :: Parse PackageError Associativity #

asFixityAlias :: Parse PackageError FixityAlias #

parseAssociativity :: String -> Maybe Associativity #

asType :: Parse e Type' #

asDataDeclType :: Parse PackageError DataDeclType #

asTypeArguments :: Parse PackageError [(Text, Maybe Type')] #

asRole :: Parse PackageError Role #

asConstraint :: Parse PackageError Constraint' #

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

asKindSignatureFor :: Parse PackageError KindSignatureFor #

asChildDeclarationInfo :: Parse PackageError ChildDeclarationInfo #

asSourcePos :: Parse e SourcePos #

asQualifiedProperName :: forall e (a :: ProperNameType). Parse e (Qualified (ProperName a)) #

parsePackageName' :: Text -> Either PackageError PackageName #

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 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 |

#### Instances

Instances details

ToJSON RenderedCodeElement # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: RenderedCodeElement -> Value # toEncoding :: RenderedCodeElement -> Encoding # toJSONList :: [RenderedCodeElement] -> Value # toEncodingList :: [RenderedCodeElement] -> Encoding # omitField :: RenderedCodeElement -> Bool #
Show RenderedCodeElement # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> RenderedCodeElement -> ShowS # show :: RenderedCodeElement -> String # showList :: [RenderedCodeElement] -> ShowS #
Eq RenderedCodeElement # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (/=) :: RenderedCodeElement -> RenderedCodeElement -> Bool #
Ord RenderedCodeElement # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: RenderedCodeElement -> RenderedCodeElement -> Ordering # (<) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (<=) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (>) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (>=) :: RenderedCodeElement -> RenderedCodeElement -> Bool # max :: RenderedCodeElement -> RenderedCodeElement -> RenderedCodeElement # min :: RenderedCodeElement -> RenderedCodeElement -> RenderedCodeElement #

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 Methods toJSON :: RenderedCode -> Value # toEncoding :: RenderedCode -> Encoding # toJSONList :: [RenderedCode] -> Value # toEncodingList :: [RenderedCode] -> Encoding # omitField :: RenderedCode -> Bool #
Monoid RenderedCode # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods mempty :: RenderedCode # mappend :: RenderedCode -> RenderedCode -> RenderedCode # mconcat :: [RenderedCode] -> RenderedCode #
Semigroup RenderedCode # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (<>) :: RenderedCode -> RenderedCode -> RenderedCode # sconcat :: NonEmpty RenderedCode -> RenderedCode # stimes :: Integral b => b -> RenderedCode -> RenderedCode #
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 Methods (==) :: RenderedCode -> RenderedCode -> Bool # (/=) :: RenderedCode -> RenderedCode -> Bool #
Ord RenderedCode # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: RenderedCode -> RenderedCode -> Ordering # (<) :: RenderedCode -> RenderedCode -> Bool # (<=) :: RenderedCode -> RenderedCode -> Bool # (>) :: RenderedCode -> RenderedCode -> Bool # (>=) :: RenderedCode -> RenderedCode -> Bool # max :: RenderedCode -> RenderedCode -> RenderedCode # min :: RenderedCode -> RenderedCode -> RenderedCode #

data ContainingModule #

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

Constructors

ThisModule |
OtherModule ModuleName |

#### Instances

Instances details

FromJSON ContainingModule # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods parseJSON :: Value -> Parser ContainingModule # parseJSONList :: Value -> Parser [ContainingModule] # omittedField :: Maybe ContainingModule #
ToJSON ContainingModule # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: ContainingModule -> Value # toEncoding :: ContainingModule -> Encoding # toJSONList :: [ContainingModule] -> Value # toEncodingList :: [ContainingModule] -> Encoding # omitField :: ContainingModule -> Bool #
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 Methods (==) :: ContainingModule -> ContainingModule -> Bool # (/=) :: ContainingModule -> ContainingModule -> Bool #
Ord ContainingModule # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: ContainingModule -> ContainingModule -> Ordering # (<) :: ContainingModule -> ContainingModule -> Bool # (<=) :: ContainingModule -> ContainingModule -> Bool # (>) :: ContainingModule -> ContainingModule -> Bool # (>=) :: ContainingModule -> ContainingModule -> Bool # max :: ContainingModule -> ContainingModule -> ContainingModule # min :: ContainingModule -> ContainingModule -> ContainingModule #

asContainingModule :: Parse Text ContainingModule #

data Namespace #

Constructors

ValueLevel |
TypeLevel |

#### Instances

Instances details

FromJSON Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods parseJSON :: Value -> Parser Namespace # parseJSONList :: Value -> Parser [Namespace] # omittedField :: Maybe Namespace #
ToJSON Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: Namespace -> Value # toEncoding :: Namespace -> Encoding # toJSONList :: [Namespace] -> Value # toEncodingList :: [Namespace] -> Encoding # omitField :: Namespace -> Bool #
NFData Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods rnf :: Namespace -> () #
Generic Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Associated 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.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "ValueLevel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeLevel" 'PrefixI 'False) (U1 :: Type -> Type))
Methods from :: Namespace -> Rep Namespace x # to :: Rep Namespace x -> Namespace #
Show Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> Namespace -> ShowS # show :: Namespace -> String # showList :: [Namespace] -> ShowS #
Eq Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: Namespace -> Namespace -> Bool # (/=) :: Namespace -> Namespace -> Bool #
Ord Namespace # |
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: Namespace -> Namespace -> Ordering # (<) :: Namespace -> Namespace -> Bool # (<=) :: Namespace -> Namespace -> Bool # (>) :: Namespace -> Namespace -> Bool # (>=) :: Namespace -> Namespace -> Bool # max :: Namespace -> Namespace -> Namespace # min :: Namespace -> Namespace -> Namespace #
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.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "ValueLevel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeLevel" 'PrefixI 'False) (U1 :: Type -> Type))

type FixityAlias = Qualified (Either (ProperName 'TypeName) (Either Ident (ProperName 'ConstructorName))) #