navigation

Lint

Namespace: FSharpLint.Application

Declared Types
Type Description
BuildFailure
ConfigurationParam
Context
LintFailure

Reason for the linter failing.

LintResult

Result of running the linter.

OptionalLintParameters

Optional parameters that can be provided to the linter.

ParsedFileInformation

If your application has already parsed the F# source files using FSharp.Compiler.Services you want to lint then this can be used to provide the parsed information to prevent the linter from parsing the file again.

ProjectProgress

Provides information on what the linter is currently doing.

RunAstNodeRulesConfig
RunLineRulesConfig

Values and Functions
Name Description
runAstNodeRules

Signature: runAstNodeRules arg1

Runs all rules which take a node of the AST as input.

getConfig

Signature: getConfig arg1

Gets a FSharpLint Configuration based on the provided ConfigurationParam.

runLineRules

Signature: runLineRules arg1

Runs all rules which take a line of text as input.

asyncLintSolution

Signature: asyncLintSolution optionalParams solutionFilePath toolsPath

Lints an entire F# solution by linting all projects specified in the .sln, slnx or .slnf file.

lintSolutionAsync

Signature: lintSolutionAsync optionalParams solutionFilePath toolsPath

Lints an entire F# solution by linting all projects specified in the .sln, slnx or .slnf file.

lintSolution

Signature: lintSolution optionalParams solutionFilePath toolsPath
asyncLintProject

Signature: asyncLintProject optionalParams projectFilePath toolsPath

Lints an entire F# project by retrieving the files from a given path to the .fsproj file.

lintProjectAsync

Signature: lintProjectAsync optionalParams projectFilePath toolsPath

Lints an entire F# project by retrieving the files from a given path to the .fsproj file.

lintProject

Signature: lintProject optionalParams projectFilePath toolsPath
asyncLintSource

Signature: asyncLintSource optionalParams source

Lints F# source code async.

lintSourceAsync

Signature: lintSourceAsync optionalParams source

Lints F# source code async.

lintSource

Signature: lintSource optionalParams source
lintParsedSource

Signature: lintParsedSource optionalParams parsedFileInfo

Lints F# source code that has already been parsed using FSharp.Compiler.Services in the calling application.

asyncLintFile

Signature: asyncLintFile optionalParams filePath

Lints an F# file from a given path to the .fs file.

lintFileAsync

Signature: lintFileAsync optionalParams filePath

Lints an F# file from a given path to the .fs file.

lintFile

Signature: lintFile optionalParams filePath
asyncLintFiles

Signature: asyncLintFiles optionalParams filePaths

Lints multiple F# files from given file paths.

lintFilesAsync

Signature: lintFilesAsync optionalParams filePaths

Lints multiple F# files from given file paths.

lintFiles

Signature: lintFiles optionalParams filePaths
lintParsedFile

Signature: lintParsedFile optionalParams parsedFileInfo filePath

Lints an F# file that has already been parsed using FSharp.Compiler.Services in the calling application.