Repository files navigation

FSharpLint is a static analysis tool for F#. Like many other software linters, it analyzes your source code (using both typed and untyped syntax trees) and highlights any violations of defined F# coding rules. There are various kinds of rules:

• Conventions: ensures that your API members follow project- or solution-wide naming conventions.
• Smells: warns about logic that may pose maintainability problems or potential downsides.
• Formatting: checks that code is indented and structured according to specified cosmetic standards.

The tool is configurable via JSON and can be run as a console app or as an MSBuild task. It also provides an interface for easy integration into other software.

The project aims to let the user know of problems throughmatching user defined hints a laHLint, and also by using custom rules written in F# similar to the rules inMascot andStyleCop.

The tool in use (running as an MSBuild task with TreatWarningsAsErrors set to true):

FSharpLint can be used in several ways:

• Running as dotnet tool from command line.
• In VS Code using the Ionide-FSharp plugin.
• In Visual Studio using the F# Lint extension.
• As an MSBuild Task.
• In other editors through FsAutoComplete Language Server

Thedocs contain an overview of the tool and how to use it, including a list of theavailable rules for linting.

Package	Version
dotnet tool
API

1. Make sure you've installed the .NET version defined inglobal.json
2. Rundotnet tool restore to install all developer tools required to build the project
3. Runmake to build (which executes theBuild target from the FAKE-basedbuild script)
4. To run tests usemake check
5. To build documentation usemake docs

1. Make sure you've installed the .NET version defined inglobal.json
2. Rundotnet tool restore to install all developer tools required to build the project
3. Rundotnet fsi build.fsx to build default target ofbuild script
4. Build documentation to make sure everything is fine withdotnet fsi build.fsx -t Docs
5. Go to docs foldercd docs and start Fornax in watch modedotnet fornax watch
6. Your documentation should be now accessible onlocalhost:8080 and will be regenerated on every file save

Pleaseread the Releasing Guidelines if you're a maintainer.

Bug reports, feature requests, and pull requests are very welcome! Pleaseread the Contribution Guidelinesto get started.

The project is licensed under MIT. For more information on the license see the LICENSE file.

• @duckmatt
• @knocte
• @jgardella

The default maintainer account for projects under "fsprojects" is@fsprojectsgit - F# Community Project Incubation Space (repo management)