FSharpLint
FSharpLint is a style checking tool for F#. It points out locations where a set of rules on how F# is to be styled have been broken. The tool is configurable via JSON and can be run from a console app, or as an MSBuild task. It also provides an interface to easily integrate the tool into other software.
The project aims to let the user know of problems through matching user defined hints a la HLint, and also by using custom rules written in F# similar to the rules in Mascot and StyleCop.
The tool in use (running as an MSBuild task with TreatWarningsAsErrors set to true):
Usage
FSharpLint can be used in several ways:
- Running as dotnet tool from command line.
- In VS Code using the Ionide-FSharp plugin.
- In other IDEs (Visual Studio, Rider) as an MSBuild Task.
- In other editors through FsAutoComplete Language Server
Documentation
The docs contains an overview of the tool and how to use it, including a list of the available rules for linting.
Nuget Packages
| Package | Version |
|---|---|
| dotnet tool |  |
| API |  |
Build Status
| Mono 4.0.2 | .NET Core 3.1 |
|---|---|
 |
Licensing
The project is licensed under MIT. For more information on the license see the LICENSE file.
Contact
Feel free to post an issue on github if you have any questions, have suggestions, or have found a defect.
Maintainer(s)
The default maintainer account for projects under "fsprojects" is @fsprojectsgit - F# Community Project Incubation Space (repo management)