fantomas 5.0.0-alpha-006

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

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
6.3.3 321 4/12/2024
6.3.2 119 4/12/2024
6.3.1 2,519 3/30/2024
6.3.0 4,768 3/15/2024
6.3.0-beta-001 606 3/7/2024
6.3.0-alpha-008 716 3/1/2024
6.3.0-alpha-007 1,618 1/27/2024
6.3.0-alpha-006 774 1/9/2024
6.3.0-alpha-005 1,078 12/22/2023
6.3.0-alpha-004 1,784 12/6/2023
6.3.0-alpha-003 1,254 11/15/2023
6.3.0-alpha-002 836 11/7/2023
6.3.0-alpha-001 637 11/3/2023
6.2.3 66,978 11/2/2023
6.2.2 8,861 10/18/2023
6.2.1 8,405 9/18/2023
6.2.0 20,534 8/29/2023
6.1.3 1,309 8/25/2023
6.1.2 12,180 7/23/2023
6.1.1 22,310 6/29/2023
6.1.0 7,463 6/28/2023
6.1.0-alpha-006 1,044 6/20/2023
6.1.0-alpha-005 969 6/20/2023
6.1.0-alpha-004 771 6/19/2023
6.1.0-alpha-003 1,024 6/2/2023
6.1.0-alpha-002 895 5/2/2023
6.1.0-alpha-001 917 5/2/2023
6.0.8 1,878 6/20/2023
6.0.7 1,204 6/20/2023
6.0.6 1,330 6/19/2023
6.0.5 4,609 6/6/2023
6.0.4 1,269 6/2/2023
6.0.3 12,113 5/14/2023
6.0.2 3,800 5/5/2023
6.0.1 31,664 4/19/2023
6.0.0 22,187 4/13/2023
6.0.0-beta-001 1,416 4/5/2023
6.0.0-alpha-010 4,816 4/3/2023
6.0.0-alpha-009 749 3/31/2023
6.0.0-alpha-008 1,984 3/27/2023
6.0.0-alpha-007 1,287 3/27/2023
6.0.0-alpha-006 1,433 3/17/2023
6.0.0-alpha-005 2,303 2/24/2023
6.0.0-alpha-004 8,021 2/22/2023
6.0.0-alpha-003 2,896 2/4/2023
6.0.0-alpha-002 804 2/1/2023
6.0.0-alpha-001 954 1/24/2023
5.2.4 5,828 3/17/2023
5.2.3 5,351 3/6/2023
5.2.2 12,224 2/21/2023
5.2.1 36,618 2/4/2023
5.2.0 6,747 1/19/2023
5.2.0-alpha-012 1,101 1/14/2023
5.2.0-alpha-011 1,346 1/12/2023
5.2.0-alpha-010 971 12/30/2022
5.2.0-alpha-009 954 12/29/2022
5.2.0-alpha-008 965 12/28/2022
5.2.0-alpha-007 922 12/26/2022
5.2.0-alpha-006 959 12/22/2022
5.2.0-alpha-005 1,074 12/16/2022
5.2.0-alpha-004 1,181 12/8/2022
5.2.0-alpha-003 945 12/6/2022
5.2.0-alpha-002 912 12/4/2022
5.2.0-alpha-001 836 11/30/2022
5.1.5 23,627 12/22/2022
5.1.4 26,362 11/30/2022
5.1.3 6,883 11/14/2022
5.1.2 1,492 11/10/2022
5.1.1 3,997 11/7/2022
5.1.0 2,690 11/4/2022
5.1.0-beta-002 910 10/29/2022
5.1.0-beta-001 1,280 10/19/2022
5.1.0-alpha-007 978 10/14/2022
5.1.0-alpha-006 898 10/14/2022
5.1.0-alpha-005 1,068 10/7/2022
5.1.0-alpha-004 1,062 10/7/2022
5.1.0-alpha-003 1,052 10/2/2022
5.1.0-alpha-002 947 9/29/2022
5.1.0-alpha-001 980 9/18/2022
5.0.6 23,165 10/13/2022
5.0.5 8,008 10/7/2022
5.0.4 2,077 10/4/2022
5.0.3 10,110 9/29/2022
5.0.2 7,704 9/22/2022
5.0.1 5,039 9/18/2022
5.0.0 21,098 9/16/2022
5.0.0-beta-010 16,326 9/10/2022
5.0.0-beta-009 8,712 9/2/2022
5.0.0-beta-008 2,955 8/30/2022
5.0.0-beta-007 1,526 8/19/2022
5.0.0-beta-006 2,825 8/12/2022
5.0.0-beta-005 5,017 8/3/2022
5.0.0-beta-004 2,096 7/27/2022
5.0.0-beta-003 3,632 7/26/2022
5.0.0-beta-002 1,772 7/19/2022
5.0.0-beta-001 2,781 7/15/2022
5.0.0-alpha-011 1,507 7/8/2022
5.0.0-alpha-010 2,123 6/27/2022
5.0.0-alpha-009 64,547 6/21/2022
5.0.0-alpha-008 2,734 5/28/2022
5.0.0-alpha-007 1,743 5/16/2022
5.0.0-alpha-006 1,769 5/13/2022
5.0.0-alpha-005 1,262 5/7/2022
5.0.0-alpha-004 1,355 5/7/2022
5.0.0-alpha-003 1,836 5/6/2022
5.0.0-alpha-002 692 4/4/2022
5.0.0-alpha-001 658 3/19/2022
4.7.9 10,856 5/2/2022
4.7.8 10,494 4/25/2022
4.7.7 1,124 4/20/2022
4.7.6 1,394 4/4/2022
4.7.5 1,241 3/27/2022
4.7.4 1,212 3/25/2022
4.7.3 4,785 3/12/2022
4.7.2 1,118 3/11/2022
4.7.1 1,099 3/8/2022
4.7.0 1,266 3/4/2022
4.6.6 1,157 3/4/2022
4.6.5 1,889 2/18/2022
4.6.4 1,644 2/11/2022
4.6.3 1,709 2/8/2022
4.6.2 1,698 2/6/2022
4.6.1 1,677 2/1/2022
4.6.0 2,196 1/14/2022
4.6.0-beta-001 759 1/8/2022
4.6.0-alpha-011 741 12/29/2021
4.6.0-alpha-010 741 12/4/2021
4.6.0-alpha-009 3,400 11/24/2021
4.6.0-alpha-008 1,186 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,562 1/8/2022
4.5.11 2,341 12/29/2021
4.5.10 2,608 12/4/2021
4.5.9 7,484 11/24/2021
4.5.8 1,702 11/19/2021
4.5.7 1,530 11/7/2021
4.5.6 1,326 11/3/2021
4.5.5 1,481 10/27/2021
4.5.4 1,388 10/5/2021
4.5.3 2,890 9/7/2021
4.5.2 1,532 8/11/2021
4.5.1 3,346 7/24/2021
4.5.0 3,301 7/7/2021
4.5.0-beta-005 852 7/6/2021
4.5.0-beta-004 842 7/5/2021
4.5.0-beta-003 872 7/5/2021
4.5.0-beta-002 866 6/27/2021
4.5.0-beta-001 1,360 6/5/2021
4.5.0-alpha-020 832 5/26/2021
4.5.0-alpha-019 824 5/22/2021
4.5.0-alpha-018 850 5/21/2021
4.5.0-alpha-017 822 5/15/2021
4.5.0-alpha-016 791 5/9/2021
4.5.0-alpha-015 899 5/8/2021
4.5.0-alpha-014 910 4/30/2021
4.5.0-alpha-013 864 4/27/2021
4.5.0-alpha-012 821 4/23/2021
4.5.0-alpha-011 932 4/20/2021
4.5.0-alpha-010 846 4/14/2021
4.5.0-alpha-009 857 4/11/2021
4.5.0-alpha-008 857 4/8/2021
4.5.0-alpha-007 876 4/8/2021
4.5.0-alpha-006 826 4/5/2021
4.5.0-alpha-005 841 4/3/2021
4.5.0-alpha-004 873 4/2/2021
4.5.0-alpha-003 887 3/28/2021
4.5.0-alpha-002 879 3/22/2021
4.5.0-alpha-001 2,503 2/26/2021
4.4.0 12,933 2/25/2021
4.4.0-beta-008 913 2/19/2021
4.4.0-beta-007 919 2/12/2021
4.4.0-beta-006 911 2/12/2021
4.4.0-beta-005 969 2/9/2021
4.4.0-beta-004 944 2/5/2021
4.4.0-beta-003 1,391 1/30/2021
4.4.0-beta-002 937 1/23/2021
4.4.0-beta-001 1,340 1/22/2021
4.4.0-alpha-008 1,125 1/15/2021
4.4.0-alpha-007 1,607 12/26/2020
4.4.0-alpha-006 1,018 12/25/2020
4.4.0-alpha-005 1,102 12/23/2020
4.4.0-alpha-004 1,116 12/22/2020
4.4.0-alpha-003 1,137 12/18/2020
4.4.0-alpha-002 1,110 12/17/2020
4.4.0-alpha-001 1,006 12/17/2020
4.3.0 5,520 12/17/2020
4.3.0-beta-002 1,060 12/11/2020
4.3.0-beta-001 1,006 12/7/2020
4.3.0-alpha-007 1,036 11/21/2020
4.3.0-alpha-006 1,031 11/20/2020
4.3.0-alpha-005 981 11/16/2020
4.3.0-alpha-004 1,490 11/12/2020
4.3.0-alpha-003 1,061 11/10/2020
4.3.0-alpha-002 1,040 10/26/2020
4.3.0-alpha-001 1,069 10/23/2020
4.2.0 4,890 9/25/2020
4.2.0-alpha-004 1,211 9/23/2020
4.2.0-alpha-003 1,010 9/21/2020
4.2.0-alpha-002 1,095 9/19/2020
4.2.0-alpha-001 1,139 9/18/2020
4.1.1 1,705 9/17/2020
4.1.0 1,926 9/10/2020
4.1.0-beta-004 1,168 9/5/2020
4.1.0-beta-003 1,096 9/4/2020
4.1.0-beta-002 1,464 9/4/2020
4.1.0-beta-001 1,056 9/3/2020
4.1.0-alpha-001 1,061 9/1/2020
4.0.0 4,047 8/27/2020
4.0.0-beta-003 1,090 8/21/2020
4.0.0-beta-002 1,173 8/7/2020
4.0.0-beta-001 1,492 7/20/2020
4.0.0-alpha-014 1,302 7/14/2020
4.0.0-alpha-013 1,100 7/11/2020
4.0.0-alpha-012 1,859 7/6/2020
4.0.0-alpha-011 959 6/25/2020
4.0.0-alpha-010 1,334 6/18/2020
4.0.0-alpha-009 1,012 6/12/2020
4.0.0-alpha-008 1,129 6/2/2020
4.0.0-alpha-007 1,006 6/1/2020
4.0.0-alpha-006 2,217 5/23/2020
4.0.0-alpha-005 2,032 5/16/2020
4.0.0-alpha-004 1,423 5/4/2020
4.0.0-alpha-003 1,067 5/3/2020
4.0.0-alpha-002 1,114 4/26/2020
4.0.0-alpha-001 1,011 4/20/2020
3.3.0 12,741 2/28/2020
3.3.0-beta-002 1,950 2/21/2020
3.3.0-beta-001 1,125 2/18/2020
3.2.0 21,129 2/3/2020
3.2.0-beta-002 1,693 1/7/2020
3.2.0-beta-001 1,254 12/26/2019
3.1.0 10,625 11/27/2019
3.0.0 4,976 10/11/2019
3.0.0-beta-006 1,831 10/2/2019
3.0.0-beta-005 1,020 9/27/2019
3.0.0-beta-004 1,595 9/18/2019
3.0.0-beta-003 1,139 9/13/2019
3.0.0-beta-002 16,276 7/20/2019
3.0.0-beta-001 5,821 7/12/2019
2.9.2 25,581 2/2/2019
2.9.1 4,910 11/20/2018
2.9.0 11,203 10/17/2018
2.8.1 2,715 9/12/2018
2.8.0 5,932 7/7/2018
2.7.1 4,814 5/2/2018
2.7.0 2,462 5/2/2018
2.6.1 45,644 4/22/2017
2.5.0 2,904 2/19/2017
2.4.0 3,005 10/24/2016
2.3.0 2,674 7/9/2016
2.2.0 2,419 4/24/2016
2.1.0 2,311 4/1/2016
2.0.2 9,049 11/15/2015
1.11.0 2,845 9/12/2015
1.10.0 2,201 8/29/2015
1.9.0 2,648 8/10/2015
1.8.0-beta 1,833 7/19/2015
1.7.0 2,302 6/10/2015
1.6.0 3,180 10/25/2014
1.5.0 2,639 9/18/2014
1.4.0 3,012 7/1/2014
1.3.0 2,502 5/17/2014
1.2.0 2,513 4/21/2014
1.1.0 2,422 3/29/2014
1.0.7 2,381 3/12/2014
1.0.5.1 2,479 1/15/2014
1.0.5 2,211 1/7/2014
1.0.4 2,294 11/16/2013
1.0.3 2,311 10/6/2013
1.0.2 2,251 8/16/2013
1.0.1 2,439 7/22/2013
1.0.0 5,332 7/16/2013
0.9.9.2 2,647 7/2/2013
0.9.9.1 2,417 6/22/2013
0.9.8 2,409 6/14/2013
0.9.7 2,354 6/7/2013
0.9.6 2,346 5/31/2013
0.9.5 2,433 5/23/2013
0.9.4 2,284 5/19/2013
0.9.3 2,315 5/9/2013
0.9.2 2,327 5/3/2013
0.9.1 2,546 4/26/2013
0.9.0 2,330 4/19/2013
0.8.9 2,392 4/12/2013
0.8.8 2,359 4/11/2013
0.8.7 2,277 4/9/2013
0.8.6 2,293 4/4/2013
0.8.5 2,378 4/2/2013
0.8.4 2,303 4/1/2013
0.8.3 2,368 4/1/2013
0.8.2 2,257 4/1/2013
0.8.1 2,438 3/31/2013
0.8.0 2,377 3/31/2013

### Added
* Format function application that end with a list in the Stroustrup bracket style. [#2244](https://github.com/fsprojects/fantomas/pull/2244)
* Option to reduce multiple blank lines from source code. [#2198](https://github.com/fsprojects/fantomas/issues/2198)

### Changed
* Update FCS to 'More cleanup', commit e063dd2a7005faf953619ab4f232d1e3606c7ed2
* Rename `fsharp_ragnarok` to `fsharp_experimental_stroupstrup_style` and `fsharp_keep_indent_in_branch` to `fsharp_experimental_keep_indent_in_branch`. [#2251](https://github.com/fsprojects/fantomas/pull/2251)
* Consider wider default format for record declarations if any XML doc comments are present on fields. [#1879](https://github.com/fsprojects/fantomas/issues/1879)

### Removed
* Remove Elmish settings: `fsharp_max_elmish_width`, `fsharp_single_argument_web_mode` & `fsharp_disable_elmish_syntax`. [#2180](https://github.com/fsprojects/fantomas/issues/2180)
* Remove `fsharp_semicolon_at_end_of_line`. [#2247](https://github.com/fsprojects/fantomas/issues/2247)
* Remove `fsharp_keep_if_then_in_same_line`. [#2248](https://github.com/fsprojects/fantomas/issues/2248)
* Remove `fsharp_indent_on_try_with`. [#2249](https://github.com/fsprojects/fantomas/issues/2249)

### Fixed
* A space was added before paren lambda argument. [#2041](https://github.com/fsprojects/fantomas/issues/2041)
* Linq method call breaks because of space before paren lambda was added. [#2231](https://github.com/fsprojects/fantomas/issues/2231)