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 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 0 10/2/2022
5.1.0-alpha-002 2 9/29/2022
5.1.0-alpha-001 98 9/18/2022
5.0.3 4 9/29/2022
5.0.2 210 9/22/2022
5.0.1 645 9/18/2022
5.0.0 1,193 9/16/2022
5.0.0-beta-010 2,145 9/10/2022
5.0.0-beta-009 1,202 9/2/2022
5.0.0-beta-008 1,074 8/30/2022
5.0.0-beta-007 444 8/19/2022
5.0.0-beta-006 1,807 8/12/2022
5.0.0-beta-005 1,758 8/3/2022
5.0.0-beta-004 328 7/27/2022
5.0.0-beta-003 2,352 7/26/2022
5.0.0-beta-002 404 7/19/2022
5.0.0-beta-001 1,818 7/15/2022
5.0.0-alpha-011 442 7/8/2022
5.0.0-alpha-010 1,042 6/27/2022
5.0.0-alpha-009 5,691 6/21/2022
5.0.0-alpha-008 1,132 5/28/2022
5.0.0-alpha-007 595 5/16/2022
5.0.0-alpha-006 666 5/13/2022
5.0.0-alpha-005 169 5/7/2022
5.0.0-alpha-004 388 5/7/2022
5.0.0-alpha-003 594 5/6/2022
5.0.0-alpha-002 80 4/4/2022
5.0.0-alpha-001 70 3/19/2022
4.7.9 3,341 5/2/2022
4.7.8 9,359 4/25/2022
4.7.7 160 4/20/2022
4.7.6 354 4/4/2022
4.7.5 233 3/27/2022
4.7.4 152 3/25/2022
4.7.3 3,753 3/12/2022
4.7.2 132 3/11/2022
4.7.1 136 3/8/2022
4.7.0 229 3/4/2022
4.6.6 145 3/4/2022
4.6.5 834 2/18/2022
4.6.4 201 2/11/2022
4.6.3 209 2/8/2022
4.6.2 273 2/6/2022
4.6.1 236 2/1/2022
4.6.0 683 1/14/2022
4.6.0-beta-001 93 1/8/2022
4.6.0-alpha-011 100 12/29/2021
4.6.0-alpha-010 110 12/4/2021
4.6.0-alpha-009 2,768 11/24/2021
4.6.0-alpha-008 582 11/19/2021
4.6.0-alpha-007 187 11/7/2021
4.6.0-alpha-006 133 11/3/2021
4.6.0-alpha-005 159 10/27/2021
4.6.0-alpha-004 130 10/20/2021
4.6.0-alpha-003 117 10/5/2021
4.6.0-alpha-002 123 9/7/2021
4.6.0-alpha-001 111 8/11/2021
4.5.12 579 1/8/2022
4.5.11 1,404 12/29/2021
4.5.10 1,324 12/4/2021
4.5.9 6,290 11/24/2021
4.5.8 751 11/19/2021
4.5.7 603 11/7/2021
4.5.6 426 11/3/2021
4.5.5 605 10/27/2021
4.5.4 449 10/5/2021
4.5.3 1,998 9/7/2021
4.5.2 562 8/11/2021
4.5.1 1,976 7/24/2021
4.5.0 2,336 7/7/2021
4.5.0-beta-005 248 7/6/2021
4.5.0-beta-004 233 7/5/2021
4.5.0-beta-003 238 7/5/2021
4.5.0-beta-002 252 6/27/2021
4.5.0-beta-001 749 6/5/2021
4.5.0-alpha-020 241 5/26/2021
4.5.0-alpha-019 210 5/22/2021
4.5.0-alpha-018 220 5/21/2021
4.5.0-alpha-017 269 5/15/2021
4.5.0-alpha-016 203 5/9/2021
4.5.0-alpha-015 256 5/8/2021
4.5.0-alpha-014 254 4/30/2021
4.5.0-alpha-013 230 4/27/2021
4.5.0-alpha-012 208 4/23/2021
4.5.0-alpha-011 287 4/20/2021
4.5.0-alpha-010 233 4/14/2021
4.5.0-alpha-009 225 4/11/2021
4.5.0-alpha-008 261 4/8/2021
4.5.0-alpha-007 254 4/8/2021
4.5.0-alpha-006 224 4/5/2021
4.5.0-alpha-005 227 4/3/2021
4.5.0-alpha-004 256 4/2/2021
4.5.0-alpha-003 268 3/28/2021
4.5.0-alpha-002 214 3/22/2021
4.5.0-alpha-001 1,825 2/26/2021
4.4.0 8,990 2/25/2021
4.4.0-beta-008 266 2/19/2021
4.4.0-beta-007 257 2/12/2021
4.4.0-beta-006 258 2/12/2021
4.4.0-beta-005 254 2/9/2021
4.4.0-beta-004 258 2/5/2021
4.4.0-beta-003 694 1/30/2021
4.4.0-beta-002 256 1/23/2021
4.4.0-beta-001 690 1/22/2021
4.4.0-alpha-008 477 1/15/2021
4.4.0-alpha-007 974 12/26/2020
4.4.0-alpha-006 364 12/25/2020
4.4.0-alpha-005 426 12/23/2020
4.4.0-alpha-004 475 12/22/2020
4.4.0-alpha-003 467 12/18/2020
4.4.0-alpha-002 402 12/17/2020
4.4.0-alpha-001 334 12/17/2020
4.3.0 2,753 12/17/2020
4.3.0-beta-002 407 12/11/2020
4.3.0-beta-001 339 12/7/2020
4.3.0-alpha-007 395 11/21/2020
4.3.0-alpha-006 353 11/20/2020
4.3.0-alpha-005 311 11/16/2020
4.3.0-alpha-004 800 11/12/2020
4.3.0-alpha-003 343 11/10/2020
4.3.0-alpha-002 352 10/26/2020
4.3.0-alpha-001 386 10/23/2020
4.2.0 3,865 9/25/2020
4.2.0-alpha-004 545 9/23/2020
4.2.0-alpha-003 360 9/21/2020
4.2.0-alpha-002 398 9/19/2020
4.2.0-alpha-001 467 9/18/2020
4.1.1 717 9/17/2020
4.1.0 948 9/10/2020
4.1.0-beta-004 504 9/5/2020
4.1.0-beta-003 402 9/4/2020
4.1.0-beta-002 812 9/4/2020
4.1.0-beta-001 402 9/3/2020
4.1.0-alpha-001 390 9/1/2020
4.0.0 2,817 8/27/2020
4.0.0-beta-003 419 8/21/2020
4.0.0-beta-002 491 8/7/2020
4.0.0-beta-001 820 7/20/2020
4.0.0-alpha-014 663 7/14/2020
4.0.0-alpha-013 427 7/11/2020
4.0.0-alpha-012 745 7/6/2020
4.0.0-alpha-011 311 6/25/2020
4.0.0-alpha-010 697 6/18/2020
4.0.0-alpha-009 334 6/12/2020
4.0.0-alpha-008 470 6/2/2020
4.0.0-alpha-007 321 6/1/2020
4.0.0-alpha-006 1,158 5/23/2020
4.0.0-alpha-005 1,098 5/16/2020
4.0.0-alpha-004 766 5/4/2020
4.0.0-alpha-003 397 5/3/2020
4.0.0-alpha-002 421 4/26/2020
4.0.0-alpha-001 311 4/20/2020
3.3.0 11,055 2/28/2020
3.3.0-beta-002 1,280 2/21/2020
3.3.0-beta-001 442 2/18/2020
3.2.0 19,967 2/3/2020
3.2.0-beta-002 1,040 1/7/2020
3.2.0-beta-001 584 12/26/2019
3.1.0 9,646 11/27/2019
3.0.0 4,061 10/11/2019
3.0.0-beta-006 1,158 10/2/2019
3.0.0-beta-005 353 9/27/2019
3.0.0-beta-004 951 9/18/2019
3.0.0-beta-003 482 9/13/2019
3.0.0-beta-002 14,076 7/20/2019
3.0.0-beta-001 5,114 7/12/2019
2.9.2 22,878 2/2/2019
2.9.1 3,461 11/20/2018
2.9.0 8,007 10/17/2018
2.8.1 1,505 9/12/2018
2.8.0 4,764 7/7/2018
2.7.1 3,644 5/2/2018
2.7.0 1,243 5/2/2018
2.6.1 44,607 4/22/2017
2.5.0 1,938 2/19/2017
2.4.0 2,042 10/24/2016
2.3.0 1,721 7/9/2016
2.2.0 1,456 4/24/2016
2.1.0 1,326 4/1/2016
2.0.2 8,060 11/15/2015
1.11.0 1,899 9/12/2015
1.10.0 1,255 8/29/2015
1.9.0 1,659 8/10/2015
1.8.0-beta 1,142 7/19/2015
1.7.0 1,405 6/10/2015
1.6.0 2,233 10/25/2014
1.5.0 1,661 9/18/2014
1.4.0 2,021 7/1/2014
1.3.0 1,559 5/17/2014
1.2.0 1,549 4/21/2014
1.1.0 1,420 3/29/2014
1.0.7 1,422 3/12/2014
1.0.5.1 1,480 1/15/2014
1.0.5 1,223 1/7/2014
1.0.4 1,281 11/16/2013
1.0.3 1,304 10/6/2013
1.0.2 1,272 8/16/2013
1.0.1 1,418 7/22/2013
1.0.0 1,706 7/16/2013
0.9.9.2 1,621 7/2/2013
0.9.9.1 1,442 6/22/2013
0.9.8 1,402 6/14/2013
0.9.7 1,373 6/7/2013
0.9.6 1,339 5/31/2013
0.9.5 1,451 5/23/2013
0.9.4 1,343 5/19/2013
0.9.3 1,315 5/9/2013
0.9.2 1,329 5/3/2013
0.9.1 1,606 4/26/2013
0.9.0 1,376 4/19/2013
0.8.9 1,386 4/12/2013
0.8.8 1,330 4/11/2013
0.8.7 1,312 4/9/2013
0.8.6 1,318 4/4/2013
0.8.5 1,389 4/2/2013
0.8.4 1,331 4/1/2013
0.8.3 1,345 4/1/2013
0.8.2 1,310 4/1/2013
0.8.1 1,379 3/31/2013
0.8.0 1,372 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)