Fantomas 4.7.7

There is a newer version of this package available.
See the version list below for details.
dotnet add package Fantomas --version 4.7.7
NuGet\Install-Package Fantomas -Version 4.7.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Fantomas" Version="4.7.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fantomas --version 4.7.7
#r "nuget: Fantomas, 4.7.7"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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.7

// Install Fantomas as a Cake Tool
#tool nuget:?package=Fantomas&version=4.7.7

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 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.

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
6.3.4 8,007 4/16/2024
6.3.3 1,600 4/12/2024
6.3.2 210 4/12/2024
6.3.1 6,046 3/30/2024
6.3.0 8,097 3/15/2024
6.3.0-beta-001 704 3/7/2024
6.3.0-alpha-008 781 3/1/2024
6.3.0-alpha-007 1,683 1/27/2024
6.3.0-alpha-006 813 1/9/2024
6.3.0-alpha-005 1,178 12/22/2023
6.3.0-alpha-004 1,864 12/6/2023
6.3.0-alpha-003 1,337 11/15/2023
6.3.0-alpha-002 904 11/7/2023
6.3.0-alpha-001 729 11/3/2023
6.2.3 80,794 11/2/2023
6.2.2 13,719 10/18/2023
6.2.1 8,753 9/18/2023
6.2.0 22,444 8/29/2023
6.1.3 1,392 8/25/2023
6.1.2 12,783 7/23/2023
6.1.1 23,721 6/29/2023
6.1.0 7,506 6/28/2023
6.1.0-alpha-006 1,083 6/20/2023
6.1.0-alpha-005 1,008 6/20/2023
6.1.0-alpha-004 818 6/19/2023
6.1.0-alpha-003 1,092 6/2/2023
6.1.0-alpha-002 956 5/2/2023
6.1.0-alpha-001 964 5/2/2023
6.0.8 1,926 6/20/2023
6.0.7 1,249 6/20/2023
6.0.6 1,437 6/19/2023
6.0.5 4,686 6/6/2023
6.0.4 1,285 6/2/2023
6.0.3 12,281 5/14/2023
6.0.2 3,904 5/5/2023
6.0.1 34,197 4/19/2023
6.0.0 24,609 4/13/2023
6.0.0-beta-001 1,457 4/5/2023
6.0.0-alpha-010 5,243 4/3/2023
6.0.0-alpha-009 796 3/31/2023
6.0.0-alpha-008 2,045 3/27/2023
6.0.0-alpha-007 1,333 3/27/2023
6.0.0-alpha-006 1,471 3/17/2023
6.0.0-alpha-005 2,348 2/24/2023
6.0.0-alpha-004 8,149 2/22/2023
6.0.0-alpha-003 2,918 2/4/2023
6.0.0-alpha-002 873 2/1/2023
6.0.0-alpha-001 1,008 1/24/2023
5.2.4 5,919 3/17/2023
5.2.3 5,402 3/6/2023
5.2.2 12,381 2/21/2023
5.2.1 39,850 2/4/2023
5.2.0 6,808 1/19/2023
5.2.0-alpha-012 1,140 1/14/2023
5.2.0-alpha-011 1,367 1/12/2023
5.2.0-alpha-010 1,069 12/30/2022
5.2.0-alpha-009 1,002 12/29/2022
5.2.0-alpha-008 1,027 12/28/2022
5.2.0-alpha-007 995 12/26/2022
5.2.0-alpha-006 998 12/22/2022
5.2.0-alpha-005 1,121 12/16/2022
5.2.0-alpha-004 1,240 12/8/2022
5.2.0-alpha-003 1,005 12/6/2022
5.2.0-alpha-002 957 12/4/2022
5.2.0-alpha-001 906 11/30/2022
5.1.5 24,254 12/22/2022
5.1.4 26,438 11/30/2022
5.1.3 7,029 11/14/2022
5.1.2 1,519 11/10/2022
5.1.1 4,042 11/7/2022
5.1.0 2,718 11/4/2022
5.1.0-beta-002 971 10/29/2022
5.1.0-beta-001 1,342 10/19/2022
5.1.0-alpha-007 1,021 10/14/2022
5.1.0-alpha-006 976 10/14/2022
5.1.0-alpha-005 1,119 10/7/2022
5.1.0-alpha-004 1,132 10/7/2022
5.1.0-alpha-003 1,133 10/2/2022
5.1.0-alpha-002 1,017 9/29/2022
5.1.0-alpha-001 1,067 9/18/2022
5.0.6 23,395 10/13/2022
5.0.5 8,087 10/7/2022
5.0.4 2,135 10/4/2022
5.0.3 10,229 9/29/2022
5.0.2 7,812 9/22/2022
5.0.1 5,245 9/18/2022
5.0.0 21,168 9/16/2022
5.0.0-beta-010 17,130 9/10/2022
5.0.0-beta-009 8,874 9/2/2022
5.0.0-beta-008 3,001 8/30/2022
5.0.0-beta-007 1,575 8/19/2022
5.0.0-beta-006 2,895 8/12/2022
5.0.0-beta-005 5,053 8/3/2022
5.0.0-beta-004 2,167 7/27/2022
5.0.0-beta-003 3,682 7/26/2022
5.0.0-beta-002 1,875 7/19/2022
5.0.0-beta-001 2,865 7/15/2022
5.0.0-alpha-011 1,589 7/8/2022
5.0.0-alpha-010 2,162 6/27/2022
5.0.0-alpha-009 67,609 6/21/2022
5.0.0-alpha-008 2,814 5/28/2022
5.0.0-alpha-007 1,818 5/16/2022
5.0.0-alpha-006 1,840 5/13/2022
5.0.0-alpha-005 1,321 5/7/2022
5.0.0-alpha-004 1,413 5/7/2022
5.0.0-alpha-003 1,873 5/6/2022
5.0.0-alpha-002 712 4/4/2022
5.0.0-alpha-001 673 3/19/2022
4.7.9 10,907 5/2/2022
4.7.8 10,510 4/25/2022
4.7.7 1,139 4/20/2022
4.7.6 1,409 4/4/2022
4.7.5 1,257 3/27/2022
4.7.4 1,227 3/25/2022
4.7.3 4,795 3/12/2022
4.7.2 1,133 3/11/2022
4.7.1 1,114 3/8/2022
4.7.0 1,266 3/4/2022
4.6.6 1,173 3/4/2022
4.6.5 1,913 2/18/2022
4.6.4 1,659 2/11/2022
4.6.3 1,724 2/8/2022
4.6.2 1,713 2/6/2022
4.6.1 1,692 2/1/2022
4.6.0 2,212 1/14/2022
4.6.0-beta-001 760 1/8/2022
4.6.0-alpha-011 756 12/29/2021
4.6.0-alpha-010 755 12/4/2021
4.6.0-alpha-009 3,414 11/24/2021
4.6.0-alpha-008 1,201 11/19/2021
4.6.0-alpha-007 804 11/7/2021
4.6.0-alpha-006 194 11/3/2021
4.6.0-alpha-005 219 10/27/2021
4.6.0-alpha-004 198 10/20/2021
4.6.0-alpha-003 178 10/5/2021
4.6.0-alpha-002 190 9/7/2021
4.6.0-alpha-001 166 8/11/2021
4.5.12 1,578 1/8/2022
4.5.11 2,357 12/29/2021
4.5.10 2,611 12/4/2021
4.5.9 7,500 11/24/2021
4.5.8 1,717 11/19/2021
4.5.7 1,545 11/7/2021
4.5.6 1,341 11/3/2021
4.5.5 1,497 10/27/2021
4.5.4 1,402 10/5/2021
4.5.3 2,906 9/7/2021
4.5.2 1,548 8/11/2021
4.5.1 3,362 7/24/2021
4.5.0 3,317 7/7/2021
4.5.0-beta-005 868 7/6/2021
4.5.0-beta-004 857 7/5/2021
4.5.0-beta-003 887 7/5/2021
4.5.0-beta-002 881 6/27/2021
4.5.0-beta-001 1,375 6/5/2021
4.5.0-alpha-020 847 5/26/2021
4.5.0-alpha-019 839 5/22/2021
4.5.0-alpha-018 864 5/21/2021
4.5.0-alpha-017 837 5/15/2021
4.5.0-alpha-016 806 5/9/2021
4.5.0-alpha-015 914 5/8/2021
4.5.0-alpha-014 924 4/30/2021
4.5.0-alpha-013 879 4/27/2021
4.5.0-alpha-012 836 4/23/2021
4.5.0-alpha-011 947 4/20/2021
4.5.0-alpha-010 861 4/14/2021
4.5.0-alpha-009 872 4/11/2021
4.5.0-alpha-008 872 4/8/2021
4.5.0-alpha-007 891 4/8/2021
4.5.0-alpha-006 840 4/5/2021
4.5.0-alpha-005 856 4/3/2021
4.5.0-alpha-004 888 4/2/2021
4.5.0-alpha-003 902 3/28/2021
4.5.0-alpha-002 894 3/22/2021
4.5.0-alpha-001 2,519 2/26/2021
4.4.0 12,948 2/25/2021
4.4.0-beta-008 929 2/19/2021
4.4.0-beta-007 933 2/12/2021
4.4.0-beta-006 925 2/12/2021
4.4.0-beta-005 985 2/9/2021
4.4.0-beta-004 967 2/5/2021
4.4.0-beta-003 1,407 1/30/2021
4.4.0-beta-002 953 1/23/2021
4.4.0-beta-001 1,356 1/22/2021
4.4.0-alpha-008 1,139 1/15/2021
4.4.0-alpha-007 1,622 12/26/2020
4.4.0-alpha-006 1,034 12/25/2020
4.4.0-alpha-005 1,118 12/23/2020
4.4.0-alpha-004 1,132 12/22/2020
4.4.0-alpha-003 1,153 12/18/2020
4.4.0-alpha-002 1,126 12/17/2020
4.4.0-alpha-001 1,022 12/17/2020
4.3.0 5,539 12/17/2020
4.3.0-beta-002 1,077 12/11/2020
4.3.0-beta-001 1,022 12/7/2020
4.3.0-alpha-007 1,052 11/21/2020
4.3.0-alpha-006 1,047 11/20/2020
4.3.0-alpha-005 997 11/16/2020
4.3.0-alpha-004 1,505 11/12/2020
4.3.0-alpha-003 1,076 11/10/2020
4.3.0-alpha-002 1,056 10/26/2020
4.3.0-alpha-001 1,085 10/23/2020
4.2.0 4,907 9/25/2020
4.2.0-alpha-004 1,228 9/23/2020
4.2.0-alpha-003 1,026 9/21/2020
4.2.0-alpha-002 1,111 9/19/2020
4.2.0-alpha-001 1,155 9/18/2020
4.1.1 1,720 9/17/2020
4.1.0 1,942 9/10/2020
4.1.0-beta-004 1,185 9/5/2020
4.1.0-beta-003 1,125 9/4/2020
4.1.0-beta-002 1,464 9/4/2020
4.1.0-beta-001 1,072 9/3/2020
4.1.0-alpha-001 1,076 9/1/2020
4.0.0 4,070 8/27/2020
4.0.0-beta-003 1,107 8/21/2020
4.0.0-beta-002 1,189 8/7/2020
4.0.0-beta-001 1,508 7/20/2020
4.0.0-alpha-014 1,317 7/14/2020
4.0.0-alpha-013 1,116 7/11/2020
4.0.0-alpha-012 1,875 7/6/2020
4.0.0-alpha-011 975 6/25/2020
4.0.0-alpha-010 1,350 6/18/2020
4.0.0-alpha-009 1,028 6/12/2020
4.0.0-alpha-008 1,144 6/2/2020
4.0.0-alpha-007 1,022 6/1/2020
4.0.0-alpha-006 2,234 5/23/2020
4.0.0-alpha-005 2,047 5/16/2020
4.0.0-alpha-004 1,439 5/4/2020
4.0.0-alpha-003 1,083 5/3/2020
4.0.0-alpha-002 1,130 4/26/2020
4.0.0-alpha-001 1,027 4/20/2020
3.3.0 12,763 2/28/2020
3.3.0-beta-002 1,967 2/21/2020
3.3.0-beta-001 1,141 2/18/2020
3.2.0 21,149 2/3/2020
3.2.0-beta-002 1,710 1/7/2020
3.2.0-beta-001 1,270 12/26/2019
3.1.0 10,643 11/27/2019
3.0.0 4,993 10/11/2019
3.0.0-beta-006 1,848 10/2/2019
3.0.0-beta-005 1,035 9/27/2019
3.0.0-beta-004 1,611 9/18/2019
3.0.0-beta-003 1,155 9/13/2019
3.0.0-beta-002 16,359 7/20/2019
3.0.0-beta-001 5,837 7/12/2019
2.9.2 25,600 2/2/2019
2.9.1 4,929 11/20/2018
2.9.0 11,232 10/17/2018
2.8.1 2,737 9/12/2018
2.8.0 5,951 7/7/2018
2.7.1 4,833 5/2/2018
2.7.0 2,480 5/2/2018
2.6.1 45,663 4/22/2017
2.5.0 2,923 2/19/2017
2.4.0 3,024 10/24/2016
2.3.0 2,690 7/9/2016
2.2.0 2,436 4/24/2016
2.1.0 2,329 4/1/2016
2.0.2 9,068 11/15/2015
1.11.0 2,864 9/12/2015
1.10.0 2,219 8/29/2015
1.9.0 2,667 8/10/2015
1.8.0-beta 1,850 7/19/2015
1.7.0 2,321 6/10/2015
1.6.0 3,199 10/25/2014
1.5.0 2,658 9/18/2014
1.4.0 3,032 7/1/2014
1.3.0 2,523 5/17/2014
1.2.0 2,534 4/21/2014
1.1.0 2,443 3/29/2014
1.0.7 2,402 3/12/2014
1.0.5.1 2,499 1/15/2014
1.0.5 2,231 1/7/2014
1.0.4 2,315 11/16/2013
1.0.3 2,331 10/6/2013
1.0.2 2,272 8/16/2013
1.0.1 2,460 7/22/2013
1.0.0 5,352 7/16/2013
0.9.9.2 2,668 7/2/2013
0.9.9.1 2,438 6/22/2013
0.9.8 2,428 6/14/2013
0.9.7 2,375 6/7/2013
0.9.6 2,366 5/31/2013
0.9.5 2,452 5/23/2013
0.9.4 2,304 5/19/2013
0.9.3 2,334 5/9/2013
0.9.2 2,347 5/3/2013
0.9.1 2,567 4/26/2013
0.9.0 2,350 4/19/2013
0.8.9 2,413 4/12/2013
0.8.8 2,379 4/11/2013
0.8.7 2,296 4/9/2013
0.8.6 2,312 4/4/2013
0.8.5 2,398 4/2/2013
0.8.4 2,323 4/1/2013
0.8.3 2,388 4/1/2013
0.8.2 2,277 4/1/2013
0.8.1 2,459 3/31/2013
0.8.0 2,397 3/31/2013

### Fixed
* Multiline parentheses objectExpression in indexer expression. [#2176](https://github.com/fsprojects/fantomas/issues/2176)
* Blank line over SynEnumCase is restored incorrectly. [#2155](https://github.com/fsprojects/fantomas/issues/2155)
* XML Doc comments on DU cases seem to get shuffled. [#2188](https://github.com/fsprojects/fantomas/issues/2188)
* Comment after bar is lost in single case DU. [#2182](https://github.com/fsprojects/fantomas/issues/2182)
* Piped lambda with if-then-else can break code. [#2196](https://github.com/fsprojects/fantomas/issues/2196)