fantomas-tool 4.7.9

.NET Core 3.1
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global fantomas-tool --version 4.7.9
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-tool --version 4.7.9
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=fantomas-tool&version=4.7.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package fantomas-tool --version 4.7.9
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-tool

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-tool 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-tool 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 "(%s -> %s)" (t1.ToString()) (t2.ToString())
                 | 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 "(%s -> %s)" (t1.ToString()) (t2.ToString())
             | 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 net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.1
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-alpha-002 180 4/4/2022
5.0.0-alpha-001 64 3/19/2022
4.7.9 1,125 5/2/2022
4.7.8 952 4/25/2022
4.7.7 1,063 4/20/2022
4.7.6 2,900 4/4/2022
4.7.5 3,053 3/27/2022
4.7.4 324 3/25/2022
4.7.3 3,135 3/12/2022
4.7.2 829 3/11/2022
4.7.1 1,707 3/8/2022
4.7.0 2,602 3/4/2022
4.6.6 108 3/4/2022
4.6.5 2,993 2/18/2022
4.6.4 1,574 2/11/2022
4.6.3 1,884 2/8/2022
4.6.2 558 2/6/2022
4.6.1 4,430 2/1/2022
4.6.0 8,241 1/14/2022
4.6.0-beta-001 363 1/8/2022
4.6.0-alpha-011 687 12/29/2021
4.6.0-alpha-010 1,059 12/4/2021
4.6.0-alpha-009 3,059 11/24/2021
4.6.0-alpha-008 640 11/19/2021
4.6.0-alpha-007 752 11/7/2021
4.6.0-alpha-006 951 11/3/2021
4.6.0-alpha-005 299 10/27/2021
4.6.0-alpha-004 22,730 10/20/2021
4.6.0-alpha-003 300 10/5/2021
4.6.0-alpha-002 232 9/7/2021
4.6.0-alpha-001 135 8/11/2021
4.5.12 364 1/8/2022
4.5.11 875 12/29/2021
4.5.10 5,805 12/4/2021
4.5.9 5,141 11/24/2021
4.5.8 1,836 11/19/2021
4.5.7 781 11/7/2021
4.5.6 907 11/3/2021
4.5.5 536 10/27/2021
4.5.4 7,594 10/5/2021
4.5.3 7,300 9/7/2021
4.5.2 7,526 8/11/2021
4.5.1 3,890 7/24/2021
4.5.0 3,596 7/7/2021
4.5.0-beta-005 198 7/6/2021
4.5.0-beta-004 149 7/5/2021
4.5.0-beta-003 197 7/5/2021
4.5.0-beta-002 582 6/27/2021
4.5.0-beta-001 2,226 6/5/2021
4.5.0-alpha-020 208 5/26/2021
4.5.0-alpha-019 576 5/22/2021
4.5.0-alpha-018 148 5/21/2021
4.5.0-alpha-017 446 5/15/2021
4.5.0-alpha-016 207 5/9/2021
4.5.0-alpha-015 385 5/8/2021
4.5.0-alpha-014 395 4/30/2021
4.5.0-alpha-013 287 4/27/2021
4.5.0-alpha-012 204 4/23/2021
4.5.0-alpha-011 419 4/20/2021
4.5.0-alpha-010 451 4/14/2021
4.5.0-alpha-009 164 4/11/2021
4.5.0-alpha-008 404 4/8/2021
4.5.0-alpha-007 194 4/8/2021
4.5.0-alpha-006 174 4/5/2021
4.5.0-alpha-005 604 4/3/2021
4.5.0-alpha-004 191 4/2/2021
4.5.0-alpha-003 507 3/28/2021
4.5.0-alpha-002 332 3/22/2021
4.5.0-alpha-001 4,678 2/26/2021
4.4.0 23,142 2/25/2021
4.4.0-beta-008 538 2/19/2021
4.4.0-beta-007 183 2/12/2021
4.4.0-beta-006 429 2/12/2021
4.4.0-beta-005 225 2/9/2021
4.4.0-beta-004 388 2/5/2021
4.4.0-beta-003 442 1/30/2021
4.4.0-beta-002 331 1/23/2021
4.4.0-beta-001 210 1/22/2021
4.4.0-alpha-008 282 1/15/2021
4.4.0-alpha-007 2,581 12/26/2020
4.4.0-alpha-006 259 12/25/2020
4.4.0-alpha-005 237 12/23/2020
4.4.0-alpha-004 214 12/22/2020
4.4.0-alpha-003 269 12/18/2020
4.4.0-alpha-002 249 12/17/2020
4.4.0-alpha-001 270 12/17/2020
4.3.0 4,022 12/17/2020
4.3.0-beta-002 277 12/11/2020
4.3.0-beta-001 241 12/7/2020
4.3.0-alpha-007 278 11/21/2020
4.3.0-alpha-006 292 11/20/2020
4.3.0-alpha-005 247 11/16/2020
4.3.0-alpha-004 245 11/12/2020
4.3.0-alpha-003 232 11/10/2020
4.3.0-alpha-002 270 10/26/2020
4.3.0-alpha-001 1,179 10/23/2020
4.2.0 5,332 9/25/2020
4.2.0-alpha-004 380 9/23/2020
4.2.0-alpha-003 269 9/21/2020
4.2.0-alpha-002 317 9/19/2020
4.2.0-alpha-001 291 9/18/2020
4.1.1 1,525 9/17/2020
4.1.0 609 9/10/2020
4.1.0-beta-004 355 9/5/2020
4.1.0-beta-003 334 9/4/2020
4.1.0-beta-002 306 9/4/2020
4.1.0-beta-001 303 9/3/2020
4.1.0-alpha-001 315 9/1/2020
4.0.0 2,513 8/27/2020
4.0.0-beta-003 274 8/21/2020
4.0.0-beta-002 865 8/7/2020
4.0.0-beta-001 563 7/20/2020
4.0.0-alpha-014 348 7/14/2020
4.0.0-alpha-013 294 7/11/2020
4.0.0-alpha-012 606 7/6/2020
4.0.0-alpha-011 284 6/25/2020
4.0.0-alpha-010 277 6/18/2020
4.0.0-alpha-009 279 6/12/2020
4.0.0-alpha-008 294 6/2/2020
4.0.0-alpha-007 266 6/1/2020
4.0.0-alpha-006 335 5/23/2020
4.0.0-alpha-005 492 5/16/2020
4.0.0-alpha-004 804 5/4/2020
4.0.0-alpha-003 329 5/3/2020
4.0.0-alpha-002 280 4/26/2020
4.0.0-alpha-001 273 4/20/2020
3.3.0 4,947 2/28/2020
3.3.0-beta-002 879 2/21/2020
3.3.0-beta-001 384 2/18/2020
3.2.0 1,443 2/3/2020
3.2.0-beta-002 570 1/7/2020
3.2.0-beta-001 350 12/26/2019
3.1.0 10,792 11/27/2019
3.0.0 755 10/11/2019
3.0.0-beta-006 319 10/2/2019
3.0.0-beta-005 305 9/27/2019
3.0.0-beta-004 318 9/18/2019
3.0.0-beta-003 330 9/13/2019
3.0.0-beta-002 681 7/20/2019
3.0.0-beta-001 433 7/12/2019
2.9.2 5,710 2/2/2019
2.9.1 1,090 11/20/2018
2.9.0 731 10/17/2018
2.8.1 700 9/12/2018
2.8.0 747 7/7/2018

### Changed
* Add `fable_modules` to the directories which are always excluded. [Fable 3.4](https://github.com/fable-compiler/Fable/releases/tag/3.4.0)

### Fixed
* Let binding after match lambda is moved outside of nested module. [#2214](https://github.com/fsprojects/fantomas/issues/2214)