fantomas 5.0.0-alpha-009

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

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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
6.2.1 1,376 9/18/2023
6.2.0 4,068 8/29/2023
6.1.3 621 8/25/2023
6.1.2 7,621 7/23/2023
6.1.1 11,445 6/29/2023
6.1.0 3,914 6/28/2023
6.1.0-alpha-006 239 6/20/2023
6.1.0-alpha-005 166 6/20/2023
6.1.0-alpha-004 135 6/19/2023
6.1.0-alpha-003 267 6/2/2023
6.1.0-alpha-002 230 5/2/2023
6.1.0-alpha-001 178 5/2/2023
6.0.8 1,145 6/20/2023
6.0.7 498 6/20/2023
6.0.6 675 6/19/2023
6.0.5 3,394 6/6/2023
6.0.4 768 6/2/2023
6.0.3 7,097 5/14/2023
6.0.2 2,895 5/5/2023
6.0.1 17,438 4/19/2023
6.0.0 12,031 4/13/2023
6.0.0-beta-001 635 4/5/2023
6.0.0-alpha-010 663 4/3/2023
6.0.0-alpha-009 251 3/31/2023
6.0.0-alpha-008 1,352 3/27/2023
6.0.0-alpha-007 473 3/27/2023
6.0.0-alpha-006 651 3/17/2023
6.0.0-alpha-005 1,392 2/24/2023
6.0.0-alpha-004 4,962 2/22/2023
6.0.0-alpha-003 2,197 2/4/2023
6.0.0-alpha-002 236 2/1/2023
6.0.0-alpha-001 255 1/24/2023
5.2.4 4,462 3/17/2023
5.2.3 4,567 3/6/2023
5.2.2 9,002 2/21/2023
5.2.1 22,562 2/4/2023
5.2.0 5,798 1/19/2023
5.2.0-alpha-012 469 1/14/2023
5.2.0-alpha-011 643 1/12/2023
5.2.0-alpha-010 283 12/30/2022
5.2.0-alpha-009 231 12/29/2022
5.2.0-alpha-008 344 12/28/2022
5.2.0-alpha-007 244 12/26/2022
5.2.0-alpha-006 304 12/22/2022
5.2.0-alpha-005 255 12/16/2022
5.2.0-alpha-004 497 12/8/2022
5.2.0-alpha-003 237 12/6/2022
5.2.0-alpha-002 219 12/4/2022
5.2.0-alpha-001 290 11/30/2022
5.1.5 19,196 12/22/2022
5.1.4 21,022 11/30/2022
5.1.3 5,699 11/14/2022
5.1.2 977 11/10/2022
5.1.1 3,307 11/7/2022
5.1.0 2,041 11/4/2022
5.1.0-beta-002 246 10/29/2022
5.1.0-beta-001 391 10/19/2022
5.1.0-alpha-007 271 10/14/2022
5.1.0-alpha-006 229 10/14/2022
5.1.0-alpha-005 305 10/7/2022
5.1.0-alpha-004 289 10/7/2022
5.1.0-alpha-003 362 10/2/2022
5.1.0-alpha-002 260 9/29/2022
5.1.0-alpha-001 373 9/18/2022
5.0.6 19,443 10/13/2022
5.0.5 7,039 10/7/2022
5.0.4 1,118 10/4/2022
5.0.3 8,254 9/29/2022
5.0.2 5,472 9/22/2022
5.0.1 3,939 9/18/2022
5.0.0 19,136 9/16/2022
5.0.0-beta-010 11,950 9/10/2022
5.0.0-beta-009 7,478 9/2/2022
5.0.0-beta-008 2,222 8/30/2022
5.0.0-beta-007 691 8/19/2022
5.0.0-beta-006 2,080 8/12/2022
5.0.0-beta-005 4,121 8/3/2022
5.0.0-beta-004 1,226 7/27/2022
5.0.0-beta-003 2,837 7/26/2022
5.0.0-beta-002 1,041 7/19/2022
5.0.0-beta-001 2,118 7/15/2022
5.0.0-alpha-011 693 7/8/2022
5.0.0-alpha-010 1,269 6/27/2022
5.0.0-alpha-009 45,794 6/21/2022
5.0.0-alpha-008 1,717 5/28/2022
5.0.0-alpha-007 881 5/16/2022
5.0.0-alpha-006 873 5/13/2022
5.0.0-alpha-005 382 5/7/2022
5.0.0-alpha-004 556 5/7/2022
5.0.0-alpha-003 832 5/6/2022
5.0.0-alpha-002 251 4/4/2022
5.0.0-alpha-001 227 3/19/2022
4.7.9 10,092 5/2/2022
4.7.8 10,044 4/25/2022
4.7.7 705 4/20/2022
4.7.6 912 4/4/2022
4.7.5 800 3/27/2022
4.7.4 735 3/25/2022
4.7.3 4,337 3/12/2022
4.7.2 684 3/11/2022
4.7.1 676 3/8/2022
4.7.0 809 3/4/2022
4.6.6 703 3/4/2022
4.6.5 1,457 2/18/2022
4.6.4 1,215 2/11/2022
4.6.3 1,243 2/8/2022
4.6.2 1,265 2/6/2022
4.6.1 1,253 2/1/2022
4.6.0 1,739 1/14/2022
4.6.0-beta-001 278 1/8/2022
4.6.0-alpha-011 304 12/29/2021
4.6.0-alpha-010 299 12/4/2021
4.6.0-alpha-009 2,974 11/24/2021
4.6.0-alpha-008 767 11/19/2021
4.6.0-alpha-007 368 11/7/2021
4.6.0-alpha-006 184 11/3/2021
4.6.0-alpha-005 209 10/27/2021
4.6.0-alpha-004 188 10/20/2021
4.6.0-alpha-003 169 10/5/2021
4.6.0-alpha-002 177 9/7/2021
4.6.0-alpha-001 157 8/11/2021
4.5.12 1,109 1/8/2022
4.5.11 1,872 12/29/2021
4.5.10 2,198 12/4/2021
4.5.9 7,020 11/24/2021
4.5.8 1,255 11/19/2021
4.5.7 1,106 11/7/2021
4.5.6 896 11/3/2021
4.5.5 1,041 10/27/2021
4.5.4 922 10/5/2021
4.5.3 2,479 9/7/2021
4.5.2 1,071 8/11/2021
4.5.1 2,885 7/24/2021
4.5.0 2,855 7/7/2021
4.5.0-beta-005 449 7/6/2021
4.5.0-beta-004 417 7/5/2021
4.5.0-beta-003 443 7/5/2021
4.5.0-beta-002 426 6/27/2021
4.5.0-beta-001 943 6/5/2021
4.5.0-alpha-020 426 5/26/2021
4.5.0-alpha-019 398 5/22/2021
4.5.0-alpha-018 432 5/21/2021
4.5.0-alpha-017 450 5/15/2021
4.5.0-alpha-016 377 5/9/2021
4.5.0-alpha-015 456 5/8/2021
4.5.0-alpha-014 449 4/30/2021
4.5.0-alpha-013 437 4/27/2021
4.5.0-alpha-012 410 4/23/2021
4.5.0-alpha-011 476 4/20/2021
4.5.0-alpha-010 410 4/14/2021
4.5.0-alpha-009 407 4/11/2021
4.5.0-alpha-008 446 4/8/2021
4.5.0-alpha-007 449 4/8/2021
4.5.0-alpha-006 423 4/5/2021
4.5.0-alpha-005 395 4/3/2021
4.5.0-alpha-004 453 4/2/2021
4.5.0-alpha-003 464 3/28/2021
4.5.0-alpha-002 433 3/22/2021
4.5.0-alpha-001 2,046 2/26/2021
4.4.0 11,946 2/25/2021
4.4.0-beta-008 464 2/19/2021
4.4.0-beta-007 469 2/12/2021
4.4.0-beta-006 443 2/12/2021
4.4.0-beta-005 455 2/9/2021
4.4.0-beta-004 471 2/5/2021
4.4.0-beta-003 903 1/30/2021
4.4.0-beta-002 457 1/23/2021
4.4.0-beta-001 901 1/22/2021
4.4.0-alpha-008 662 1/15/2021
4.4.0-alpha-007 1,166 12/26/2020
4.4.0-alpha-006 571 12/25/2020
4.4.0-alpha-005 643 12/23/2020
4.4.0-alpha-004 684 12/22/2020
4.4.0-alpha-003 692 12/18/2020
4.4.0-alpha-002 635 12/17/2020
4.4.0-alpha-001 536 12/17/2020
4.3.0 3,433 12/17/2020
4.3.0-beta-002 622 12/11/2020
4.3.0-beta-001 552 12/7/2020
4.3.0-alpha-007 594 11/21/2020
4.3.0-alpha-006 568 11/20/2020
4.3.0-alpha-005 525 11/16/2020
4.3.0-alpha-004 1,015 11/12/2020
4.3.0-alpha-003 579 11/10/2020
4.3.0-alpha-002 584 10/26/2020
4.3.0-alpha-001 598 10/23/2020
4.2.0 4,400 9/25/2020
4.2.0-alpha-004 752 9/23/2020
4.2.0-alpha-003 582 9/21/2020
4.2.0-alpha-002 635 9/19/2020
4.2.0-alpha-001 679 9/18/2020
4.1.1 1,239 9/17/2020
4.1.0 1,453 9/10/2020
4.1.0-beta-004 719 9/5/2020
4.1.0-beta-003 626 9/4/2020
4.1.0-beta-002 1,008 9/4/2020
4.1.0-beta-001 603 9/3/2020
4.1.0-alpha-001 601 9/1/2020
4.0.0 3,560 8/27/2020
4.0.0-beta-003 632 8/21/2020
4.0.0-beta-002 722 8/7/2020
4.0.0-beta-001 1,019 7/20/2020
4.0.0-alpha-014 836 7/14/2020
4.0.0-alpha-013 641 7/11/2020
4.0.0-alpha-012 1,339 7/6/2020
4.0.0-alpha-011 519 6/25/2020
4.0.0-alpha-010 880 6/18/2020
4.0.0-alpha-009 535 6/12/2020
4.0.0-alpha-008 677 6/2/2020
4.0.0-alpha-007 536 6/1/2020
4.0.0-alpha-006 1,732 5/23/2020
4.0.0-alpha-005 1,568 5/16/2020
4.0.0-alpha-004 968 5/4/2020
4.0.0-alpha-003 601 5/3/2020
4.0.0-alpha-002 635 4/26/2020
4.0.0-alpha-001 537 4/20/2020
3.3.0 12,205 2/28/2020
3.3.0-beta-002 1,481 2/21/2020
3.3.0-beta-001 660 2/18/2020
3.2.0 20,630 2/3/2020
3.2.0-beta-002 1,250 1/7/2020
3.2.0-beta-001 794 12/26/2019
3.1.0 10,145 11/27/2019
3.0.0 4,510 10/11/2019
3.0.0-beta-006 1,365 10/2/2019
3.0.0-beta-005 542 9/27/2019
3.0.0-beta-004 1,143 9/18/2019
3.0.0-beta-003 678 9/13/2019
3.0.0-beta-002 14,801 7/20/2019
3.0.0-beta-001 5,314 7/12/2019
2.9.2 24,220 2/2/2019
2.9.1 4,393 11/20/2018
2.9.0 9,659 10/17/2018
2.8.1 2,217 9/12/2018
2.8.0 5,434 7/7/2018
2.7.1 4,327 5/2/2018
2.7.0 1,944 5/2/2018
2.6.1 45,117 4/22/2017
2.5.0 2,399 2/19/2017
2.4.0 2,512 10/24/2016
2.3.0 2,172 7/9/2016
2.2.0 1,927 4/24/2016
2.1.0 1,818 4/1/2016
2.0.2 8,539 11/15/2015
1.11.0 2,348 9/12/2015
1.10.0 1,713 8/29/2015
1.9.0 2,157 8/10/2015
1.8.0-beta 1,348 7/19/2015
1.7.0 1,840 6/10/2015
1.6.0 2,682 10/25/2014
1.5.0 2,153 9/18/2014
1.4.0 2,514 7/1/2014
1.3.0 2,009 5/17/2014
1.2.0 2,024 4/21/2014
1.1.0 1,925 3/29/2014
1.0.7 1,901 3/12/2014
1.0.5.1 1,980 1/15/2014
1.0.5 1,723 1/7/2014
1.0.4 1,790 11/16/2013
1.0.3 1,816 10/6/2013
1.0.2 1,785 8/16/2013
1.0.1 1,932 7/22/2013
1.0.0 4,808 7/16/2013
0.9.9.2 2,119 7/2/2013
0.9.9.1 1,917 6/22/2013
0.9.8 1,901 6/14/2013
0.9.7 1,878 6/7/2013
0.9.6 1,830 5/31/2013
0.9.5 1,934 5/23/2013
0.9.4 1,790 5/19/2013
0.9.3 1,799 5/9/2013
0.9.2 1,828 5/3/2013
0.9.1 2,047 4/26/2013
0.9.0 1,820 4/19/2013
0.8.9 1,885 4/12/2013
0.8.8 1,867 4/11/2013
0.8.7 1,784 4/9/2013
0.8.6 1,790 4/4/2013
0.8.5 1,878 4/2/2013
0.8.4 1,787 4/1/2013
0.8.3 1,876 4/1/2013
0.8.2 1,791 4/1/2013
0.8.1 1,923 3/31/2013
0.8.0 1,875 3/31/2013

### Fixed
* Explicit interface with SpaceBeforeClassConstructor. [#2226](https://github.com/fsprojects/fantomas/issues/2226)
* Spaces around binary operators in units of measure. [#2207](https://github.com/fsprojects/fantomas/issues/2207)
* Trivia not restored after long identifier in SynField. [#2290](https://github.com/fsprojects/fantomas/pull/2290)
* Content after hash directive is lost. [#2293](https://github.com/fsprojects/fantomas/pull/2293)
* Idempotency problem with computation expression with generic parameter. [#2285](https://github.com/fsprojects/fantomas/pull/2285)