Header menu logo FSharp.Formatting

CodeFormatter Module

Uses agent to handle formatting requests

Functions and values

Function or value Description

ParseAndCheckSource (file, source, options, defines, onError)

Full Usage: ParseAndCheckSource (file, source, options, defines, onError)

Parameters:
    file : string
    source : string
    options : string option
    defines : string option
    onError : string -> unit

Returns: Snippet[] * SourceError[]

Parse, check and annotate the source code specified by 'source', assuming that it is located in a specified 'file'. Optional arguments can be used to give compiler command line options and preprocessor definitions

file : string
source : string
options : string option
defines : string option
onError : string -> unit
Returns: Snippet[] * SourceError[]

categoryToTokenKind _arg1

Full Usage: categoryToTokenKind _arg1

Parameters:
Returns: TokenKind option
_arg1 : SemanticClassificationType
Returns: TokenKind option

fsChecker

Full Usage: fsChecker

Returns: FSharpChecker
Returns: FSharpChecker

processDoubleBackticks body

Full Usage: processDoubleBackticks body

Parameters:
    body : string

Returns: string
body : string
Returns: string

processSnippet checkResults categorizedRanges lines snippet

Full Usage: processSnippet checkResults categorizedRanges lines snippet

Parameters:
Returns: Line list

Process snippet

checkResults : FSharpCheckFileResults
categorizedRanges : Map<int, 'a>
lines : string array
snippet : Snippet
Returns: Line list

processSnippetLine checkResults semanticRanges lines (line, lineTokens)

Full Usage: processSnippetLine checkResults semanticRanges lines (line, lineTokens)

Parameters:
Returns: Line
checkResults : FSharpCheckFileResults
semanticRanges : SemanticClassificationItem array
lines : string array
line : int
lineTokens : SnippetLine
Returns: Line

processSourceCode (filePath, source, options, defines, onError)

Full Usage: processSourceCode (filePath, source, options, defines, onError)

Parameters:
    filePath : string
    source : string
    options : string option
    defines : string option
    onError : string -> unit

Returns: Async<Snippet[] * SourceError[]>
filePath : string
source : string
options : string option
defines : string option
onError : string -> unit
Returns: Async<Snippet[] * SourceError[]>

Type something to start searching.