fantomas 5.0.0-alpha-010

.NET 6.0
This is a prerelease version of fantomas.
There is a newer prerelease 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
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package fantomas --version 5.0.0-alpha-010
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
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
5.0.0-beta-006 70 8/12/2022
5.0.0-beta-005 814 8/3/2022
5.0.0-beta-004 187 7/27/2022
5.0.0-beta-003 966 7/26/2022
5.0.0-beta-002 236 7/19/2022
5.0.0-beta-001 805 7/15/2022
5.0.0-alpha-011 421 7/8/2022
5.0.0-alpha-010 947 6/27/2022
5.0.0-alpha-009 850 6/21/2022
5.0.0-alpha-008 952 5/28/2022
5.0.0-alpha-007 584 5/16/2022
5.0.0-alpha-006 655 5/13/2022
5.0.0-alpha-005 160 5/7/2022
5.0.0-alpha-004 379 5/7/2022
5.0.0-alpha-003 583 5/6/2022
5.0.0-alpha-002 77 4/4/2022
5.0.0-alpha-001 62 3/19/2022
4.7.9 2,493 5/2/2022
4.7.8 6,574 4/25/2022
4.7.7 123 4/20/2022
4.7.6 310 4/4/2022
4.7.5 188 3/27/2022
4.7.4 110 3/25/2022
4.7.3 3,714 3/12/2022
4.7.2 98 3/11/2022
4.7.1 104 3/8/2022
4.7.0 197 3/4/2022
4.6.6 114 3/4/2022
4.6.5 715 2/18/2022
4.6.4 172 2/11/2022
4.6.3 161 2/8/2022
4.6.2 238 2/6/2022
4.6.1 202 2/1/2022
4.6.0 632 1/14/2022
4.6.0-beta-001 89 1/8/2022
4.6.0-alpha-011 94 12/29/2021
4.6.0-alpha-010 101 12/4/2021
4.6.0-alpha-009 2,759 11/24/2021
4.6.0-alpha-008 577 11/19/2021
4.6.0-alpha-007 175 11/7/2021
4.6.0-alpha-006 126 11/3/2021
4.6.0-alpha-005 149 10/27/2021
4.6.0-alpha-004 122 10/20/2021
4.6.0-alpha-003 108 10/5/2021
4.6.0-alpha-002 115 9/7/2021
4.6.0-alpha-001 99 8/11/2021
4.5.12 530 1/8/2022
4.5.11 1,384 12/29/2021
4.5.10 1,285 12/4/2021
4.5.9 6,270 11/24/2021
4.5.8 731 11/19/2021
4.5.7 577 11/7/2021
4.5.6 409 11/3/2021
4.5.5 584 10/27/2021
4.5.4 433 10/5/2021
4.5.3 1,977 9/7/2021
4.5.2 539 8/11/2021
4.5.1 1,932 7/24/2021
4.5.0 2,317 7/7/2021
4.5.0-beta-005 240 7/6/2021
4.5.0-beta-004 221 7/5/2021
4.5.0-beta-003 230 7/5/2021
4.5.0-beta-002 237 6/27/2021
4.5.0-beta-001 739 6/5/2021
4.5.0-alpha-020 232 5/26/2021
4.5.0-alpha-019 204 5/22/2021
4.5.0-alpha-018 209 5/21/2021
4.5.0-alpha-017 261 5/15/2021
4.5.0-alpha-016 196 5/9/2021
4.5.0-alpha-015 247 5/8/2021
4.5.0-alpha-014 242 4/30/2021
4.5.0-alpha-013 218 4/27/2021
4.5.0-alpha-012 197 4/23/2021
4.5.0-alpha-011 280 4/20/2021
4.5.0-alpha-010 221 4/14/2021
4.5.0-alpha-009 217 4/11/2021
4.5.0-alpha-008 243 4/8/2021
4.5.0-alpha-007 244 4/8/2021
4.5.0-alpha-006 213 4/5/2021
4.5.0-alpha-005 221 4/3/2021
4.5.0-alpha-004 242 4/2/2021
4.5.0-alpha-003 257 3/28/2021
4.5.0-alpha-002 203 3/22/2021
4.5.0-alpha-001 1,815 2/26/2021
4.4.0 8,803 2/25/2021
4.4.0-beta-008 258 2/19/2021
4.4.0-beta-007 245 2/12/2021
4.4.0-beta-006 246 2/12/2021
4.4.0-beta-005 245 2/9/2021
4.4.0-beta-004 250 2/5/2021
4.4.0-beta-003 689 1/30/2021
4.4.0-beta-002 250 1/23/2021
4.4.0-beta-001 678 1/22/2021
4.4.0-alpha-008 470 1/15/2021
4.4.0-alpha-007 966 12/26/2020
4.4.0-alpha-006 357 12/25/2020
4.4.0-alpha-005 418 12/23/2020
4.4.0-alpha-004 467 12/22/2020
4.4.0-alpha-003 459 12/18/2020
4.4.0-alpha-002 396 12/17/2020
4.4.0-alpha-001 328 12/17/2020
4.3.0 2,725 12/17/2020
4.3.0-beta-002 398 12/11/2020
4.3.0-beta-001 330 12/7/2020
4.3.0-alpha-007 391 11/21/2020
4.3.0-alpha-006 349 11/20/2020
4.3.0-alpha-005 304 11/16/2020
4.3.0-alpha-004 793 11/12/2020
4.3.0-alpha-003 335 11/10/2020
4.3.0-alpha-002 346 10/26/2020
4.3.0-alpha-001 380 10/23/2020
4.2.0 3,839 9/25/2020
4.2.0-alpha-004 534 9/23/2020
4.2.0-alpha-003 349 9/21/2020
4.2.0-alpha-002 395 9/19/2020
4.2.0-alpha-001 462 9/18/2020
4.1.1 692 9/17/2020
4.1.0 922 9/10/2020
4.1.0-beta-004 496 9/5/2020
4.1.0-beta-003 392 9/4/2020
4.1.0-beta-002 806 9/4/2020
4.1.0-beta-001 392 9/3/2020
4.1.0-alpha-001 383 9/1/2020
4.0.0 2,789 8/27/2020
4.0.0-beta-003 407 8/21/2020
4.0.0-beta-002 485 8/7/2020
4.0.0-beta-001 812 7/20/2020
4.0.0-alpha-014 656 7/14/2020
4.0.0-alpha-013 422 7/11/2020
4.0.0-alpha-012 737 7/6/2020
4.0.0-alpha-011 305 6/25/2020
4.0.0-alpha-010 689 6/18/2020
4.0.0-alpha-009 326 6/12/2020
4.0.0-alpha-008 462 6/2/2020
4.0.0-alpha-007 311 6/1/2020
4.0.0-alpha-006 1,150 5/23/2020
4.0.0-alpha-005 1,087 5/16/2020
4.0.0-alpha-004 756 5/4/2020
4.0.0-alpha-003 389 5/3/2020
4.0.0-alpha-002 414 4/26/2020
4.0.0-alpha-001 304 4/20/2020
3.3.0 10,908 2/28/2020
3.3.0-beta-002 1,271 2/21/2020
3.3.0-beta-001 434 2/18/2020
3.2.0 19,878 2/3/2020
3.2.0-beta-002 1,030 1/7/2020
3.2.0-beta-001 575 12/26/2019
3.1.0 9,624 11/27/2019
3.0.0 4,047 10/11/2019
3.0.0-beta-006 1,149 10/2/2019
3.0.0-beta-005 347 9/27/2019
3.0.0-beta-004 942 9/18/2019
3.0.0-beta-003 472 9/13/2019
3.0.0-beta-002 14,009 7/20/2019
3.0.0-beta-001 5,102 7/12/2019
2.9.2 22,709 2/2/2019
2.9.1 3,390 11/20/2018
2.9.0 7,980 10/17/2018
2.8.1 1,468 9/12/2018
2.8.0 4,714 7/7/2018
2.7.1 3,602 5/2/2018
2.7.0 1,193 5/2/2018
2.6.1 44,580 4/22/2017
2.5.0 1,906 2/19/2017
2.4.0 2,014 10/24/2016
2.3.0 1,688 7/9/2016
2.2.0 1,425 4/24/2016
2.1.0 1,295 4/1/2016
2.0.2 8,021 11/15/2015
1.11.0 1,859 9/12/2015
1.10.0 1,216 8/29/2015
1.9.0 1,621 8/10/2015
1.8.0-beta 1,123 7/19/2015
1.7.0 1,363 6/10/2015
1.6.0 2,200 10/25/2014
1.5.0 1,627 9/18/2014
1.4.0 1,985 7/1/2014
1.3.0 1,522 5/17/2014
1.2.0 1,515 4/21/2014
1.1.0 1,385 3/29/2014
1.0.7 1,384 3/12/2014
1.0.5.1 1,447 1/15/2014
1.0.5 1,190 1/7/2014
1.0.4 1,238 11/16/2013
1.0.3 1,263 10/6/2013
1.0.2 1,233 8/16/2013
1.0.1 1,382 7/22/2013
1.0.0 1,614 7/16/2013
0.9.9.2 1,583 7/2/2013
0.9.9.1 1,407 6/22/2013
0.9.8 1,369 6/14/2013
0.9.7 1,339 6/7/2013
0.9.6 1,295 5/31/2013
0.9.5 1,413 5/23/2013
0.9.4 1,292 5/19/2013
0.9.3 1,272 5/9/2013
0.9.2 1,285 5/3/2013
0.9.1 1,564 4/26/2013
0.9.0 1,336 4/19/2013
0.8.9 1,350 4/12/2013
0.8.8 1,286 4/11/2013
0.8.7 1,264 4/9/2013
0.8.6 1,278 4/4/2013
0.8.5 1,355 4/2/2013
0.8.4 1,289 4/1/2013
0.8.3 1,303 4/1/2013
0.8.2 1,271 4/1/2013
0.8.1 1,341 3/31/2013
0.8.0 1,334 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)