Fay

Main library entry point.

Documentation

module Fay.Config

data CompileError

Error type.

Constructors

Couldn'tFindImport ModuleName [FilePath]

EmptyDoBlock

FfiFormatBadChars SrcSpanInfo String

FfiFormatIncompleteArg SrcSpanInfo

FfiFormatInvalidJavaScript SrcSpanInfo String String

FfiFormatNoSuchArg SrcSpanInfo Int

FfiNeedsTypeSig Exp

GHCError String

InvalidDoBlock

ParseError SrcLoc String

ShouldBeDesugared String

UnableResolveQualified QName

UnsupportedDeclaration Decl

UnsupportedEnum Exp

UnsupportedExportSpec ExportSpec

UnsupportedExpression Exp

UnsupportedFieldPattern PatField

UnsupportedImport ImportDecl

UnsupportedLet

UnsupportedLetBinding Decl

UnsupportedLiteral Literal

UnsupportedModuleSyntax String Module

UnsupportedPattern Pat

UnsupportedQualStmt QualStmt

UnsupportedRecursiveDo

UnsupportedRhs Rhs

UnsupportedWhereInAlt Alt

UnsupportedWhereInMatch Match

Instances

Show CompileError

Error CompileError

MonadError CompileError Compile

data CompileState

State of the compiler.

Constructors

CompileState

Fields

stateInterfaces :: Map ModuleName Symbols

Exported identifiers for all modules

stateRecordTypes :: [(QName, [QName])]

Map types to constructors

stateRecords :: [(QName, [Name])]

Map constructors to fields

stateNewtypes :: [(QName, Maybe QName, Type)]

Newtype constructor, destructor, wrapped type tuple

stateImported :: [(ModuleName, FilePath)]

Map of all imported modules and their source locations.

stateNameDepth :: Integer

Depth of the current lexical scope, used for creating unshadowing variables.

stateModuleName :: ModuleName

Name of the module currently being compiled.

stateJsModulePaths :: Set ModulePath

Module paths that have code generated for them.

stateUseFromString :: Bool

Use JS Strings instead of [Char] for string literals?

stateTypeSigs :: Map QName Type

Module level declarations having explicit type signatures

Instances

Show CompileState

MonadState CompileState Compile

data CompileResult

Constructors

CompileResult

Fields

resOutput :: String

resImported :: [(String, FilePath)]

resSourceMappings :: Maybe [Mapping]

Instances

Show CompileResult

compileFile :: Config -> FilePath -> IO (Either CompileError String)

Compile the given file.

compileFileWithState :: Config -> FilePath -> IO (Either CompileError (String, Maybe [Mapping], CompileState))

Compile a file returning the resulting internal state of the compiler. Don't use this directly, it's only exposed for the test suite.

compileFileWithResult :: Config -> FilePath -> IO (Either CompileError CompileResult)

Compile a file returning additional generated metadata.

compileFromTo :: Config -> FilePath -> Maybe FilePath -> IO ()

Compile the given file and write the output to the given path, or if nothing given, stdout.

compileFromToAndGenerateHtml :: Config -> FilePath -> FilePath -> IO (Either CompileError String)

Compile the given file and write to the output, also generates HTML and sourcemap files if configured.

toJsName :: String -> String

Convert a Haskell filename to a JS filename.

showCompileError :: CompileError -> String

Print a compile error for human consumption.

getConfigRuntime :: Config -> IO String

Get the JS runtime source. This will return the user supplied runtime if it exists.

getRuntime :: IO String

Get the default JS runtime source.