purescript-0.8.0.0: PureScript Programming Language Compiler

Safe HaskellNone
LanguageHaskell98

Language.PureScript.Docs.ParseAndDesugar

Synopsis

Documentation

parseAndDesugar :: (Functor m, Applicative m, MonadError MultipleErrors m, MonadIO m) => [FilePath] -> [(PackageName, FilePath)] -> m ([InPackage Module], [Bookmark], Env) Source

Given:

  • A list of local source files
  • A list of source files from external dependencies, together with their package names

This function does the following:

  • Parse all of the input and dependency source files
  • Associate each dependency module with its package name, thereby distinguishing these from local modules
  • Partially desugar all of the resulting modules (just enough for producing documentation from them)
  • Collect a list of bookmarks from the whole set of source files
  • Return the desugared modules, the bookmarks, and the imports/exports Env (which is needed for producing documentation).