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. 
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.0-alpha-001 102 9/16/2024
6.3.15 7,551 9/14/2024
6.3.14 95 9/14/2024
6.3.13 699 9/10/2024
6.3.12 2,590 9/5/2024
6.3.11 11,209 8/16/2024
6.3.10 13,426 7/12/2024
6.3.9 15,320 6/9/2024
6.3.8 878 6/6/2024
6.3.7 1,656 6/1/2024
6.3.6 177 6/1/2024
6.3.5 839 5/30/2024
6.3.4 21,090 4/16/2024
6.3.3 3,803 4/12/2024
6.3.2 286 4/12/2024
6.3.1 10,386 3/30/2024
6.3.0 13,037 3/15/2024
6.3.0-beta-001 940 3/7/2024
6.3.0-alpha-008 810 3/1/2024
6.3.0-alpha-007 1,912 1/27/2024
6.3.0-alpha-006 828 1/9/2024
6.3.0-alpha-005 1,209 12/22/2023
6.3.0-alpha-004 1,897 12/6/2023
6.3.0-alpha-003 1,457 11/15/2023
6.3.0-alpha-002 923 11/7/2023
6.3.0-alpha-001 769 11/3/2023
6.2.3 111,566 11/2/2023
6.2.2 25,379 10/18/2023
6.2.1 9,593 9/18/2023
6.2.0 24,376 8/29/2023
6.1.3 1,439 8/25/2023
6.1.2 14,291 7/23/2023
6.1.1 59,307 6/29/2023
6.1.0 7,532 6/28/2023
6.1.0-alpha-006 1,100 6/20/2023
6.1.0-alpha-005 1,025 6/20/2023
6.1.0-alpha-004 842 6/19/2023
6.1.0-alpha-003 1,110 6/2/2023
6.1.0-alpha-002 973 5/2/2023
6.1.0-alpha-001 979 5/2/2023
6.0.8 1,969 6/20/2023
6.0.7 1,275 6/20/2023
6.0.6 1,458 6/19/2023
6.0.5 4,895 6/6/2023
6.0.4 1,304 6/2/2023
6.0.3 12,413 5/14/2023
6.0.2 4,138 5/5/2023
6.0.1 56,465 4/19/2023
6.0.0 39,515 4/13/2023
6.0.0-beta-001 1,482 4/5/2023
6.0.0-alpha-010 6,812 4/3/2023
6.0.0-alpha-009 817 3/31/2023
6.0.0-alpha-008 2,063 3/27/2023
6.0.0-alpha-007 1,348 3/27/2023
6.0.0-alpha-006 1,487 3/17/2023
6.0.0-alpha-005 2,365 2/24/2023
6.0.0-alpha-004 8,846 2/22/2023
6.0.0-alpha-003 2,945 2/4/2023
6.0.0-alpha-002 892 2/1/2023
6.0.0-alpha-001 1,031 1/24/2023
5.2.4 6,085 3/17/2023
5.2.3 5,443 3/6/2023
5.2.2 13,128 2/21/2023
5.2.1 56,023 2/4/2023
5.2.0 6,836 1/19/2023
5.2.0-alpha-012 1,163 1/14/2023
5.2.0-alpha-011 1,382 1/12/2023
5.2.0-alpha-010 1,087 12/30/2022
5.2.0-alpha-009 1,019 12/29/2022
5.2.0-alpha-008 1,197 12/28/2022
5.2.0-alpha-007 1,011 12/26/2022
5.2.0-alpha-006 1,016 12/22/2022
5.2.0-alpha-005 1,145 12/16/2022
5.2.0-alpha-004 1,258 12/8/2022
5.2.0-alpha-003 1,029 12/6/2022
5.2.0-alpha-002 982 12/4/2022
5.2.0-alpha-001 924 11/30/2022
5.1.5 25,108 12/22/2022
5.1.4 26,696 11/30/2022
5.1.3 7,273 11/14/2022
5.1.2 1,539 11/10/2022
5.1.1 4,066 11/7/2022
5.1.0 2,753 11/4/2022
5.1.0-beta-002 992 10/29/2022
5.1.0-beta-001 1,362 10/19/2022
5.1.0-alpha-007 1,039 10/14/2022
5.1.0-alpha-006 994 10/14/2022
5.1.0-alpha-005 1,139 10/7/2022
5.1.0-alpha-004 1,152 10/7/2022
5.1.0-alpha-003 1,160 10/2/2022
5.1.0-alpha-002 1,046 9/29/2022
5.1.0-alpha-001 1,087 9/18/2022
5.0.6 24,456 10/13/2022
5.0.5 9,838 10/7/2022
5.0.4 2,178 10/4/2022
5.0.3 10,638 9/29/2022
5.0.2 8,183 9/22/2022
5.0.1 6,306 9/18/2022
5.0.0 21,210 9/16/2022
5.0.0-beta-010 20,884 9/10/2022
5.0.0-beta-009 9,354 9/2/2022
5.0.0-beta-008 3,020 8/30/2022
5.0.0-beta-007 1,595 8/19/2022
5.0.0-beta-006 2,917 8/12/2022
5.0.0-beta-005 5,072 8/3/2022
5.0.0-beta-004 2,292 7/27/2022
5.0.0-beta-003 3,708 7/26/2022
5.0.0-beta-002 1,894 7/19/2022
5.0.0-beta-001 2,887 7/15/2022
5.0.0-alpha-011 1,610 7/8/2022
5.0.0-alpha-010 2,182 6/27/2022
5.0.0-alpha-009 75,827 6/21/2022
5.0.0-alpha-008 2,961 5/28/2022
5.0.0-alpha-007 1,838 5/16/2022
5.0.0-alpha-006 1,860 5/13/2022
5.0.0-alpha-005 1,342 5/7/2022
5.0.0-alpha-004 1,434 5/7/2022
5.0.0-alpha-003 1,891 5/6/2022
5.0.0-alpha-002 740 4/4/2022
5.0.0-alpha-001 690 3/19/2022
4.7.9 11,154 5/2/2022
4.7.8 10,536 4/25/2022
4.7.7 1,160 4/20/2022
4.7.6 1,431 4/4/2022
4.7.5 1,276 3/27/2022
4.7.4 1,246 3/25/2022
4.7.3 4,818 3/12/2022
4.7.2 1,172 3/11/2022
4.7.1 1,136 3/8/2022
4.7.0 1,291 3/4/2022
4.6.6 1,197 3/4/2022
4.6.5 1,949 2/18/2022
4.6.4 1,717 2/11/2022
4.6.3 1,766 2/8/2022
4.6.2 1,751 2/6/2022
4.6.1 1,747 2/1/2022
4.6.0 2,248 1/14/2022
4.6.0-beta-001 809 1/8/2022
4.6.0-alpha-011 794 12/29/2021
4.6.0-alpha-010 806 12/4/2021
4.6.0-alpha-009 3,448 11/24/2021
4.6.0-alpha-008 1,224 11/19/2021
4.6.0-alpha-007 847 11/7/2021
4.6.0-alpha-006 204 11/3/2021
4.6.0-alpha-005 228 10/27/2021
4.6.0-alpha-004 206 10/20/2021
4.6.0-alpha-003 187 10/5/2021
4.6.0-alpha-002 199 9/7/2021
4.6.0-alpha-001 175 8/11/2021
4.5.12 1,615 1/8/2022
4.5.11 2,403 12/29/2021
4.5.10 2,647 12/4/2021
4.5.9 7,540 11/24/2021
4.5.8 1,754 11/19/2021
4.5.7 1,578 11/7/2021
4.5.6 1,376 11/3/2021
4.5.5 1,533 10/27/2021
4.5.4 1,437 10/5/2021
4.5.3 2,941 9/7/2021
4.5.2 1,587 8/11/2021
4.5.1 3,433 7/24/2021
4.5.0 3,354 7/7/2021
4.5.0-beta-005 915 7/6/2021
4.5.0-beta-004 890 7/5/2021
4.5.0-beta-003 920 7/5/2021
4.5.0-beta-002 919 6/27/2021
4.5.0-beta-001 1,414 6/5/2021
4.5.0-alpha-020 864 5/26/2021
4.5.0-alpha-019 876 5/22/2021
4.5.0-alpha-018 905 5/21/2021
4.5.0-alpha-017 869 5/15/2021
4.5.0-alpha-016 840 5/9/2021
4.5.0-alpha-015 931 5/8/2021
4.5.0-alpha-014 978 4/30/2021
4.5.0-alpha-013 896 4/27/2021
4.5.0-alpha-012 886 4/23/2021
4.5.0-alpha-011 980 4/20/2021
4.5.0-alpha-010 896 4/14/2021
4.5.0-alpha-009 906 4/11/2021
4.5.0-alpha-008 905 4/8/2021
4.5.0-alpha-007 926 4/8/2021
4.5.0-alpha-006 879 4/5/2021
4.5.0-alpha-005 906 4/3/2021
4.5.0-alpha-004 922 4/2/2021
4.5.0-alpha-003 968 3/28/2021
4.5.0-alpha-002 935 3/22/2021
4.5.0-alpha-001 2,561 2/26/2021
4.4.0 13,318 2/25/2021
4.4.0-beta-008 976 2/19/2021
4.4.0-beta-007 967 2/12/2021
4.4.0-beta-006 956 2/12/2021
4.4.0-beta-005 1,015 2/9/2021
4.4.0-beta-004 1,000 2/5/2021
4.4.0-beta-003 1,454 1/30/2021
4.4.0-beta-002 986 1/23/2021
4.4.0-beta-001 1,389 1/22/2021
4.4.0-alpha-008 1,156 1/15/2021
4.4.0-alpha-007 1,655 12/26/2020
4.4.0-alpha-006 1,067 12/25/2020
4.4.0-alpha-005 1,151 12/23/2020
4.4.0-alpha-004 1,175 12/22/2020
4.4.0-alpha-003 1,186 12/18/2020
4.4.0-alpha-002 1,156 12/17/2020
4.4.0-alpha-001 1,055 12/17/2020
4.3.0 5,614 12/17/2020
4.3.0-beta-002 1,111 12/11/2020
4.3.0-beta-001 1,071 12/7/2020
4.3.0-alpha-007 1,085 11/21/2020
4.3.0-alpha-006 1,080 11/20/2020
4.3.0-alpha-005 1,030 11/16/2020
4.3.0-alpha-004 1,521 11/12/2020
4.3.0-alpha-003 1,109 11/10/2020
4.3.0-alpha-002 1,089 10/26/2020
4.3.0-alpha-001 1,118 10/23/2020
4.2.0 4,979 9/25/2020
4.2.0-alpha-004 1,269 9/23/2020
4.2.0-alpha-003 1,067 9/21/2020
4.2.0-alpha-002 1,136 9/19/2020
4.2.0-alpha-001 1,186 9/18/2020
4.1.1 1,763 9/17/2020
4.1.0 1,977 9/10/2020
4.1.0-beta-004 1,216 9/5/2020
4.1.0-beta-003 1,154 9/4/2020
4.1.0-beta-002 1,506 9/4/2020
4.1.0-beta-001 1,128 9/3/2020
4.1.0-alpha-001 1,110 9/1/2020
4.0.0 4,158 8/27/2020
4.0.0-beta-003 1,158 8/21/2020
4.0.0-beta-002 1,206 8/7/2020
4.0.0-beta-001 1,525 7/20/2020
4.0.0-alpha-014 1,334 7/14/2020
4.0.0-alpha-013 1,142 7/11/2020
4.0.0-alpha-012 1,969 7/6/2020
4.0.0-alpha-011 992 6/25/2020
4.0.0-alpha-010 1,368 6/18/2020
4.0.0-alpha-009 1,046 6/12/2020
4.0.0-alpha-008 1,167 6/2/2020
4.0.0-alpha-007 1,039 6/1/2020
4.0.0-alpha-006 2,310 5/23/2020
4.0.0-alpha-005 2,141 5/16/2020
4.0.0-alpha-004 1,453 5/4/2020
4.0.0-alpha-003 1,105 5/3/2020
4.0.0-alpha-002 1,145 4/26/2020
4.0.0-alpha-001 1,043 4/20/2020
3.3.0 12,891 2/28/2020
3.3.0-beta-002 1,983 2/21/2020
3.3.0-beta-001 1,157 2/18/2020
3.2.0 21,183 2/3/2020
3.2.0-beta-002 1,726 1/7/2020
3.2.0-beta-001 1,286 12/26/2019
3.1.0 10,662 11/27/2019
3.0.0 5,012 10/11/2019
3.0.0-beta-006 1,867 10/2/2019
3.0.0-beta-005 1,051 9/27/2019
3.0.0-beta-004 1,628 9/18/2019
3.0.0-beta-003 1,188 9/13/2019
3.0.0-beta-002 16,583 7/20/2019
3.0.0-beta-001 5,865 7/12/2019
2.9.2 25,728 2/2/2019
2.9.1 4,962 11/20/2018
2.9.0 11,368 10/17/2018
2.8.1 2,781 9/12/2018
2.8.0 5,983 7/7/2018
2.7.1 4,866 5/2/2018
2.7.0 2,517 5/2/2018
2.6.1 45,690 4/22/2017
2.5.0 2,944 2/19/2017
2.4.0 3,045 10/24/2016
2.3.0 2,718 7/9/2016
2.2.0 2,456 4/24/2016
2.1.0 2,350 4/1/2016
2.0.2 9,087 11/15/2015
1.11.0 2,886 9/12/2015
1.10.0 2,238 8/29/2015
1.9.0 2,695 8/10/2015
1.8.0-beta 1,872 7/19/2015
1.7.0 2,349 6/10/2015
1.6.0 3,219 10/25/2014
1.5.0 2,685 9/18/2014
1.4.0 3,052 7/1/2014
1.3.0 2,543 5/17/2014
1.2.0 2,558 4/21/2014
1.1.0 2,478 3/29/2014
1.0.7 2,430 3/12/2014
1.0.5.1 2,527 1/15/2014
1.0.5 2,254 1/7/2014
1.0.4 2,337 11/16/2013
1.0.3 2,353 10/6/2013
1.0.2 2,293 8/16/2013
1.0.1 2,482 7/22/2013
1.0.0 5,579 7/16/2013
0.9.9.2 2,688 7/2/2013
0.9.9.1 2,461 6/22/2013
0.9.8 2,449 6/14/2013
0.9.7 2,403 6/7/2013
0.9.6 2,387 5/31/2013
0.9.5 2,472 5/23/2013
0.9.4 2,324 5/19/2013
0.9.3 2,354 5/9/2013
0.9.2 2,375 5/3/2013
0.9.1 2,589 4/26/2013
0.9.0 2,370 4/19/2013
0.8.9 2,435 4/12/2013
0.8.8 2,400 4/11/2013
0.8.7 2,316 4/9/2013
0.8.6 2,335 4/4/2013
0.8.5 2,418 4/2/2013
0.8.4 2,344 4/1/2013
0.8.3 2,411 4/1/2013
0.8.2 2,295 4/1/2013
0.8.1 2,480 3/31/2013
0.8.0 2,420 3/31/2013

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