fantomas-tool 4.7.9

.NET Core 3.1
Suggested Alternatives

fantomas

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
nuke :add-package fantomas-tool --version 4.7.9

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 net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.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 807 4/4/2022
5.0.0-alpha-001 440 3/19/2022
4.7.9 36,137 5/2/2022
4.7.8 2,397 4/25/2022
4.7.7 4,783 4/20/2022
4.7.6 16,290 4/4/2022
4.7.5 5,276 3/27/2022
4.7.4 569 3/25/2022
4.7.3 6,600 3/12/2022
4.7.2 7,186 3/11/2022
4.7.1 5,514 3/8/2022
4.7.0 3,964 3/4/2022
4.6.6 328 3/4/2022
4.6.5 34,091 2/18/2022
4.6.4 3,473 2/11/2022
4.6.3 4,076 2/8/2022
4.6.2 1,161 2/6/2022
4.6.1 6,611 2/1/2022
4.6.0 20,028 1/14/2022
4.6.0-beta-001 453 1/8/2022
4.6.0-alpha-011 1,382 12/29/2021
4.6.0-alpha-010 1,185 12/4/2021
4.6.0-alpha-009 3,207 11/24/2021
4.6.0-alpha-008 725 11/19/2021
4.6.0-alpha-007 895 11/7/2021
4.6.0-alpha-006 1,028 11/3/2021
4.6.0-alpha-005 453 10/27/2021
4.6.0-alpha-004 37,435 10/20/2021
4.6.0-alpha-003 374 10/5/2021
4.6.0-alpha-002 313 9/7/2021
4.6.0-alpha-001 216 8/11/2021
4.5.12 614 1/8/2022
4.5.11 1,903 12/29/2021
4.5.10 7,896 12/4/2021
4.5.9 6,306 11/24/2021
4.5.8 2,083 11/19/2021
4.5.7 1,090 11/7/2021
4.5.6 1,148 11/3/2021
4.5.5 770 10/27/2021
4.5.4 9,004 10/5/2021
4.5.3 8,113 9/7/2021
4.5.2 10,277 8/11/2021
4.5.1 4,753 7/24/2021
4.5.0 9,376 7/7/2021
4.5.0-beta-005 278 7/6/2021
4.5.0-beta-004 220 7/5/2021
4.5.0-beta-003 275 7/5/2021
4.5.0-beta-002 663 6/27/2021
4.5.0-beta-001 2,312 6/5/2021
4.5.0-alpha-020 292 5/26/2021
4.5.0-alpha-019 657 5/22/2021
4.5.0-alpha-018 234 5/21/2021
4.5.0-alpha-017 525 5/15/2021
4.5.0-alpha-016 291 5/9/2021
4.5.0-alpha-015 463 5/8/2021
4.5.0-alpha-014 474 4/30/2021
4.5.0-alpha-013 372 4/27/2021
4.5.0-alpha-012 286 4/23/2021
4.5.0-alpha-011 496 4/20/2021
4.5.0-alpha-010 533 4/14/2021
4.5.0-alpha-009 242 4/11/2021
4.5.0-alpha-008 485 4/8/2021
4.5.0-alpha-007 272 4/8/2021
4.5.0-alpha-006 254 4/5/2021
4.5.0-alpha-005 683 4/3/2021
4.5.0-alpha-004 279 4/2/2021
4.5.0-alpha-003 586 3/28/2021
4.5.0-alpha-002 417 3/22/2021
4.5.0-alpha-001 4,831 2/26/2021
4.4.0 25,851 2/25/2021
4.4.0-beta-008 623 2/19/2021
4.4.0-beta-007 265 2/12/2021
4.4.0-beta-006 511 2/12/2021
4.4.0-beta-005 309 2/9/2021
4.4.0-beta-004 474 2/5/2021
4.4.0-beta-003 521 1/30/2021
4.4.0-beta-002 409 1/23/2021
4.4.0-beta-001 290 1/22/2021
4.4.0-alpha-008 362 1/15/2021
4.4.0-alpha-007 2,657 12/26/2020
4.4.0-alpha-006 334 12/25/2020
4.4.0-alpha-005 317 12/23/2020
4.4.0-alpha-004 290 12/22/2020
4.4.0-alpha-003 352 12/18/2020
4.4.0-alpha-002 331 12/17/2020
4.4.0-alpha-001 348 12/17/2020
4.3.0 5,908 12/17/2020
4.3.0-beta-002 358 12/11/2020
4.3.0-beta-001 320 12/7/2020
4.3.0-alpha-007 360 11/21/2020
4.3.0-alpha-006 370 11/20/2020
4.3.0-alpha-005 325 11/16/2020
4.3.0-alpha-004 321 11/12/2020
4.3.0-alpha-003 313 11/10/2020
4.3.0-alpha-002 353 10/26/2020
4.3.0-alpha-001 1,263 10/23/2020
4.2.0 6,013 9/25/2020
4.2.0-alpha-004 459 9/23/2020
4.2.0-alpha-003 358 9/21/2020
4.2.0-alpha-002 397 9/19/2020
4.2.0-alpha-001 371 9/18/2020
4.1.1 1,762 9/17/2020
4.1.0 848 9/10/2020
4.1.0-beta-004 440 9/5/2020
4.1.0-beta-003 416 9/4/2020
4.1.0-beta-002 385 9/4/2020
4.1.0-beta-001 391 9/3/2020
4.1.0-alpha-001 401 9/1/2020
4.0.0 2,752 8/27/2020
4.0.0-beta-003 359 8/21/2020
4.0.0-beta-002 938 8/7/2020
4.0.0-beta-001 634 7/20/2020
4.0.0-alpha-014 421 7/14/2020
4.0.0-alpha-013 368 7/11/2020
4.0.0-alpha-012 681 7/6/2020
4.0.0-alpha-011 356 6/25/2020
4.0.0-alpha-010 354 6/18/2020
4.0.0-alpha-009 349 6/12/2020
4.0.0-alpha-008 368 6/2/2020
4.0.0-alpha-007 343 6/1/2020
4.0.0-alpha-006 409 5/23/2020
4.0.0-alpha-005 572 5/16/2020
4.0.0-alpha-004 874 5/4/2020
4.0.0-alpha-003 401 5/3/2020
4.0.0-alpha-002 354 4/26/2020
4.0.0-alpha-001 347 4/20/2020
3.3.0 10,052 2/28/2020
3.3.0-beta-002 953 2/21/2020
3.3.0-beta-001 456 2/18/2020
3.2.0 1,814 2/3/2020
3.2.0-beta-002 645 1/7/2020
3.2.0-beta-001 423 12/26/2019
3.1.0 11,790 11/27/2019
3.0.0 984 10/11/2019
3.0.0-beta-006 393 10/2/2019
3.0.0-beta-005 381 9/27/2019
3.0.0-beta-004 393 9/18/2019
3.0.0-beta-003 405 9/13/2019
3.0.0-beta-002 757 7/20/2019
3.0.0-beta-001 527 7/12/2019
2.9.2 5,941 2/2/2019
2.9.1 1,317 11/20/2018
2.9.0 947 10/17/2018
2.8.1 925 9/12/2018
2.8.0 1,015 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)