Fantomas 4.7.9

.NET Standard 2.0
There is a newer prerelease version of this package available.
See the version list below for details.
Install-Package Fantomas -Version 4.7.9
dotnet add package Fantomas --version 4.7.9
<PackageReference Include="Fantomas" Version="4.7.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fantomas --version 4.7.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Fantomas, 4.7.9"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Fantomas as a Cake Addin
#addin nuget:?package=Fantomas&version=4.7.9

// Install Fantomas as a Cake Tool
#tool nuget:?package=Fantomas&version=4.7.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Fantomas

Fantomas logo

F# source code formatter, inspired by scalariform for Scala, ocp-indent for OCaml and PythonTidy for Python.

Build Status Github Actions Discord

Quick install

How to use

Command line tool / API

Use this command to install Fantomas as a .NET 5 SDK global tool:

dotnet tool install -g fantomas-tool

For detailed guidelines, please read Fantomas: How to use.

FAKE build system

Fantomas can be easily integrated with FAKE build system.<br /> Check out the sample.

JetBrains Rider

The resharper-fsharp uses fantomas under the hood to format the source code. No need for any additional plugins.

Using the latest version inside Rider

For technical reasons Rider cannot always use the latest version of Fantomas found on NuGet. As a workaround you could install fantomas-tool locally with dotnet tool install fantomas-tool and configure it as an External tool.

Rider external tool window

Rider action window

This will have an impact on your editing experiencing in Rider, the external change to the file by the command line application might trigger more internal logic inside Rider than necessary. It could be noticeable in regards to the default formatting experience.

Visual Studio Code

The recommended way to use Fantomas is by using the Ionide plugin. Fantomas is integrated in FSAutoComplete which is the language server used by Ionide.

Alternatively, you can install the fantomas-fmt extension.

Visual Studio

The F# Formatting extension sets up Fantomas as the default formatter for F# files, configurable from Visual Studio's options.

Visual Studio for Mac

Install fantomas-tool locally with dotnet tool install fantomas-tool and configure it as an [External tool]

VS Mac external tool window

Online

Try the Fantomas online.

Early builds

Every once in a while an alpha or beta version is published to https://www.nuget.org/. Our previous MyGet feed is now deprecated.

Benchmarks

Some figures can be found at https://fsprojects.github.io/fantomas/ <br/> We use BenchmarkDotNet to collect data for each build on the master branch.

Purpose

This project aims at formatting F# source files based on a given configuration. Fantomas will ensure correct indentation and consistent spacing between elements in the source files. We assume that the source files are parsable by F# compiler before feeding into the tool. Fantomas follows two F# style guides: the F# code formatting guidelines from Microsoft by default and the G-Research F# code formatting guidelines via various settings.

Use cases

The project is developed with the following use cases in mind:

  • Reformatting an unfamiliar code base. It gives readability when you are not the one originally writing the code. To illustrate, the following example

     type Type
         = TyLam of Type * Type
         | TyVar of string
         | TyCon of string * Type list
         with override this.ToString () =
                 match this with
                 | TyLam (t1, t2) -> sprintf "(%s -> %s)" (t1.ToString()) (t2.ToString())
                 | TyVar a -> a
                 | TyCon (s, ts) -> s
    

    will be rewritten to

     type Type =
         | TyLam of Type * Type
         | TyVar of string
         | TyCon of string * Type list
         override this.ToString() =
             match this with
             | TyLam(t1, t2) -> sprintf "(%s -> %s)" (t1.ToString()) (t2.ToString())
             | TyVar a -> a
             | TyCon(s, ts) -> s
    
  • Converting from verbose syntax to light syntax. Feeding a source file in verbose mode, Fantomas will format it appropriately in light mode. This might be helpful for code generation since generating verbose source files is much easier. For example, this code fragment

     let Multiple9x9 () =
         for i in 1 .. 9 do
             printf "\n";
             for j in 1 .. 9 do
                 let k = i * j in
                 printf "%d x %d = %2d " i j k;
             done;
         done;;
     Multiple9x9 ();;
    

    is reformulated to

     let Multiple9x9() =
         for i in 1..9 do
             printf "\n"
             for j in 1..9 do
                 let k = i * j
                 printf "%d x %d = %2d " i j k
    
     Multiple9x9()
    
  • Formatting F# signatures, especially those generated by F# compiler and F# Interactive.

For more complex examples, please take a look at F# outputs of 20 language shootout programs and 10 CodeReview.SE source files.

Why the name "Fantomas"?

There are a few reasons to choose the name as such. First, it starts with an "F" just like many other F# projects. Second, Fantomas is my favourite character in the literature. Finally, Fantomas has the same Greek root as "phantom"; coincidentally F# ASTs and formatting rules are so mysterious to be handled correctly.

Contributing Guidelines

See the Contribution Guidelines.

Credits

We would like to gratefully thank the following persons for their contributions.

License

The library and tool are available under Apache 2.0 license. For more information see the License file.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Fantomas:

Package Downloads
dotnet-fantomas

This library aims at formatting F# source files based on a given configuration. Fantomas will ensure correct indentation and consistent spacing between elements in the source files. Some common use cases include (1) Reformatting a code base to conform a universal page width (2) Converting legacy code from verbose syntax to light syntax (3) Formatting auto-generated F# signatures.

Myriad.Core

Core Myriad library used for developing plugins

Falanx.Machinery

Package Description

GiraffeGenerator.Core

Package Description

CellScript.FCS

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0-alpha-007 151 5/16/2022
5.0.0-alpha-006 384 5/13/2022
5.0.0-alpha-005 145 5/7/2022
5.0.0-alpha-004 363 5/7/2022
5.0.0-alpha-003 56 5/6/2022
5.0.0-alpha-002 60 4/4/2022
5.0.0-alpha-001 44 3/19/2022
4.7.9 627 5/2/2022
4.7.8 828 4/25/2022
4.7.7 88 4/20/2022
4.7.6 228 4/4/2022
4.7.5 149 3/27/2022
4.7.4 77 3/25/2022
4.7.3 3,686 3/12/2022
4.7.2 75 3/11/2022
4.7.1 78 3/8/2022
4.7.0 161 3/4/2022
4.6.6 79 3/4/2022
4.6.5 527 2/18/2022
4.6.4 130 2/11/2022
4.6.3 119 2/8/2022
4.6.2 191 2/6/2022
4.6.1 172 2/1/2022
4.6.0 569 1/14/2022
4.6.0-beta-001 72 1/8/2022
4.6.0-alpha-011 78 12/29/2021
4.6.0-alpha-010 87 12/4/2021
4.6.0-alpha-009 2,749 11/24/2021
4.6.0-alpha-008 562 11/19/2021
4.6.0-alpha-007 160 11/7/2021
4.6.0-alpha-006 111 11/3/2021
4.6.0-alpha-005 140 10/27/2021
4.6.0-alpha-004 109 10/20/2021
4.6.0-alpha-003 99 10/5/2021
4.6.0-alpha-002 102 9/7/2021
4.6.0-alpha-001 86 8/11/2021
4.5.12 447 1/8/2022
4.5.11 1,350 12/29/2021
4.5.10 1,034 12/4/2021
4.5.9 6,215 11/24/2021
4.5.8 689 11/19/2021
4.5.7 536 11/7/2021
4.5.6 378 11/3/2021
4.5.5 551 10/27/2021
4.5.4 406 10/5/2021
4.5.3 1,940 9/7/2021
4.5.2 499 8/11/2021
4.5.1 1,788 7/24/2021
4.5.0 2,283 7/7/2021
4.5.0-beta-005 228 7/6/2021
4.5.0-beta-004 209 7/5/2021
4.5.0-beta-003 216 7/5/2021
4.5.0-beta-002 223 6/27/2021
4.5.0-beta-001 723 6/5/2021
4.5.0-alpha-020 219 5/26/2021
4.5.0-alpha-019 192 5/22/2021
4.5.0-alpha-018 196 5/21/2021
4.5.0-alpha-017 249 5/15/2021
4.5.0-alpha-016 183 5/9/2021
4.5.0-alpha-015 235 5/8/2021
4.5.0-alpha-014 228 4/30/2021
4.5.0-alpha-013 204 4/27/2021
4.5.0-alpha-012 184 4/23/2021
4.5.0-alpha-011 267 4/20/2021
4.5.0-alpha-010 208 4/14/2021
4.5.0-alpha-009 203 4/11/2021
4.5.0-alpha-008 231 4/8/2021
4.5.0-alpha-007 231 4/8/2021
4.5.0-alpha-006 199 4/5/2021
4.5.0-alpha-005 208 4/3/2021
4.5.0-alpha-004 229 4/2/2021
4.5.0-alpha-003 245 3/28/2021
4.5.0-alpha-002 191 3/22/2021
4.5.0-alpha-001 1,801 2/26/2021
4.4.0 8,425 2/25/2021
4.4.0-beta-008 245 2/19/2021
4.4.0-beta-007 231 2/12/2021
4.4.0-beta-006 232 2/12/2021
4.4.0-beta-005 231 2/9/2021
4.4.0-beta-004 235 2/5/2021
4.4.0-beta-003 672 1/30/2021
4.4.0-beta-002 233 1/23/2021
4.4.0-beta-001 661 1/22/2021
4.4.0-alpha-008 455 1/15/2021
4.4.0-alpha-007 950 12/26/2020
4.4.0-alpha-006 343 12/25/2020
4.4.0-alpha-005 401 12/23/2020
4.4.0-alpha-004 454 12/22/2020
4.4.0-alpha-003 440 12/18/2020
4.4.0-alpha-002 379 12/17/2020
4.4.0-alpha-001 310 12/17/2020
4.3.0 2,619 12/17/2020
4.3.0-beta-002 383 12/11/2020
4.3.0-beta-001 315 12/7/2020
4.3.0-alpha-007 374 11/21/2020
4.3.0-alpha-006 332 11/20/2020
4.3.0-alpha-005 289 11/16/2020
4.3.0-alpha-004 779 11/12/2020
4.3.0-alpha-003 318 11/10/2020
4.3.0-alpha-002 327 10/26/2020
4.3.0-alpha-001 363 10/23/2020
4.2.0 3,775 9/25/2020
4.2.0-alpha-004 515 9/23/2020
4.2.0-alpha-003 329 9/21/2020
4.2.0-alpha-002 374 9/19/2020
4.2.0-alpha-001 445 9/18/2020
4.1.1 656 9/17/2020
4.1.0 893 9/10/2020
4.1.0-beta-004 476 9/5/2020
4.1.0-beta-003 374 9/4/2020
4.1.0-beta-002 787 9/4/2020
4.1.0-beta-001 372 9/3/2020
4.1.0-alpha-001 364 9/1/2020
4.0.0 2,693 8/27/2020
4.0.0-beta-003 391 8/21/2020
4.0.0-beta-002 469 8/7/2020
4.0.0-beta-001 794 7/20/2020
4.0.0-alpha-014 639 7/14/2020
4.0.0-alpha-013 407 7/11/2020
4.0.0-alpha-012 681 7/6/2020
4.0.0-alpha-011 286 6/25/2020
4.0.0-alpha-010 672 6/18/2020
4.0.0-alpha-009 308 6/12/2020
4.0.0-alpha-008 445 6/2/2020
4.0.0-alpha-007 294 6/1/2020
4.0.0-alpha-006 1,095 5/23/2020
4.0.0-alpha-005 1,048 5/16/2020
4.0.0-alpha-004 740 5/4/2020
4.0.0-alpha-003 372 5/3/2020
4.0.0-alpha-002 398 4/26/2020
4.0.0-alpha-001 287 4/20/2020
3.3.0 10,535 2/28/2020
3.3.0-beta-002 1,255 2/21/2020
3.3.0-beta-001 415 2/18/2020
3.2.0 19,614 2/3/2020
3.2.0-beta-002 1,014 1/7/2020
3.2.0-beta-001 559 12/26/2019
3.1.0 9,585 11/27/2019
3.0.0 4,021 10/11/2019
3.0.0-beta-006 1,129 10/2/2019
3.0.0-beta-005 327 9/27/2019
3.0.0-beta-004 921 9/18/2019
3.0.0-beta-003 452 9/13/2019
3.0.0-beta-002 13,890 7/20/2019
3.0.0-beta-001 5,075 7/12/2019
2.9.2 22,256 2/2/2019
2.9.1 3,268 11/20/2018
2.9.0 7,831 10/17/2018
2.8.1 1,374 9/12/2018
2.8.0 4,642 7/7/2018
2.7.1 3,511 5/2/2018
2.7.0 1,114 5/2/2018
2.6.1 44,530 4/22/2017
2.5.0 1,868 2/19/2017
2.4.0 1,967 10/24/2016
2.3.0 1,652 7/9/2016
2.2.0 1,364 4/24/2016
2.1.0 1,255 4/1/2016
2.0.2 7,980 11/15/2015
1.11.0 1,818 9/12/2015
1.10.0 1,172 8/29/2015
1.9.0 1,585 8/10/2015
1.8.0-beta 1,093 7/19/2015
1.7.0 1,326 6/10/2015
1.6.0 2,159 10/25/2014
1.5.0 1,580 9/18/2014
1.4.0 1,934 7/1/2014
1.3.0 1,477 5/17/2014
1.2.0 1,475 4/21/2014
1.1.0 1,346 3/29/2014
1.0.7 1,347 3/12/2014
1.0.5.1 1,394 1/15/2014
1.0.5 1,148 1/7/2014
1.0.4 1,198 11/16/2013
1.0.3 1,215 10/6/2013
1.0.2 1,185 8/16/2013
1.0.1 1,338 7/22/2013
1.0.0 1,476 7/16/2013
0.9.9.2 1,541 7/2/2013
0.9.9.1 1,356 6/22/2013
0.9.8 1,324 6/14/2013
0.9.7 1,300 6/7/2013
0.9.6 1,241 5/31/2013
0.9.5 1,366 5/23/2013
0.9.4 1,242 5/19/2013
0.9.3 1,227 5/9/2013
0.9.2 1,240 5/3/2013
0.9.1 1,523 4/26/2013
0.9.0 1,292 4/19/2013
0.8.9 1,299 4/12/2013
0.8.8 1,246 4/11/2013
0.8.7 1,223 4/9/2013
0.8.6 1,227 4/4/2013
0.8.5 1,306 4/2/2013
0.8.4 1,245 4/1/2013
0.8.3 1,257 4/1/2013
0.8.2 1,224 4/1/2013
0.8.1 1,301 3/31/2013
0.8.0 1,281 3/31/2013

### Changed
* Add `fable_modules` to the directories which are always excluded. [Fable 3.4](https://github.com/fable-compiler/Fable/releases/tag/3.4.0)

### Fixed
* Let binding after match lambda is moved outside of nested module. [#2214](https://github.com/fsprojects/fantomas/issues/2214)