fantomas 5.0.0-alpha-011

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

This package has no dependencies.

Version Downloads Last updated
6.3.0-alpha-004 89 12/6/2023
6.3.0-alpha-003 356 11/15/2023
6.3.0-alpha-002 167 11/7/2023
6.3.0-alpha-001 113 11/3/2023
6.2.3 9,162 11/2/2023
6.2.2 4,154 10/18/2023
6.2.1 5,831 9/18/2023
6.2.0 14,857 8/29/2023
6.1.3 817 8/25/2023
6.1.2 9,975 7/23/2023
6.1.1 16,935 6/29/2023
6.1.0 4,795 6/28/2023
6.1.0-alpha-006 448 6/20/2023
6.1.0-alpha-005 362 6/20/2023
6.1.0-alpha-004 275 6/19/2023
6.1.0-alpha-003 436 6/2/2023
6.1.0-alpha-002 324 5/2/2023
6.1.0-alpha-001 398 5/2/2023
6.0.8 1,355 6/20/2023
6.0.7 560 6/20/2023
6.0.6 764 6/19/2023
6.0.5 3,774 6/6/2023
6.0.4 857 6/2/2023
6.0.3 9,672 5/14/2023
6.0.2 3,175 5/5/2023
6.0.1 26,047 4/19/2023
6.0.0 18,218 4/13/2023
6.0.0-beta-001 822 4/5/2023
6.0.0-alpha-010 2,053 4/3/2023
6.0.0-alpha-009 357 3/31/2023
6.0.0-alpha-008 1,519 3/27/2023
6.0.0-alpha-007 647 3/27/2023
6.0.0-alpha-006 829 3/17/2023
6.0.0-alpha-005 1,665 2/24/2023
6.0.0-alpha-004 6,382 2/22/2023
6.0.0-alpha-003 2,382 2/4/2023
6.0.0-alpha-002 419 2/1/2023
6.0.0-alpha-001 393 1/24/2023
5.2.4 4,877 3/17/2023
5.2.3 4,797 3/6/2023
5.2.2 10,403 2/21/2023
5.2.1 30,096 2/4/2023
5.2.0 6,101 1/19/2023
5.2.0-alpha-012 648 1/14/2023
5.2.0-alpha-011 861 1/12/2023
5.2.0-alpha-010 430 12/30/2022
5.2.0-alpha-009 423 12/29/2022
5.2.0-alpha-008 501 12/28/2022
5.2.0-alpha-007 302 12/26/2022
5.2.0-alpha-006 495 12/22/2022
5.2.0-alpha-005 478 12/16/2022
5.2.0-alpha-004 629 12/8/2022
5.2.0-alpha-003 436 12/6/2022
5.2.0-alpha-002 340 12/4/2022
5.2.0-alpha-001 420 11/30/2022
5.1.5 21,144 12/22/2022
5.1.4 24,327 11/30/2022
5.1.3 5,971 11/14/2022
5.1.2 1,066 11/10/2022
5.1.1 3,377 11/7/2022
5.1.0 2,189 11/4/2022
5.1.0-beta-002 371 10/29/2022
5.1.0-beta-001 630 10/19/2022
5.1.0-alpha-007 450 10/14/2022
5.1.0-alpha-006 382 10/14/2022
5.1.0-alpha-005 502 10/7/2022
5.1.0-alpha-004 514 10/7/2022
5.1.0-alpha-003 520 10/2/2022
5.1.0-alpha-002 443 9/29/2022
5.1.0-alpha-001 484 9/18/2022
5.0.6 20,968 10/13/2022
5.0.5 7,269 10/7/2022
5.0.4 1,326 10/4/2022
5.0.3 9,121 9/29/2022
5.0.2 6,350 9/22/2022
5.0.1 4,163 9/18/2022
5.0.0 20,197 9/16/2022
5.0.0-beta-010 13,684 9/10/2022
5.0.0-beta-009 7,806 9/2/2022
5.0.0-beta-008 2,378 8/30/2022
5.0.0-beta-007 895 8/19/2022
5.0.0-beta-006 2,266 8/12/2022
5.0.0-beta-005 4,349 8/3/2022
5.0.0-beta-004 1,482 7/27/2022
5.0.0-beta-003 2,994 7/26/2022
5.0.0-beta-002 1,214 7/19/2022
5.0.0-beta-001 2,311 7/15/2022
5.0.0-alpha-011 792 7/8/2022
5.0.0-alpha-010 1,433 6/27/2022
5.0.0-alpha-009 49,991 6/21/2022
5.0.0-alpha-008 1,996 5/28/2022
5.0.0-alpha-007 1,064 5/16/2022
5.0.0-alpha-006 1,070 5/13/2022
5.0.0-alpha-005 624 5/7/2022
5.0.0-alpha-004 698 5/7/2022
5.0.0-alpha-003 1,102 5/6/2022
5.0.0-alpha-002 338 4/4/2022
5.0.0-alpha-001 294 3/19/2022
4.7.9 10,305 5/2/2022
4.7.8 10,124 4/25/2022
4.7.7 783 4/20/2022
4.7.6 993 4/4/2022
4.7.5 885 3/27/2022
4.7.4 815 3/25/2022
4.7.3 4,408 3/12/2022
4.7.2 760 3/11/2022
4.7.1 764 3/8/2022
4.7.0 906 3/4/2022
4.6.6 779 3/4/2022
4.6.5 1,544 2/18/2022
4.6.4 1,301 2/11/2022
4.6.3 1,333 2/8/2022
4.6.2 1,352 2/6/2022
4.6.1 1,336 2/1/2022
4.6.0 1,830 1/14/2022
4.6.0-beta-001 365 1/8/2022
4.6.0-alpha-011 383 12/29/2021
4.6.0-alpha-010 376 12/4/2021
4.6.0-alpha-009 3,038 11/24/2021
4.6.0-alpha-008 856 11/19/2021
4.6.0-alpha-007 433 11/7/2021
4.6.0-alpha-006 189 11/3/2021
4.6.0-alpha-005 215 10/27/2021
4.6.0-alpha-004 193 10/20/2021
4.6.0-alpha-003 173 10/5/2021
4.6.0-alpha-002 184 9/7/2021
4.6.0-alpha-001 160 8/11/2021
4.5.12 1,207 1/8/2022
4.5.11 1,959 12/29/2021
4.5.10 2,284 12/4/2021
4.5.9 7,109 11/24/2021
4.5.8 1,337 11/19/2021
4.5.7 1,171 11/7/2021
4.5.6 978 11/3/2021
4.5.5 1,124 10/27/2021
4.5.4 1,003 10/5/2021
4.5.3 2,559 9/7/2021
4.5.2 1,152 8/11/2021
4.5.1 2,964 7/24/2021
4.5.0 2,933 7/7/2021
4.5.0-beta-005 528 7/6/2021
4.5.0-beta-004 505 7/5/2021
4.5.0-beta-003 518 7/5/2021
4.5.0-beta-002 503 6/27/2021
4.5.0-beta-001 1,019 6/5/2021
4.5.0-alpha-020 509 5/26/2021
4.5.0-alpha-019 477 5/22/2021
4.5.0-alpha-018 509 5/21/2021
4.5.0-alpha-017 530 5/15/2021
4.5.0-alpha-016 454 5/9/2021
4.5.0-alpha-015 533 5/8/2021
4.5.0-alpha-014 521 4/30/2021
4.5.0-alpha-013 514 4/27/2021
4.5.0-alpha-012 489 4/23/2021
4.5.0-alpha-011 554 4/20/2021
4.5.0-alpha-010 496 4/14/2021
4.5.0-alpha-009 487 4/11/2021
4.5.0-alpha-008 523 4/8/2021
4.5.0-alpha-007 525 4/8/2021
4.5.0-alpha-006 507 4/5/2021
4.5.0-alpha-005 469 4/3/2021
4.5.0-alpha-004 531 4/2/2021
4.5.0-alpha-003 527 3/28/2021
4.5.0-alpha-002 520 3/22/2021
4.5.0-alpha-001 2,133 2/26/2021
4.4.0 12,124 2/25/2021
4.4.0-beta-008 548 2/19/2021
4.4.0-beta-007 551 2/12/2021
4.4.0-beta-006 528 2/12/2021
4.4.0-beta-005 547 2/9/2021
4.4.0-beta-004 555 2/5/2021
4.4.0-beta-003 993 1/30/2021
4.4.0-beta-002 537 1/23/2021
4.4.0-beta-001 984 1/22/2021
4.4.0-alpha-008 747 1/15/2021
4.4.0-alpha-007 1,249 12/26/2020
4.4.0-alpha-006 654 12/25/2020
4.4.0-alpha-005 728 12/23/2020
4.4.0-alpha-004 766 12/22/2020
4.4.0-alpha-003 775 12/18/2020
4.4.0-alpha-002 726 12/17/2020
4.4.0-alpha-001 620 12/17/2020
4.3.0 4,216 12/17/2020
4.3.0-beta-002 707 12/11/2020
4.3.0-beta-001 632 12/7/2020
4.3.0-alpha-007 680 11/21/2020
4.3.0-alpha-006 654 11/20/2020
4.3.0-alpha-005 608 11/16/2020
4.3.0-alpha-004 1,107 11/12/2020
4.3.0-alpha-003 665 11/10/2020
4.3.0-alpha-002 678 10/26/2020
4.3.0-alpha-001 685 10/23/2020
4.2.0 4,494 9/25/2020
4.2.0-alpha-004 834 9/23/2020
4.2.0-alpha-003 669 9/21/2020
4.2.0-alpha-002 716 9/19/2020
4.2.0-alpha-001 768 9/18/2020
4.1.1 1,324 9/17/2020
4.1.0 1,539 9/10/2020
4.1.0-beta-004 803 9/5/2020
4.1.0-beta-003 706 9/4/2020
4.1.0-beta-002 1,088 9/4/2020
4.1.0-beta-001 688 9/3/2020
4.1.0-alpha-001 685 9/1/2020
4.0.0 3,651 8/27/2020
4.0.0-beta-003 718 8/21/2020
4.0.0-beta-002 802 8/7/2020
4.0.0-beta-001 1,100 7/20/2020
4.0.0-alpha-014 917 7/14/2020
4.0.0-alpha-013 721 7/11/2020
4.0.0-alpha-012 1,413 7/6/2020
4.0.0-alpha-011 604 6/25/2020
4.0.0-alpha-010 961 6/18/2020
4.0.0-alpha-009 623 6/12/2020
4.0.0-alpha-008 758 6/2/2020
4.0.0-alpha-007 622 6/1/2020
4.0.0-alpha-006 1,820 5/23/2020
4.0.0-alpha-005 1,650 5/16/2020
4.0.0-alpha-004 1,051 5/4/2020
4.0.0-alpha-003 682 5/3/2020
4.0.0-alpha-002 720 4/26/2020
4.0.0-alpha-001 621 4/20/2020
3.3.0 12,306 2/28/2020
3.3.0-beta-002 1,566 2/21/2020
3.3.0-beta-001 747 2/18/2020
3.2.0 20,720 2/3/2020
3.2.0-beta-002 1,328 1/7/2020
3.2.0-beta-001 877 12/26/2019
3.1.0 10,229 11/27/2019
3.0.0 4,595 10/11/2019
3.0.0-beta-006 1,447 10/2/2019
3.0.0-beta-005 626 9/27/2019
3.0.0-beta-004 1,226 9/18/2019
3.0.0-beta-003 760 9/13/2019
3.0.0-beta-002 15,057 7/20/2019
3.0.0-beta-001 5,404 7/12/2019
2.9.2 24,432 2/2/2019
2.9.1 4,504 11/20/2018
2.9.0 9,901 10/17/2018
2.8.1 2,305 9/12/2018
2.8.0 5,519 7/7/2018
2.7.1 4,422 5/2/2018
2.7.0 2,030 5/2/2018
2.6.1 45,220 4/22/2017
2.5.0 2,492 2/19/2017
2.4.0 2,604 10/24/2016
2.3.0 2,262 7/9/2016
2.2.0 2,022 4/24/2016
2.1.0 1,902 4/1/2016
2.0.2 8,629 11/15/2015
1.11.0 2,439 9/12/2015
1.10.0 1,800 8/29/2015
1.9.0 2,247 8/10/2015
1.8.0-beta 1,437 7/19/2015
1.7.0 1,932 6/10/2015
1.6.0 2,771 10/25/2014
1.5.0 2,244 9/18/2014
1.4.0 2,603 7/1/2014
1.3.0 2,096 5/17/2014
1.2.0 2,110 4/21/2014
1.1.0 2,014 3/29/2014
1.0.7 1,992 3/12/2014
1.0.5.1 2,067 1/15/2014
1.0.5 1,809 1/7/2014
1.0.4 1,880 11/16/2013
1.0.3 1,905 10/6/2013
1.0.2 1,875 8/16/2013
1.0.1 2,021 7/22/2013
1.0.0 4,910 7/16/2013
0.9.9.2 2,212 7/2/2013
0.9.9.1 2,006 6/22/2013
0.9.8 1,993 6/14/2013
0.9.7 1,968 6/7/2013
0.9.6 1,924 5/31/2013
0.9.5 2,022 5/23/2013
0.9.4 1,886 5/19/2013
0.9.3 1,893 5/9/2013
0.9.2 1,919 5/3/2013
0.9.1 2,140 4/26/2013
0.9.0 1,911 4/19/2013
0.8.9 1,972 4/12/2013
0.8.8 1,957 4/11/2013
0.8.7 1,876 4/9/2013
0.8.6 1,880 4/4/2013
0.8.5 1,972 4/2/2013
0.8.4 1,881 4/1/2013
0.8.3 1,966 4/1/2013
0.8.2 1,855 4/1/2013
0.8.1 2,012 3/31/2013
0.8.0 1,976 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)