fantomas 5.0.0-beta-004

This is a prerelease version of fantomas.
There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global fantomas --version 5.0.0-beta-004                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local fantomas --version 5.0.0-beta-004                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=fantomas&version=5.0.0-beta-004&prerelease                
nuke :add-package fantomas --version 5.0.0-beta-004                

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

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 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 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 "(%O -> %O)" t1 t2
                 | 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 "(%O -> %O)" t1 t2
             | 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 net6.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
7.0.1 6,516 2/21/2025
7.0.0 20,593 1/10/2025
7.0.0-beta-001 228 12/30/2024
7.0.0-alpha-004 940 12/12/2024
7.0.0-alpha-003 489 11/29/2024
7.0.0-alpha-002 268 11/2/2024
7.0.0-alpha-001 132 9/16/2024
6.3.16 31,194 10/29/2024
6.3.15 22,193 9/14/2024
6.3.14 198 9/14/2024
6.3.13 1,150 9/10/2024
6.3.12 8,602 9/5/2024
6.3.11 21,305 8/16/2024
6.3.10 62,454 7/12/2024
6.3.9 34,352 6/9/2024
6.3.8 1,215 6/6/2024
6.3.7 2,111 6/1/2024
6.3.6 261 6/1/2024
6.3.5 951 5/30/2024
6.3.4 31,774 4/16/2024
6.3.3 7,096 4/12/2024
6.3.2 427 4/12/2024
6.3.1 12,662 3/30/2024
6.3.0 14,616 3/15/2024
6.3.0-beta-001 1,141 3/7/2024
6.3.0-alpha-008 825 3/1/2024
6.3.0-alpha-007 2,042 1/27/2024
6.3.0-alpha-006 841 1/9/2024
6.3.0-alpha-005 1,220 12/22/2023
6.3.0-alpha-004 1,922 12/6/2023
6.3.0-alpha-003 1,480 11/15/2023
6.3.0-alpha-002 934 11/7/2023
6.3.0-alpha-001 780 11/3/2023
6.2.3 135,716 11/2/2023
6.2.2 30,719 10/18/2023
6.2.1 10,554 9/18/2023
6.2.0 24,630 8/29/2023
6.1.3 1,470 8/25/2023
6.1.2 15,214 7/23/2023
6.1.1 78,519 6/29/2023
6.1.0 7,554 6/28/2023
6.1.0-alpha-006 1,112 6/20/2023
6.1.0-alpha-005 1,037 6/20/2023
6.1.0-alpha-004 850 6/19/2023
6.1.0-alpha-003 1,123 6/2/2023
6.1.0-alpha-002 988 5/2/2023
6.1.0-alpha-001 996 5/2/2023
6.0.8 2,091 6/20/2023
6.0.7 1,295 6/20/2023
6.0.6 1,482 6/19/2023
6.0.5 5,201 6/6/2023
6.0.4 1,339 6/2/2023
6.0.3 12,852 5/14/2023
6.0.2 4,240 5/5/2023
6.0.1 75,686 4/19/2023
6.0.0 53,749 4/13/2023
6.0.0-beta-001 1,510 4/5/2023
6.0.0-alpha-010 7,814 4/3/2023
6.0.0-alpha-009 831 3/31/2023
6.0.0-alpha-008 2,086 3/27/2023
6.0.0-alpha-007 1,364 3/27/2023
6.0.0-alpha-006 1,501 3/17/2023
6.0.0-alpha-005 2,382 2/24/2023
6.0.0-alpha-004 9,289 2/22/2023
6.0.0-alpha-003 2,969 2/4/2023
6.0.0-alpha-002 909 2/1/2023
6.0.0-alpha-001 1,049 1/24/2023
5.2.4 6,214 3/17/2023
5.2.3 5,628 3/6/2023
5.2.2 13,628 2/21/2023
5.2.1 70,667 2/4/2023
5.2.0 6,882 1/19/2023
5.2.0-alpha-012 1,183 1/14/2023
5.2.0-alpha-011 1,401 1/12/2023
5.2.0-alpha-010 1,105 12/30/2022
5.2.0-alpha-009 1,038 12/29/2022
5.2.0-alpha-008 1,292 12/28/2022
5.2.0-alpha-007 1,031 12/26/2022
5.2.0-alpha-006 1,035 12/22/2022
5.2.0-alpha-005 1,162 12/16/2022
5.2.0-alpha-004 1,274 12/8/2022
5.2.0-alpha-003 1,046 12/6/2022
5.2.0-alpha-002 1,000 12/4/2022
5.2.0-alpha-001 942 11/30/2022
5.1.5 25,641 12/22/2022
5.1.4 27,312 11/30/2022
5.1.3 7,827 11/14/2022
5.1.2 1,562 11/10/2022
5.1.1 4,088 11/7/2022
5.1.0 2,782 11/4/2022
5.1.0-beta-002 1,009 10/29/2022
5.1.0-beta-001 1,379 10/19/2022
5.1.0-alpha-007 1,057 10/14/2022
5.1.0-alpha-006 1,014 10/14/2022
5.1.0-alpha-005 1,159 10/7/2022
5.1.0-alpha-004 1,171 10/7/2022
5.1.0-alpha-003 1,179 10/2/2022
5.1.0-alpha-002 1,065 9/29/2022
5.1.0-alpha-001 1,105 9/18/2022
5.0.6 25,372 10/13/2022
5.0.5 10,428 10/7/2022
5.0.4 2,206 10/4/2022
5.0.3 10,869 9/29/2022
5.0.2 8,472 9/22/2022
5.0.1 6,461 9/18/2022
5.0.0 21,278 9/16/2022
5.0.0-beta-010 26,444 9/10/2022
5.0.0-beta-009 10,158 9/2/2022
5.0.0-beta-008 3,044 8/30/2022
5.0.0-beta-007 1,635 8/19/2022
5.0.0-beta-006 2,955 8/12/2022
5.0.0-beta-005 5,093 8/3/2022
5.0.0-beta-004 2,335 7/27/2022
5.0.0-beta-003 3,729 7/26/2022
5.0.0-beta-002 1,914 7/19/2022
5.0.0-beta-001 2,906 7/15/2022
5.0.0-alpha-011 1,631 7/8/2022
5.0.0-alpha-010 2,213 6/27/2022
5.0.0-alpha-009 90,749 6/21/2022
5.0.0-alpha-008 3,083 5/28/2022
5.0.0-alpha-007 1,860 5/16/2022
5.0.0-alpha-006 1,881 5/13/2022
5.0.0-alpha-005 1,361 5/7/2022
5.0.0-alpha-004 1,453 5/7/2022
5.0.0-alpha-003 1,913 5/6/2022
5.0.0-alpha-002 760 4/4/2022
5.0.0-alpha-001 713 3/19/2022
4.7.9 11,324 5/2/2022
4.7.8 10,565 4/25/2022
4.7.7 1,186 4/20/2022
4.7.6 1,455 4/4/2022
4.7.5 1,311 3/27/2022
4.7.4 1,273 3/25/2022
4.7.3 4,843 3/12/2022
4.7.2 1,198 3/11/2022
4.7.1 1,198 3/8/2022
4.7.0 1,318 3/4/2022
4.6.6 1,228 3/4/2022
4.6.5 1,980 2/18/2022
4.6.4 1,748 2/11/2022
4.6.3 1,794 2/8/2022
4.6.2 1,778 2/6/2022
4.6.1 1,773 2/1/2022
4.6.0 2,277 1/14/2022
4.6.0-beta-001 833 1/8/2022
4.6.0-alpha-011 817 12/29/2021
4.6.0-alpha-010 830 12/4/2021
4.6.0-alpha-009 3,470 11/24/2021
4.6.0-alpha-008 1,247 11/19/2021
4.6.0-alpha-007 872 11/7/2021
4.6.0-alpha-006 229 11/3/2021
4.6.0-alpha-005 250 10/27/2021
4.6.0-alpha-004 229 10/20/2021
4.6.0-alpha-003 210 10/5/2021
4.6.0-alpha-002 224 9/7/2021
4.6.0-alpha-001 196 8/11/2021
4.5.12 1,643 1/8/2022
4.5.11 2,430 12/29/2021
4.5.10 2,673 12/4/2021
4.5.9 7,569 11/24/2021
4.5.8 1,781 11/19/2021
4.5.7 1,612 11/7/2021
4.5.6 1,404 11/3/2021
4.5.5 1,559 10/27/2021
4.5.4 1,468 10/5/2021
4.5.3 2,971 9/7/2021
4.5.2 1,616 8/11/2021
4.5.1 3,477 7/24/2021
4.5.0 3,383 7/7/2021
4.5.0-beta-005 935 7/6/2021
4.5.0-beta-004 911 7/5/2021
4.5.0-beta-003 948 7/5/2021
4.5.0-beta-002 945 6/27/2021
4.5.0-beta-001 1,435 6/5/2021
4.5.0-alpha-020 888 5/26/2021
4.5.0-alpha-019 897 5/22/2021
4.5.0-alpha-018 935 5/21/2021
4.5.0-alpha-017 893 5/15/2021
4.5.0-alpha-016 864 5/9/2021
4.5.0-alpha-015 954 5/8/2021
4.5.0-alpha-014 1,003 4/30/2021
4.5.0-alpha-013 920 4/27/2021
4.5.0-alpha-012 913 4/23/2021
4.5.0-alpha-011 1,005 4/20/2021
4.5.0-alpha-010 920 4/14/2021
4.5.0-alpha-009 930 4/11/2021
4.5.0-alpha-008 929 4/8/2021
4.5.0-alpha-007 951 4/8/2021
4.5.0-alpha-006 905 4/5/2021
4.5.0-alpha-005 935 4/3/2021
4.5.0-alpha-004 949 4/2/2021
4.5.0-alpha-003 993 3/28/2021
4.5.0-alpha-002 960 3/22/2021
4.5.0-alpha-001 2,588 2/26/2021
4.4.0 13,374 2/25/2021
4.4.0-beta-008 1,004 2/19/2021
4.4.0-beta-007 991 2/12/2021
4.4.0-beta-006 984 2/12/2021
4.4.0-beta-005 1,041 2/9/2021
4.4.0-beta-004 1,028 2/5/2021
4.4.0-beta-003 1,480 1/30/2021
4.4.0-beta-002 1,012 1/23/2021
4.4.0-beta-001 1,418 1/22/2021
4.4.0-alpha-008 1,184 1/15/2021
4.4.0-alpha-007 1,679 12/26/2020
4.4.0-alpha-006 1,097 12/25/2020
4.4.0-alpha-005 1,175 12/23/2020
4.4.0-alpha-004 1,209 12/22/2020
4.4.0-alpha-003 1,214 12/18/2020
4.4.0-alpha-002 1,184 12/17/2020
4.4.0-alpha-001 1,088 12/17/2020
4.3.0 5,715 12/17/2020
4.3.0-beta-002 1,142 12/11/2020
4.3.0-beta-001 1,100 12/7/2020
4.3.0-alpha-007 1,114 11/21/2020
4.3.0-alpha-006 1,106 11/20/2020
4.3.0-alpha-005 1,056 11/16/2020
4.3.0-alpha-004 1,551 11/12/2020
4.3.0-alpha-003 1,137 11/10/2020
4.3.0-alpha-002 1,116 10/26/2020
4.3.0-alpha-001 1,148 10/23/2020
4.2.0 5,010 9/25/2020
4.2.0-alpha-004 1,296 9/23/2020
4.2.0-alpha-003 1,095 9/21/2020
4.2.0-alpha-002 1,166 9/19/2020
4.2.0-alpha-001 1,212 9/18/2020
4.1.1 1,795 9/17/2020
4.1.0 2,010 9/10/2020
4.1.0-beta-004 1,244 9/5/2020
4.1.0-beta-003 1,185 9/4/2020
4.1.0-beta-002 1,533 9/4/2020
4.1.0-beta-001 1,156 9/3/2020
4.1.0-alpha-001 1,136 9/1/2020
4.0.0 4,193 8/27/2020
4.0.0-beta-003 1,206 8/21/2020
4.0.0-beta-002 1,237 8/7/2020
4.0.0-beta-001 1,553 7/20/2020
4.0.0-alpha-014 1,362 7/14/2020
4.0.0-alpha-013 1,172 7/11/2020
4.0.0-alpha-012 2,016 7/6/2020
4.0.0-alpha-011 1,020 6/25/2020
4.0.0-alpha-010 1,394 6/18/2020
4.0.0-alpha-009 1,074 6/12/2020
4.0.0-alpha-008 1,196 6/2/2020
4.0.0-alpha-007 1,069 6/1/2020
4.0.0-alpha-006 2,339 5/23/2020
4.0.0-alpha-005 2,171 5/16/2020
4.0.0-alpha-004 1,485 5/4/2020
4.0.0-alpha-003 1,136 5/3/2020
4.0.0-alpha-002 1,177 4/26/2020
4.0.0-alpha-001 1,074 4/20/2020
3.3.0 12,941 2/28/2020
3.3.0-beta-002 2,012 2/21/2020
3.3.0-beta-001 1,187 2/18/2020
3.2.0 21,218 2/3/2020
3.2.0-beta-002 1,754 1/7/2020
3.2.0-beta-001 1,315 12/26/2019
3.1.0 10,700 11/27/2019
3.0.0 5,050 10/11/2019
3.0.0-beta-006 1,897 10/2/2019
3.0.0-beta-005 1,081 9/27/2019
3.0.0-beta-004 1,661 9/18/2019
3.0.0-beta-003 1,220 9/13/2019
3.0.0-beta-002 16,706 7/20/2019
3.0.0-beta-001 5,935 7/12/2019
2.9.2 25,795 2/2/2019
2.9.1 5,005 11/20/2018
2.9.0 11,425 10/17/2018
2.8.1 2,837 9/12/2018
2.8.0 6,095 7/7/2018
2.7.1 4,988 5/2/2018
2.7.0 2,640 5/2/2018
2.6.1 45,798 4/22/2017
2.5.0 3,036 2/19/2017
2.4.0 3,157 10/24/2016
2.3.0 2,810 7/9/2016
2.2.0 2,548 4/24/2016
2.1.0 2,441 4/1/2016
2.0.2 9,184 11/15/2015
1.11.0 2,978 9/12/2015
1.10.0 2,338 8/29/2015
1.9.0 2,790 8/10/2015
1.8.0-beta 1,961 7/19/2015
1.7.0 2,449 6/10/2015
1.6.0 3,329 10/25/2014
1.5.0 2,800 9/18/2014
1.4.0 3,152 7/1/2014
1.3.0 2,647 5/17/2014
1.2.0 2,675 4/21/2014
1.1.0 2,577 3/29/2014
1.0.7 2,537 3/12/2014
1.0.5.1 2,630 1/15/2014
1.0.5 2,357 1/7/2014
1.0.4 2,437 11/16/2013
1.0.3 2,450 10/6/2013
1.0.2 2,395 8/16/2013
1.0.1 2,582 7/22/2013
1.0.0 5,682 7/16/2013
0.9.9.2 2,789 7/2/2013
0.9.9.1 2,559 6/22/2013
0.9.8 2,553 6/14/2013
0.9.7 2,500 6/7/2013
0.9.6 2,491 5/31/2013
0.9.5 2,571 5/23/2013
0.9.4 2,424 5/19/2013
0.9.3 2,450 5/9/2013
0.9.2 2,476 5/3/2013
0.9.1 2,686 4/26/2013
0.9.0 2,472 4/19/2013
0.8.9 2,533 4/12/2013
0.8.8 2,497 4/11/2013
0.8.7 2,417 4/9/2013
0.8.6 2,434 4/4/2013
0.8.5 2,532 4/2/2013
0.8.4 2,448 4/1/2013
0.8.3 2,515 4/1/2013
0.8.2 2,398 4/1/2013
0.8.1 2,582 3/31/2013
0.8.0 2,522 3/31/2013

### Fixed
* Shebang directives get removed from scripts [#2367](https://github.com/fsprojects/fantomas/issues/2367)