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.


Values and Functions
Name Description
runAstNodeRules

Signature: runAstNodeRules arg1 arg2 arg3 arg4 arg5 arg6 arg7

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

runLineRules

Signature: runLineRules arg1 arg2 arg3 arg4 arg5 arg6

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

lintSolution

Signature: lintSolution optionalParams solutionFilePath toolsPath

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

lintProject

Signature: lintProject optionalParams projectFilePath toolsPath

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

lintSource

Signature: lintSource optionalParams source

Lints F# source code.

lintParsedSource

Signature: lintParsedSource optionalParams parsedFileInfo

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

lintFile

Signature: lintFile optionalParams filePath

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

lintParsedFile

Signature: lintParsedFile optionalParams parsedFileInfo filePath

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