fantomas 5.0.0-alpha-011

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

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-002 90 11/2/2024
7.0.0-alpha-001 118 9/16/2024
6.3.16 4,536 10/29/2024
6.3.15 14,107 9/14/2024
6.3.14 115 9/14/2024
6.3.13 902 9/10/2024
6.3.12 4,303 9/5/2024
6.3.11 15,690 8/16/2024
6.3.10 17,021 7/12/2024
6.3.9 20,315 6/9/2024
6.3.8 957 6/6/2024
6.3.7 1,728 6/1/2024
6.3.6 181 6/1/2024
6.3.5 854 5/30/2024
6.3.4 25,034 4/16/2024
6.3.3 4,889 4/12/2024
6.3.2 301 4/12/2024
6.3.1 11,008 3/30/2024
6.3.0 14,018 3/15/2024
6.3.0-beta-001 1,047 3/7/2024
6.3.0-alpha-008 816 3/1/2024
6.3.0-alpha-007 1,958 1/27/2024
6.3.0-alpha-006 834 1/9/2024
6.3.0-alpha-005 1,213 12/22/2023
6.3.0-alpha-004 1,907 12/6/2023
6.3.0-alpha-003 1,474 11/15/2023
6.3.0-alpha-002 927 11/7/2023
6.3.0-alpha-001 773 11/3/2023
6.2.3 119,289 11/2/2023
6.2.2 26,815 10/18/2023
6.2.1 9,755 9/18/2023
6.2.0 24,432 8/29/2023
6.1.3 1,447 8/25/2023
6.1.2 14,630 7/23/2023
6.1.1 78,029 6/29/2023
6.1.0 7,536 6/28/2023
6.1.0-alpha-006 1,106 6/20/2023
6.1.0-alpha-005 1,031 6/20/2023
6.1.0-alpha-004 846 6/19/2023
6.1.0-alpha-003 1,114 6/2/2023
6.1.0-alpha-002 977 5/2/2023
6.1.0-alpha-001 985 5/2/2023
6.0.8 2,001 6/20/2023
6.0.7 1,279 6/20/2023
6.0.6 1,464 6/19/2023
6.0.5 5,016 6/6/2023
6.0.4 1,310 6/2/2023
6.0.3 12,451 5/14/2023
6.0.2 4,157 5/5/2023
6.0.1 62,849 4/19/2023
6.0.0 43,718 4/13/2023
6.0.0-beta-001 1,488 4/5/2023
6.0.0-alpha-010 7,056 4/3/2023
6.0.0-alpha-009 821 3/31/2023
6.0.0-alpha-008 2,067 3/27/2023
6.0.0-alpha-007 1,352 3/27/2023
6.0.0-alpha-006 1,491 3/17/2023
6.0.0-alpha-005 2,369 2/24/2023
6.0.0-alpha-004 8,944 2/22/2023
6.0.0-alpha-003 2,949 2/4/2023
6.0.0-alpha-002 896 2/1/2023
6.0.0-alpha-001 1,036 1/24/2023
5.2.4 6,116 3/17/2023
5.2.3 5,590 3/6/2023
5.2.2 13,229 2/21/2023
5.2.1 60,581 2/4/2023
5.2.0 6,843 1/19/2023
5.2.0-alpha-012 1,168 1/14/2023
5.2.0-alpha-011 1,387 1/12/2023
5.2.0-alpha-010 1,092 12/30/2022
5.2.0-alpha-009 1,026 12/29/2022
5.2.0-alpha-008 1,251 12/28/2022
5.2.0-alpha-007 1,016 12/26/2022
5.2.0-alpha-006 1,021 12/22/2022
5.2.0-alpha-005 1,150 12/16/2022
5.2.0-alpha-004 1,263 12/8/2022
5.2.0-alpha-003 1,034 12/6/2022
5.2.0-alpha-002 989 12/4/2022
5.2.0-alpha-001 929 11/30/2022
5.1.5 25,227 12/22/2022
5.1.4 26,835 11/30/2022
5.1.3 7,489 11/14/2022
5.1.2 1,544 11/10/2022
5.1.1 4,071 11/7/2022
5.1.0 2,762 11/4/2022
5.1.0-beta-002 997 10/29/2022
5.1.0-beta-001 1,367 10/19/2022
5.1.0-alpha-007 1,044 10/14/2022
5.1.0-alpha-006 1,001 10/14/2022
5.1.0-alpha-005 1,146 10/7/2022
5.1.0-alpha-004 1,157 10/7/2022
5.1.0-alpha-003 1,167 10/2/2022
5.1.0-alpha-002 1,051 9/29/2022
5.1.0-alpha-001 1,092 9/18/2022
5.0.6 24,758 10/13/2022
5.0.5 9,999 10/7/2022
5.0.4 2,187 10/4/2022
5.0.3 10,701 9/29/2022
5.0.2 8,292 9/22/2022
5.0.1 6,382 9/18/2022
5.0.0 21,233 9/16/2022
5.0.0-beta-010 21,751 9/10/2022
5.0.0-beta-009 9,544 9/2/2022
5.0.0-beta-008 3,027 8/30/2022
5.0.0-beta-007 1,610 8/19/2022
5.0.0-beta-006 2,924 8/12/2022
5.0.0-beta-005 5,080 8/3/2022
5.0.0-beta-004 2,299 7/27/2022
5.0.0-beta-003 3,715 7/26/2022
5.0.0-beta-002 1,899 7/19/2022
5.0.0-beta-001 2,892 7/15/2022
5.0.0-alpha-011 1,616 7/8/2022
5.0.0-alpha-010 2,191 6/27/2022
5.0.0-alpha-009 78,351 6/21/2022
5.0.0-alpha-008 3,026 5/28/2022
5.0.0-alpha-007 1,845 5/16/2022
5.0.0-alpha-006 1,865 5/13/2022
5.0.0-alpha-005 1,347 5/7/2022
5.0.0-alpha-004 1,439 5/7/2022
5.0.0-alpha-003 1,896 5/6/2022
5.0.0-alpha-002 745 4/4/2022
5.0.0-alpha-001 695 3/19/2022
4.7.9 11,222 5/2/2022
4.7.8 10,543 4/25/2022
4.7.7 1,165 4/20/2022
4.7.6 1,436 4/4/2022
4.7.5 1,289 3/27/2022
4.7.4 1,253 3/25/2022
4.7.3 4,823 3/12/2022
4.7.2 1,177 3/11/2022
4.7.1 1,143 3/8/2022
4.7.0 1,296 3/4/2022
4.6.6 1,202 3/4/2022
4.6.5 1,957 2/18/2022
4.6.4 1,722 2/11/2022
4.6.3 1,771 2/8/2022
4.6.2 1,758 2/6/2022
4.6.1 1,752 2/1/2022
4.6.0 2,255 1/14/2022
4.6.0-beta-001 816 1/8/2022
4.6.0-alpha-011 799 12/29/2021
4.6.0-alpha-010 813 12/4/2021
4.6.0-alpha-009 3,453 11/24/2021
4.6.0-alpha-008 1,229 11/19/2021
4.6.0-alpha-007 852 11/7/2021
4.6.0-alpha-006 209 11/3/2021
4.6.0-alpha-005 233 10/27/2021
4.6.0-alpha-004 211 10/20/2021
4.6.0-alpha-003 192 10/5/2021
4.6.0-alpha-002 204 9/7/2021
4.6.0-alpha-001 180 8/11/2021
4.5.12 1,620 1/8/2022
4.5.11 2,408 12/29/2021
4.5.10 2,652 12/4/2021
4.5.9 7,545 11/24/2021
4.5.8 1,759 11/19/2021
4.5.7 1,585 11/7/2021
4.5.6 1,381 11/3/2021
4.5.5 1,538 10/27/2021
4.5.4 1,444 10/5/2021
4.5.3 2,948 9/7/2021
4.5.2 1,594 8/11/2021
4.5.1 3,440 7/24/2021
4.5.0 3,361 7/7/2021
4.5.0-beta-005 920 7/6/2021
4.5.0-beta-004 895 7/5/2021
4.5.0-beta-003 925 7/5/2021
4.5.0-beta-002 924 6/27/2021
4.5.0-beta-001 1,419 6/5/2021
4.5.0-alpha-020 869 5/26/2021
4.5.0-alpha-019 881 5/22/2021
4.5.0-alpha-018 916 5/21/2021
4.5.0-alpha-017 874 5/15/2021
4.5.0-alpha-016 845 5/9/2021
4.5.0-alpha-015 936 5/8/2021
4.5.0-alpha-014 983 4/30/2021
4.5.0-alpha-013 901 4/27/2021
4.5.0-alpha-012 891 4/23/2021
4.5.0-alpha-011 985 4/20/2021
4.5.0-alpha-010 901 4/14/2021
4.5.0-alpha-009 911 4/11/2021
4.5.0-alpha-008 910 4/8/2021
4.5.0-alpha-007 931 4/8/2021
4.5.0-alpha-006 884 4/5/2021
4.5.0-alpha-005 911 4/3/2021
4.5.0-alpha-004 927 4/2/2021
4.5.0-alpha-003 973 3/28/2021
4.5.0-alpha-002 940 3/22/2021
4.5.0-alpha-001 2,566 2/26/2021
4.4.0 13,327 2/25/2021
4.4.0-beta-008 981 2/19/2021
4.4.0-beta-007 972 2/12/2021
4.4.0-beta-006 961 2/12/2021
4.4.0-beta-005 1,020 2/9/2021
4.4.0-beta-004 1,005 2/5/2021
4.4.0-beta-003 1,459 1/30/2021
4.4.0-beta-002 991 1/23/2021
4.4.0-beta-001 1,394 1/22/2021
4.4.0-alpha-008 1,161 1/15/2021
4.4.0-alpha-007 1,660 12/26/2020
4.4.0-alpha-006 1,072 12/25/2020
4.4.0-alpha-005 1,156 12/23/2020
4.4.0-alpha-004 1,180 12/22/2020
4.4.0-alpha-003 1,191 12/18/2020
4.4.0-alpha-002 1,161 12/17/2020
4.4.0-alpha-001 1,060 12/17/2020
4.3.0 5,632 12/17/2020
4.3.0-beta-002 1,116 12/11/2020
4.3.0-beta-001 1,076 12/7/2020
4.3.0-alpha-007 1,090 11/21/2020
4.3.0-alpha-006 1,085 11/20/2020
4.3.0-alpha-005 1,035 11/16/2020
4.3.0-alpha-004 1,526 11/12/2020
4.3.0-alpha-003 1,114 11/10/2020
4.3.0-alpha-002 1,094 10/26/2020
4.3.0-alpha-001 1,123 10/23/2020
4.2.0 4,984 9/25/2020
4.2.0-alpha-004 1,274 9/23/2020
4.2.0-alpha-003 1,072 9/21/2020
4.2.0-alpha-002 1,141 9/19/2020
4.2.0-alpha-001 1,191 9/18/2020
4.1.1 1,768 9/17/2020
4.1.0 1,982 9/10/2020
4.1.0-beta-004 1,221 9/5/2020
4.1.0-beta-003 1,159 9/4/2020
4.1.0-beta-002 1,511 9/4/2020
4.1.0-beta-001 1,133 9/3/2020
4.1.0-alpha-001 1,115 9/1/2020
4.0.0 4,165 8/27/2020
4.0.0-beta-003 1,163 8/21/2020
4.0.0-beta-002 1,211 8/7/2020
4.0.0-beta-001 1,531 7/20/2020
4.0.0-alpha-014 1,340 7/14/2020
4.0.0-alpha-013 1,148 7/11/2020
4.0.0-alpha-012 1,975 7/6/2020
4.0.0-alpha-011 998 6/25/2020
4.0.0-alpha-010 1,374 6/18/2020
4.0.0-alpha-009 1,052 6/12/2020
4.0.0-alpha-008 1,173 6/2/2020
4.0.0-alpha-007 1,045 6/1/2020
4.0.0-alpha-006 2,316 5/23/2020
4.0.0-alpha-005 2,147 5/16/2020
4.0.0-alpha-004 1,459 5/4/2020
4.0.0-alpha-003 1,111 5/3/2020
4.0.0-alpha-002 1,151 4/26/2020
4.0.0-alpha-001 1,049 4/20/2020
3.3.0 12,901 2/28/2020
3.3.0-beta-002 1,988 2/21/2020
3.3.0-beta-001 1,162 2/18/2020
3.2.0 21,190 2/3/2020
3.2.0-beta-002 1,731 1/7/2020
3.2.0-beta-001 1,291 12/26/2019
3.1.0 10,667 11/27/2019
3.0.0 5,017 10/11/2019
3.0.0-beta-006 1,872 10/2/2019
3.0.0-beta-005 1,056 9/27/2019
3.0.0-beta-004 1,633 9/18/2019
3.0.0-beta-003 1,193 9/13/2019
3.0.0-beta-002 16,613 7/20/2019
3.0.0-beta-001 5,870 7/12/2019
2.9.2 25,740 2/2/2019
2.9.1 4,967 11/20/2018
2.9.0 11,379 10/17/2018
2.8.1 2,788 9/12/2018
2.8.0 5,990 7/7/2018
2.7.1 4,873 5/2/2018
2.7.0 2,524 5/2/2018
2.6.1 45,701 4/22/2017
2.5.0 2,950 2/19/2017
2.4.0 3,069 10/24/2016
2.3.0 2,724 7/9/2016
2.2.0 2,462 4/24/2016
2.1.0 2,356 4/1/2016
2.0.2 9,095 11/15/2015
1.11.0 2,892 9/12/2015
1.10.0 2,246 8/29/2015
1.9.0 2,702 8/10/2015
1.8.0-beta 1,878 7/19/2015
1.7.0 2,357 6/10/2015
1.6.0 3,225 10/25/2014
1.5.0 2,691 9/18/2014
1.4.0 3,058 7/1/2014
1.3.0 2,551 5/17/2014
1.2.0 2,564 4/21/2014
1.1.0 2,484 3/29/2014
1.0.7 2,438 3/12/2014
1.0.5.1 2,536 1/15/2014
1.0.5 2,262 1/7/2014
1.0.4 2,344 11/16/2013
1.0.3 2,359 10/6/2013
1.0.2 2,300 8/16/2013
1.0.1 2,490 7/22/2013
1.0.0 5,584 7/16/2013
0.9.9.2 2,696 7/2/2013
0.9.9.1 2,467 6/22/2013
0.9.8 2,455 6/14/2013
0.9.7 2,408 6/7/2013
0.9.6 2,392 5/31/2013
0.9.5 2,479 5/23/2013
0.9.4 2,331 5/19/2013
0.9.3 2,359 5/9/2013
0.9.2 2,380 5/3/2013
0.9.1 2,594 4/26/2013
0.9.0 2,377 4/19/2013
0.8.9 2,441 4/12/2013
0.8.8 2,406 4/11/2013
0.8.7 2,322 4/9/2013
0.8.6 2,341 4/4/2013
0.8.5 2,424 4/2/2013
0.8.4 2,350 4/1/2013
0.8.3 2,417 4/1/2013
0.8.2 2,301 4/1/2013
0.8.1 2,486 3/31/2013
0.8.0 2,428 3/31/2013

### Added
* Add setting `fsharp_max_if_then_short_width`. [#2299](https://github.com/fsprojects/fantomas/issues/2299)

### Changed
* Restore the CodeFormatter.MakeRange public API. [#2306](https://github.com/fsprojects/fantomas/pull/2306)
* Update FCS to 'Add arrow to SynType.Fun trivia.', commit 5a5a5f6cd07aa4a8326baa07d4f7af1305ced6f4
* Update FCS to 'Fix setter first', commit 267d0a57f217df756d9ac33c6aa4ffbfe3b53097
* Update style of long if/match expressions (See [fslang-design#646](https://github.com/fsharp/fslang-design/issues/646)). [#2334](https://github.com/fsprojects/fantomas/pull/2334)
* `--force` will now write a file even when the result is invalid. [#2346](https://github.com/fsprojects/fantomas/issues/2346)

### Removed
* `--stdin`, `--stdout` and `--fsi` flags. [#2346](https://github.com/fsprojects/fantomas/issues/2346)

### Fixed
* KeepIndentInBranch not respected inside a let and match. [1825](https://github.com/fsprojects/fantomas/issues/1825)