fantomas 5.0.0-beta-005

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

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.1.0-alpha-003 27 10/2/2022
5.1.0-alpha-002 41 9/29/2022
5.1.0-alpha-001 106 9/18/2022
5.0.4 5 10/4/2022
5.0.3 251 9/29/2022
5.0.2 379 9/22/2022
5.0.1 825 9/18/2022
5.0.0 1,603 9/16/2022
5.0.0-beta-010 2,587 9/10/2022
5.0.0-beta-009 1,329 9/2/2022
5.0.0-beta-008 1,170 8/30/2022
5.0.0-beta-007 447 8/19/2022
5.0.0-beta-006 1,808 8/12/2022
5.0.0-beta-005 1,946 8/3/2022
5.0.0-beta-004 351 7/27/2022
5.0.0-beta-003 2,444 7/26/2022
5.0.0-beta-002 417 7/19/2022
5.0.0-beta-001 1,822 7/15/2022
5.0.0-alpha-011 442 7/8/2022
5.0.0-alpha-010 1,044 6/27/2022
5.0.0-alpha-009 6,512 6/21/2022
5.0.0-alpha-008 1,133 5/28/2022
5.0.0-alpha-007 597 5/16/2022
5.0.0-alpha-006 667 5/13/2022
5.0.0-alpha-005 170 5/7/2022
5.0.0-alpha-004 389 5/7/2022
5.0.0-alpha-003 595 5/6/2022
5.0.0-alpha-002 82 4/4/2022
5.0.0-alpha-001 71 3/19/2022
4.7.9 3,432 5/2/2022
4.7.8 9,370 4/25/2022
4.7.7 171 4/20/2022
4.7.6 367 4/4/2022
4.7.5 247 3/27/2022
4.7.4 158 3/25/2022
4.7.3 3,759 3/12/2022
4.7.2 143 3/11/2022
4.7.1 147 3/8/2022
4.7.0 240 3/4/2022
4.6.6 156 3/4/2022
4.6.5 854 2/18/2022
4.6.4 217 2/11/2022
4.6.3 220 2/8/2022
4.6.2 284 2/6/2022
4.6.1 250 2/1/2022
4.6.0 705 1/14/2022
4.6.0-beta-001 94 1/8/2022
4.6.0-alpha-011 101 12/29/2021
4.6.0-alpha-010 112 12/4/2021
4.6.0-alpha-009 2,769 11/24/2021
4.6.0-alpha-008 583 11/19/2021
4.6.0-alpha-007 188 11/7/2021
4.6.0-alpha-006 134 11/3/2021
4.6.0-alpha-005 160 10/27/2021
4.6.0-alpha-004 131 10/20/2021
4.6.0-alpha-003 117 10/5/2021
4.6.0-alpha-002 124 9/7/2021
4.6.0-alpha-001 112 8/11/2021
4.5.12 591 1/8/2022
4.5.11 1,410 12/29/2021
4.5.10 1,335 12/4/2021
4.5.9 6,296 11/24/2021
4.5.8 756 11/19/2021
4.5.7 604 11/7/2021
4.5.6 432 11/3/2021
4.5.5 611 10/27/2021
4.5.4 455 10/5/2021
4.5.3 2,004 9/7/2021
4.5.2 563 8/11/2021
4.5.1 1,986 7/24/2021
4.5.0 2,342 7/7/2021
4.5.0-beta-005 249 7/6/2021
4.5.0-beta-004 234 7/5/2021
4.5.0-beta-003 239 7/5/2021
4.5.0-beta-002 253 6/27/2021
4.5.0-beta-001 750 6/5/2021
4.5.0-alpha-020 243 5/26/2021
4.5.0-alpha-019 211 5/22/2021
4.5.0-alpha-018 221 5/21/2021
4.5.0-alpha-017 270 5/15/2021
4.5.0-alpha-016 205 5/9/2021
4.5.0-alpha-015 258 5/8/2021
4.5.0-alpha-014 256 4/30/2021
4.5.0-alpha-013 232 4/27/2021
4.5.0-alpha-012 210 4/23/2021
4.5.0-alpha-011 289 4/20/2021
4.5.0-alpha-010 235 4/14/2021
4.5.0-alpha-009 228 4/11/2021
4.5.0-alpha-008 263 4/8/2021
4.5.0-alpha-007 256 4/8/2021
4.5.0-alpha-006 226 4/5/2021
4.5.0-alpha-005 229 4/3/2021
4.5.0-alpha-004 258 4/2/2021
4.5.0-alpha-003 270 3/28/2021
4.5.0-alpha-002 216 3/22/2021
4.5.0-alpha-001 1,827 2/26/2021
4.4.0 9,005 2/25/2021
4.4.0-beta-008 268 2/19/2021
4.4.0-beta-007 259 2/12/2021
4.4.0-beta-006 260 2/12/2021
4.4.0-beta-005 256 2/9/2021
4.4.0-beta-004 260 2/5/2021
4.4.0-beta-003 696 1/30/2021
4.4.0-beta-002 258 1/23/2021
4.4.0-beta-001 692 1/22/2021
4.4.0-alpha-008 479 1/15/2021
4.4.0-alpha-007 976 12/26/2020
4.4.0-alpha-006 366 12/25/2020
4.4.0-alpha-005 428 12/23/2020
4.4.0-alpha-004 477 12/22/2020
4.4.0-alpha-003 469 12/18/2020
4.4.0-alpha-002 404 12/17/2020
4.4.0-alpha-001 336 12/17/2020
4.3.0 2,761 12/17/2020
4.3.0-beta-002 408 12/11/2020
4.3.0-beta-001 340 12/7/2020
4.3.0-alpha-007 397 11/21/2020
4.3.0-alpha-006 355 11/20/2020
4.3.0-alpha-005 312 11/16/2020
4.3.0-alpha-004 801 11/12/2020
4.3.0-alpha-003 345 11/10/2020
4.3.0-alpha-002 353 10/26/2020
4.3.0-alpha-001 388 10/23/2020
4.2.0 3,867 9/25/2020
4.2.0-alpha-004 546 9/23/2020
4.2.0-alpha-003 361 9/21/2020
4.2.0-alpha-002 400 9/19/2020
4.2.0-alpha-001 469 9/18/2020
4.1.1 719 9/17/2020
4.1.0 950 9/10/2020
4.1.0-beta-004 506 9/5/2020
4.1.0-beta-003 404 9/4/2020
4.1.0-beta-002 814 9/4/2020
4.1.0-beta-001 405 9/3/2020
4.1.0-alpha-001 392 9/1/2020
4.0.0 2,823 8/27/2020
4.0.0-beta-003 421 8/21/2020
4.0.0-beta-002 493 8/7/2020
4.0.0-beta-001 822 7/20/2020
4.0.0-alpha-014 665 7/14/2020
4.0.0-alpha-013 429 7/11/2020
4.0.0-alpha-012 747 7/6/2020
4.0.0-alpha-011 313 6/25/2020
4.0.0-alpha-010 699 6/18/2020
4.0.0-alpha-009 336 6/12/2020
4.0.0-alpha-008 472 6/2/2020
4.0.0-alpha-007 324 6/1/2020
4.0.0-alpha-006 1,163 5/23/2020
4.0.0-alpha-005 1,100 5/16/2020
4.0.0-alpha-004 768 5/4/2020
4.0.0-alpha-003 399 5/3/2020
4.0.0-alpha-002 423 4/26/2020
4.0.0-alpha-001 313 4/20/2020
3.3.0 11,062 2/28/2020
3.3.0-beta-002 1,282 2/21/2020
3.3.0-beta-001 444 2/18/2020
3.2.0 19,969 2/3/2020
3.2.0-beta-002 1,042 1/7/2020
3.2.0-beta-001 586 12/26/2019
3.1.0 9,655 11/27/2019
3.0.0 4,069 10/11/2019
3.0.0-beta-006 1,160 10/2/2019
3.0.0-beta-005 355 9/27/2019
3.0.0-beta-004 953 9/18/2019
3.0.0-beta-003 484 9/13/2019
3.0.0-beta-002 14,081 7/20/2019
3.0.0-beta-001 5,117 7/12/2019
2.9.2 22,896 2/2/2019
2.9.1 3,469 11/20/2018
2.9.0 8,009 10/17/2018
2.8.1 1,521 9/12/2018
2.8.0 4,782 7/7/2018
2.7.1 3,660 5/2/2018
2.7.0 1,259 5/2/2018
2.6.1 44,617 4/22/2017
2.5.0 1,946 2/19/2017
2.4.0 2,050 10/24/2016
2.3.0 1,723 7/9/2016
2.2.0 1,458 4/24/2016
2.1.0 1,328 4/1/2016
2.0.2 8,062 11/15/2015
1.11.0 1,901 9/12/2015
1.10.0 1,257 8/29/2015
1.9.0 1,661 8/10/2015
1.8.0-beta 1,144 7/19/2015
1.7.0 1,407 6/10/2015
1.6.0 2,241 10/25/2014
1.5.0 1,669 9/18/2014
1.4.0 2,023 7/1/2014
1.3.0 1,561 5/17/2014
1.2.0 1,557 4/21/2014
1.1.0 1,428 3/29/2014
1.0.7 1,430 3/12/2014
1.0.5.1 1,488 1/15/2014
1.0.5 1,231 1/7/2014
1.0.4 1,284 11/16/2013
1.0.3 1,306 10/6/2013
1.0.2 1,280 8/16/2013
1.0.1 1,426 7/22/2013
1.0.0 1,767 7/16/2013
0.9.9.2 1,629 7/2/2013
0.9.9.1 1,450 6/22/2013
0.9.8 1,410 6/14/2013
0.9.7 1,381 6/7/2013
0.9.6 1,341 5/31/2013
0.9.5 1,453 5/23/2013
0.9.4 1,345 5/19/2013
0.9.3 1,317 5/9/2013
0.9.2 1,331 5/3/2013
0.9.1 1,608 4/26/2013
0.9.0 1,384 4/19/2013
0.8.9 1,394 4/12/2013
0.8.8 1,332 4/11/2013
0.8.7 1,314 4/9/2013
0.8.6 1,326 4/4/2013
0.8.5 1,397 4/2/2013
0.8.4 1,333 4/1/2013
0.8.3 1,347 4/1/2013
0.8.2 1,312 4/1/2013
0.8.1 1,381 3/31/2013
0.8.0 1,374 3/31/2013

### Changed
* Update FCS to 'SynType with single slash and type', commit e1f735546a907b0a511b818f10829b1d75139021

### Fixed
* Fantomas moves comma and breaks code. [#2381](https://github.com/fsprojects/fantomas/issues/2381)
* Idempotency problem for unit of measure. [2264](https://github.com/fsprojects/fantomas/issues/2264)
* Indent interface member after anonymous record as generic type. [#2396](https://github.com/fsprojects/fantomas/issues/2396)
* Unexpected concatenation of docstring lines after private modifier on DU. [#2401](https://github.com/fsprojects/fantomas/issues/2401)
* Star in tuple return type lost. [#2403](https://github.com/fsprojects/fantomas/issues/2403)