fantomas 5.0.0-alpha-010

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-alpha-010                
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-alpha-010                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=fantomas&version=5.0.0-alpha-010&prerelease                
nuke :add-package fantomas --version 5.0.0-alpha-010                

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 6,708 9/14/2024
6.3.14 95 9/14/2024
6.3.13 692 9/10/2024
6.3.12 2,467 9/5/2024
6.3.11 10,908 8/16/2024
6.3.10 13,194 7/12/2024
6.3.9 15,017 6/9/2024
6.3.8 876 6/6/2024
6.3.7 1,654 6/1/2024
6.3.6 177 6/1/2024
6.3.5 837 5/30/2024
6.3.4 20,837 4/16/2024
6.3.3 3,697 4/12/2024
6.3.2 282 4/12/2024
6.3.1 10,308 3/30/2024
6.3.0 13,005 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,888 12/6/2023
6.3.0-alpha-003 1,457 11/15/2023
6.3.0-alpha-002 921 11/7/2023
6.3.0-alpha-001 769 11/3/2023
6.2.3 111,024 11/2/2023
6.2.2 25,297 10/18/2023
6.2.1 9,574 9/18/2023
6.2.0 24,375 8/29/2023
6.1.3 1,437 8/25/2023
6.1.2 14,254 7/23/2023
6.1.1 58,773 6/29/2023
6.1.0 7,531 6/28/2023
6.1.0-alpha-006 1,099 6/20/2023
6.1.0-alpha-005 1,024 6/20/2023
6.1.0-alpha-004 840 6/19/2023
6.1.0-alpha-003 1,108 6/2/2023
6.1.0-alpha-002 971 5/2/2023
6.1.0-alpha-001 978 5/2/2023
6.0.8 1,967 6/20/2023
6.0.7 1,273 6/20/2023
6.0.6 1,456 6/19/2023
6.0.5 4,893 6/6/2023
6.0.4 1,302 6/2/2023
6.0.3 12,408 5/14/2023
6.0.2 4,134 5/5/2023
6.0.1 55,960 4/19/2023
6.0.0 39,167 4/13/2023
6.0.0-beta-001 1,480 4/5/2023
6.0.0-alpha-010 6,810 4/3/2023
6.0.0-alpha-009 815 3/31/2023
6.0.0-alpha-008 2,061 3/27/2023
6.0.0-alpha-007 1,346 3/27/2023
6.0.0-alpha-006 1,485 3/17/2023
6.0.0-alpha-005 2,363 2/24/2023
6.0.0-alpha-004 8,844 2/22/2023
6.0.0-alpha-003 2,943 2/4/2023
6.0.0-alpha-002 890 2/1/2023
6.0.0-alpha-001 1,029 1/24/2023
5.2.4 6,081 3/17/2023
5.2.3 5,441 3/6/2023
5.2.2 13,126 2/21/2023
5.2.1 55,678 2/4/2023
5.2.0 6,834 1/19/2023
5.2.0-alpha-012 1,161 1/14/2023
5.2.0-alpha-011 1,380 1/12/2023
5.2.0-alpha-010 1,085 12/30/2022
5.2.0-alpha-009 1,017 12/29/2022
5.2.0-alpha-008 1,189 12/28/2022
5.2.0-alpha-007 1,009 12/26/2022
5.2.0-alpha-006 1,014 12/22/2022
5.2.0-alpha-005 1,143 12/16/2022
5.2.0-alpha-004 1,256 12/8/2022
5.2.0-alpha-003 1,025 12/6/2022
5.2.0-alpha-002 980 12/4/2022
5.2.0-alpha-001 922 11/30/2022
5.1.5 25,106 12/22/2022
5.1.4 26,679 11/30/2022
5.1.3 7,267 11/14/2022
5.1.2 1,537 11/10/2022
5.1.1 4,064 11/7/2022
5.1.0 2,751 11/4/2022
5.1.0-beta-002 990 10/29/2022
5.1.0-beta-001 1,360 10/19/2022
5.1.0-alpha-007 1,037 10/14/2022
5.1.0-alpha-006 992 10/14/2022
5.1.0-alpha-005 1,137 10/7/2022
5.1.0-alpha-004 1,150 10/7/2022
5.1.0-alpha-003 1,158 10/2/2022
5.1.0-alpha-002 1,044 9/29/2022
5.1.0-alpha-001 1,084 9/18/2022
5.0.6 24,442 10/13/2022
5.0.5 9,827 10/7/2022
5.0.4 2,176 10/4/2022
5.0.3 10,619 9/29/2022
5.0.2 8,178 9/22/2022
5.0.1 6,291 9/18/2022
5.0.0 21,208 9/16/2022
5.0.0-beta-010 20,799 9/10/2022
5.0.0-beta-009 9,327 9/2/2022
5.0.0-beta-008 3,018 8/30/2022
5.0.0-beta-007 1,593 8/19/2022
5.0.0-beta-006 2,915 8/12/2022
5.0.0-beta-005 5,070 8/3/2022
5.0.0-beta-004 2,290 7/27/2022
5.0.0-beta-003 3,705 7/26/2022
5.0.0-beta-002 1,891 7/19/2022
5.0.0-beta-001 2,884 7/15/2022
5.0.0-alpha-011 1,607 7/8/2022
5.0.0-alpha-010 2,180 6/27/2022
5.0.0-alpha-009 75,462 6/21/2022
5.0.0-alpha-008 2,958 5/28/2022
5.0.0-alpha-007 1,835 5/16/2022
5.0.0-alpha-006 1,857 5/13/2022
5.0.0-alpha-005 1,340 5/7/2022
5.0.0-alpha-004 1,432 5/7/2022
5.0.0-alpha-003 1,889 5/6/2022
5.0.0-alpha-002 739 4/4/2022
5.0.0-alpha-001 689 3/19/2022
4.7.9 11,151 5/2/2022
4.7.8 10,535 4/25/2022
4.7.7 1,159 4/20/2022
4.7.6 1,430 4/4/2022
4.7.5 1,275 3/27/2022
4.7.4 1,245 3/25/2022
4.7.3 4,817 3/12/2022
4.7.2 1,153 3/11/2022
4.7.1 1,135 3/8/2022
4.7.0 1,290 3/4/2022
4.6.6 1,196 3/4/2022
4.6.5 1,948 2/18/2022
4.6.4 1,716 2/11/2022
4.6.3 1,765 2/8/2022
4.6.2 1,750 2/6/2022
4.6.1 1,746 2/1/2022
4.6.0 2,247 1/14/2022
4.6.0-beta-001 808 1/8/2022
4.6.0-alpha-011 793 12/29/2021
4.6.0-alpha-010 805 12/4/2021
4.6.0-alpha-009 3,447 11/24/2021
4.6.0-alpha-008 1,223 11/19/2021
4.6.0-alpha-007 846 11/7/2021
4.6.0-alpha-006 201 11/3/2021
4.6.0-alpha-005 227 10/27/2021
4.6.0-alpha-004 203 10/20/2021
4.6.0-alpha-003 184 10/5/2021
4.6.0-alpha-002 194 9/7/2021
4.6.0-alpha-001 172 8/11/2021
4.5.12 1,614 1/8/2022
4.5.11 2,403 12/29/2021
4.5.10 2,646 12/4/2021
4.5.9 7,539 11/24/2021
4.5.8 1,753 11/19/2021
4.5.7 1,577 11/7/2021
4.5.6 1,375 11/3/2021
4.5.5 1,532 10/27/2021
4.5.4 1,436 10/5/2021
4.5.3 2,940 9/7/2021
4.5.2 1,586 8/11/2021
4.5.1 3,432 7/24/2021
4.5.0 3,353 7/7/2021
4.5.0-beta-005 914 7/6/2021
4.5.0-beta-004 889 7/5/2021
4.5.0-beta-003 919 7/5/2021
4.5.0-beta-002 918 6/27/2021
4.5.0-beta-001 1,413 6/5/2021
4.5.0-alpha-020 863 5/26/2021
4.5.0-alpha-019 875 5/22/2021
4.5.0-alpha-018 904 5/21/2021
4.5.0-alpha-017 869 5/15/2021
4.5.0-alpha-016 839 5/9/2021
4.5.0-alpha-015 930 5/8/2021
4.5.0-alpha-014 977 4/30/2021
4.5.0-alpha-013 895 4/27/2021
4.5.0-alpha-012 885 4/23/2021
4.5.0-alpha-011 980 4/20/2021
4.5.0-alpha-010 895 4/14/2021
4.5.0-alpha-009 905 4/11/2021
4.5.0-alpha-008 904 4/8/2021
4.5.0-alpha-007 925 4/8/2021
4.5.0-alpha-006 878 4/5/2021
4.5.0-alpha-005 905 4/3/2021
4.5.0-alpha-004 921 4/2/2021
4.5.0-alpha-003 967 3/28/2021
4.5.0-alpha-002 934 3/22/2021
4.5.0-alpha-001 2,560 2/26/2021
4.4.0 13,317 2/25/2021
4.4.0-beta-008 976 2/19/2021
4.4.0-beta-007 966 2/12/2021
4.4.0-beta-006 955 2/12/2021
4.4.0-beta-005 1,014 2/9/2021
4.4.0-beta-004 999 2/5/2021
4.4.0-beta-003 1,453 1/30/2021
4.4.0-beta-002 985 1/23/2021
4.4.0-beta-001 1,388 1/22/2021
4.4.0-alpha-008 1,155 1/15/2021
4.4.0-alpha-007 1,654 12/26/2020
4.4.0-alpha-006 1,066 12/25/2020
4.4.0-alpha-005 1,150 12/23/2020
4.4.0-alpha-004 1,174 12/22/2020
4.4.0-alpha-003 1,185 12/18/2020
4.4.0-alpha-002 1,155 12/17/2020
4.4.0-alpha-001 1,054 12/17/2020
4.3.0 5,613 12/17/2020
4.3.0-beta-002 1,110 12/11/2020
4.3.0-beta-001 1,070 12/7/2020
4.3.0-alpha-007 1,084 11/21/2020
4.3.0-alpha-006 1,079 11/20/2020
4.3.0-alpha-005 1,029 11/16/2020
4.3.0-alpha-004 1,520 11/12/2020
4.3.0-alpha-003 1,108 11/10/2020
4.3.0-alpha-002 1,088 10/26/2020
4.3.0-alpha-001 1,117 10/23/2020
4.2.0 4,978 9/25/2020
4.2.0-alpha-004 1,268 9/23/2020
4.2.0-alpha-003 1,066 9/21/2020
4.2.0-alpha-002 1,135 9/19/2020
4.2.0-alpha-001 1,185 9/18/2020
4.1.1 1,762 9/17/2020
4.1.0 1,976 9/10/2020
4.1.0-beta-004 1,215 9/5/2020
4.1.0-beta-003 1,153 9/4/2020
4.1.0-beta-002 1,505 9/4/2020
4.1.0-beta-001 1,127 9/3/2020
4.1.0-alpha-001 1,109 9/1/2020
4.0.0 4,156 8/27/2020
4.0.0-beta-003 1,157 8/21/2020
4.0.0-beta-002 1,205 8/7/2020
4.0.0-beta-001 1,524 7/20/2020
4.0.0-alpha-014 1,333 7/14/2020
4.0.0-alpha-013 1,141 7/11/2020
4.0.0-alpha-012 1,968 7/6/2020
4.0.0-alpha-011 991 6/25/2020
4.0.0-alpha-010 1,367 6/18/2020
4.0.0-alpha-009 1,045 6/12/2020
4.0.0-alpha-008 1,166 6/2/2020
4.0.0-alpha-007 1,038 6/1/2020
4.0.0-alpha-006 2,293 5/23/2020
4.0.0-alpha-005 2,084 5/16/2020
4.0.0-alpha-004 1,453 5/4/2020
4.0.0-alpha-003 1,104 5/3/2020
4.0.0-alpha-002 1,144 4/26/2020
4.0.0-alpha-001 1,042 4/20/2020
3.3.0 12,888 2/28/2020
3.3.0-beta-002 1,982 2/21/2020
3.3.0-beta-001 1,156 2/18/2020
3.2.0 21,182 2/3/2020
3.2.0-beta-002 1,725 1/7/2020
3.2.0-beta-001 1,285 12/26/2019
3.1.0 10,661 11/27/2019
3.0.0 5,011 10/11/2019
3.0.0-beta-006 1,866 10/2/2019
3.0.0-beta-005 1,050 9/27/2019
3.0.0-beta-004 1,627 9/18/2019
3.0.0-beta-003 1,187 9/13/2019
3.0.0-beta-002 16,580 7/20/2019
3.0.0-beta-001 5,864 7/12/2019
2.9.2 25,727 2/2/2019
2.9.1 4,961 11/20/2018
2.9.0 11,367 10/17/2018
2.8.1 2,780 9/12/2018
2.8.0 5,982 7/7/2018
2.7.1 4,865 5/2/2018
2.7.0 2,516 5/2/2018
2.6.1 45,689 4/22/2017
2.5.0 2,943 2/19/2017
2.4.0 3,044 10/24/2016
2.3.0 2,717 7/9/2016
2.2.0 2,455 4/24/2016
2.1.0 2,349 4/1/2016
2.0.2 9,086 11/15/2015
1.11.0 2,885 9/12/2015
1.10.0 2,237 8/29/2015
1.9.0 2,694 8/10/2015
1.8.0-beta 1,871 7/19/2015
1.7.0 2,348 6/10/2015
1.6.0 3,218 10/25/2014
1.5.0 2,684 9/18/2014
1.4.0 3,051 7/1/2014
1.3.0 2,542 5/17/2014
1.2.0 2,557 4/21/2014
1.1.0 2,477 3/29/2014
1.0.7 2,429 3/12/2014
1.0.5.1 2,526 1/15/2014
1.0.5 2,253 1/7/2014
1.0.4 2,336 11/16/2013
1.0.3 2,352 10/6/2013
1.0.2 2,292 8/16/2013
1.0.1 2,481 7/22/2013
1.0.0 5,578 7/16/2013
0.9.9.2 2,687 7/2/2013
0.9.9.1 2,460 6/22/2013
0.9.8 2,448 6/14/2013
0.9.7 2,402 6/7/2013
0.9.6 2,386 5/31/2013
0.9.5 2,471 5/23/2013
0.9.4 2,323 5/19/2013
0.9.3 2,353 5/9/2013
0.9.2 2,374 5/3/2013
0.9.1 2,588 4/26/2013
0.9.0 2,369 4/19/2013
0.8.9 2,434 4/12/2013
0.8.8 2,399 4/11/2013
0.8.7 2,315 4/9/2013
0.8.6 2,334 4/4/2013
0.8.5 2,417 4/2/2013
0.8.4 2,343 4/1/2013
0.8.3 2,410 4/1/2013
0.8.2 2,294 4/1/2013
0.8.1 2,478 3/31/2013
0.8.0 2,419 3/31/2013

### Changed
* Restore the FormatSelection public API. [#2237](https://github.com/fsprojects/fantomas/issues/2237)
* Refactor list of TriviaNodeAssigner to tree structure. [#2271](https://github.com/fsprojects/fantomas/issues/2271)