Skip to content
F# Other
  1. F# 99.4%
  2. Other 0.6%
Branch: master
Clone or download

Latest commit

milbrandt Fix Docu (rule numbers, missing examples) (#394)
* fix rule numbers

* increment heading level only by one

* missing example in section Rule settings (extracted from DefaultSettings.json)

* generated docs

* missing example for FL0028
Latest commit 0b405d7 Mar 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix headings in MD files (#353) Jun 12, 2019
.nuget Updated nuget exe Aug 5, 2016
.paket
docs-gen Fix Docu (rule numbers, missing examples) (#394) Mar 28, 2020
docs
src remove local rule settings parameter (#397) Mar 28, 2020
tests Add `globals` section to config for shared settings (#390) Mar 4, 2020
.gitattributes Added .gitattributes Jul 17, 2015
.gitignore Update to FCS 29.0 (#342) May 29, 2019
.travis.yml use a version of sdk installed in appveyor Feb 28, 2019
Directory.Build.props
Directory.Build.targets Run linter against repo (#389) Mar 3, 2020
FSharpLint.sln Redesign & refactor linter (#330) Apr 30, 2019
LICENSE Changed license from GPLv3 to MIT Feb 24, 2017
NuGet.Config Move to dotnet core Oct 28, 2018
README.md Bugfix/outdated (#391) Mar 23, 2020
RELEASE_NOTES.md
appveyor.yml
build.cmd Move to dotnet core Oct 28, 2018
build.fsx
build.fsx.lock Move to dotnet core Oct 28, 2018
build.proj fix build (#374) Jan 13, 2020
build.sh
fsharplint.json Run linter against repo (#389) Mar 3, 2020
global.json use a version of sdk installed in appveyor Feb 28, 2019
paket.dependencies Run linter against repo (#389) Mar 3, 2020
paket.lock Run linter against repo (#389) Mar 3, 2020

README.md

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):

Example

Usage

FSharpLint can be used in several ways:

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 NuGet Status
API NuGet Status

Build Status

Mono 4.0.2 .NET 4.5
Mono CI Build Status .NET CI Build status

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)

You can’t perform that action at this time.