CodeFormatter.fsi

namespace Fantomas

open Fantomas.FormatConfig
open Fantomas.SourceOrigin
open FSharp.Compiler.Range
open FSharp.Compiler.SourceCodeServices
open FSharp.Compiler.SyntaxTree

[<Sealed>]
type CodeFormatter =
    /// Parse a source string using given config
    static member ParseAsync : fileName:string * source:SourceOrigin * parsingOptions: FSharpParsingOptions * checker:FSharpChecker -> Async<(ParsedInput * string list) array>

    /// Format an abstract syntax tree using an optional source for trivia processing
    static member FormatASTAsync : ast:ParsedInput * fileName:string * defines:string list * source:SourceOrigin option * config:FormatConfig -> Async<string>

    /// Format a source string using given config
    static member FormatDocumentAsync : 
        fileName:string * source:SourceOrigin * config:FormatConfig  * parsingOptions: FSharpParsingOptions * checker:FSharpChecker -> Async<string>

    /// Format a part of source string using given config, and return the (formatted) selected part only.
    /// Beware that the range argument is inclusive. If the range has a trailing newline, it will appear in the formatted result.
    static member FormatSelectionAsync : 
        fileName:string * selection:range * source:SourceOrigin * config:FormatConfig * parsingOptions: FSharpParsingOptions * checker:FSharpChecker -> Async<string>

    /// Check whether an input string is invalid in F# by looking for erroneous nodes in ASTs
    static member IsValidFSharpCodeAsync : fileName:string * source:SourceOrigin * parsingOptions: FSharpParsingOptions * checker:FSharpChecker -> Async<bool>

    static member IsValidASTAsync : ast:ParsedInput -> Async<bool>

    static member MakePos : line:int * col:int -> pos
    static member MakeRange : fileName:string * startLine:int * startCol:int * endLine:int * endCol:int -> range

    /// Returns the version of Fantomas found in the AssemblyInfo
    static member GetVersion : unit -> string

    /// Accepts a file or a folder and parses the found json to a FormatConfig
    /// Configuration found in parent folders will be applied first.
    static member ReadConfiguration : string -> FormatConfigFileParseResult