fantomas-tool 5.0.0-alpha-002

Suggested Alternatives

fantomas

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

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 Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
5.0.0-alpha-002 1,698 4/4/2022 5.0.0-alpha-002 is deprecated because it is no longer maintained.
5.0.0-alpha-001 680 3/19/2022 5.0.0-alpha-001 is deprecated because it is no longer maintained.
4.7.9 88,976 5/2/2022 4.7.9 is deprecated because it is no longer maintained.
4.7.8 3,078 4/25/2022 4.7.8 is deprecated because it is no longer maintained.
4.7.7 7,615 4/20/2022 4.7.7 is deprecated because it is no longer maintained.
4.7.6 55,040 4/4/2022 4.7.6 is deprecated because it is no longer maintained.
4.7.5 8,382 3/27/2022 4.7.5 is deprecated because it is no longer maintained.
4.7.4 964 3/25/2022 4.7.4 is deprecated because it is no longer maintained.
4.7.3 9,950 3/12/2022 4.7.3 is deprecated because it is no longer maintained.
4.7.2 48,119 3/11/2022 4.7.2 is deprecated because it is no longer maintained.
4.7.1 17,167 3/8/2022 4.7.1 is deprecated because it is no longer maintained.
4.7.0 7,437 3/4/2022 4.7.0 is deprecated because it is no longer maintained.
4.6.6 677 3/4/2022 4.6.6 is deprecated because it is no longer maintained.
4.6.5 71,011 2/18/2022 4.6.5 is deprecated because it is no longer maintained.
4.6.4 5,143 2/11/2022 4.6.4 is deprecated because it is no longer maintained.
4.6.3 5,279 2/8/2022 4.6.3 is deprecated because it is no longer maintained.
4.6.2 2,286 2/6/2022 4.6.2 is deprecated because it is no longer maintained.
4.6.1 8,071 2/1/2022 4.6.1 is deprecated because it is no longer maintained.
4.6.0 59,162 1/14/2022 4.6.0 is deprecated because it is no longer maintained.
4.6.0-beta-001 686 1/8/2022 4.6.0-beta-001 is deprecated because it is no longer maintained.
4.6.0-alpha-011 1,657 12/29/2021 4.6.0-alpha-011 is deprecated because it is no longer maintained.
4.6.0-alpha-010 1,427 12/4/2021 4.6.0-alpha-010 is deprecated because it is no longer maintained.
4.6.0-alpha-009 3,464 11/24/2021 4.6.0-alpha-009 is deprecated because it is no longer maintained.
4.6.0-alpha-008 989 11/19/2021 4.6.0-alpha-008 is deprecated because it is no longer maintained.
4.6.0-alpha-007 1,189 11/7/2021 4.6.0-alpha-007 is deprecated because it is no longer maintained.
4.6.0-alpha-006 1,233 11/3/2021 4.6.0-alpha-006 is deprecated because it is no longer maintained.
4.6.0-alpha-005 683 10/27/2021 4.6.0-alpha-005 is deprecated because it is no longer maintained.
4.6.0-alpha-004 38,450 10/20/2021 4.6.0-alpha-004 is deprecated because it is no longer maintained.
4.6.0-alpha-003 623 10/5/2021 4.6.0-alpha-003 is deprecated because it is no longer maintained.
4.6.0-alpha-002 461 9/7/2021 4.6.0-alpha-002 is deprecated because it is no longer maintained.
4.6.0-alpha-001 375 8/11/2021 4.6.0-alpha-001 is deprecated because it is no longer maintained.
4.5.12 1,035 1/8/2022 4.5.12 is deprecated because it is no longer maintained.
4.5.11 2,286 12/29/2021 4.5.11 is deprecated because it is no longer maintained.
4.5.10 8,817 12/4/2021 4.5.10 is deprecated because it is no longer maintained.
4.5.9 7,901 11/24/2021 4.5.9 is deprecated because it is no longer maintained.
4.5.8 2,445 11/19/2021 4.5.8 is deprecated because it is no longer maintained.
4.5.7 1,536 11/7/2021 4.5.7 is deprecated because it is no longer maintained.
4.5.6 1,652 11/3/2021 4.5.6 is deprecated because it is no longer maintained.
4.5.5 1,193 10/27/2021 4.5.5 is deprecated because it is no longer maintained.
4.5.4 12,269 10/5/2021 4.5.4 is deprecated because it is no longer maintained.
4.5.3 8,544 9/7/2021 4.5.3 is deprecated because it is no longer maintained.
4.5.2 13,033 8/11/2021 4.5.2 is deprecated because it is no longer maintained.
4.5.1 5,351 7/24/2021 4.5.1 is deprecated because it is no longer maintained.
4.5.0 45,492 7/7/2021 4.5.0 is deprecated because it is no longer maintained.
4.5.0-beta-005 462 7/6/2021 4.5.0-beta-005 is deprecated because it is no longer maintained.
4.5.0-beta-004 380 7/5/2021 4.5.0-beta-004 is deprecated because it is no longer maintained.
4.5.0-beta-003 483 7/5/2021 4.5.0-beta-003 is deprecated because it is no longer maintained.
4.5.0-beta-002 912 6/27/2021 4.5.0-beta-002 is deprecated because it is no longer maintained.
4.5.0-beta-001 2,469 6/5/2021 4.5.0-beta-001 is deprecated because it is no longer maintained.
4.5.0-alpha-020 419 5/26/2021 4.5.0-alpha-020 is deprecated because it is no longer maintained.
4.5.0-alpha-019 821 5/22/2021 4.5.0-alpha-019 is deprecated because it is no longer maintained.
4.5.0-alpha-018 480 5/21/2021 4.5.0-alpha-018 is deprecated because it is no longer maintained.
4.5.0-alpha-017 731 5/15/2021 4.5.0-alpha-017 is deprecated because it is no longer maintained.
4.5.0-alpha-016 452 5/9/2021 4.5.0-alpha-016 is deprecated because it is no longer maintained.
4.5.0-alpha-015 636 5/8/2021 4.5.0-alpha-015 is deprecated because it is no longer maintained.
4.5.0-alpha-014 660 4/30/2021 4.5.0-alpha-014 is deprecated because it is no longer maintained.
4.5.0-alpha-013 566 4/27/2021 4.5.0-alpha-013 is deprecated because it is no longer maintained.
4.5.0-alpha-012 465 4/23/2021 4.5.0-alpha-012 is deprecated because it is no longer maintained.
4.5.0-alpha-011 712 4/20/2021 4.5.0-alpha-011 is deprecated because it is no longer maintained.
4.5.0-alpha-010 698 4/14/2021 4.5.0-alpha-010 is deprecated because it is no longer maintained.
4.5.0-alpha-009 443 4/11/2021 4.5.0-alpha-009 is deprecated because it is no longer maintained.
4.5.0-alpha-008 702 4/8/2021 4.5.0-alpha-008 is deprecated because it is no longer maintained.
4.5.0-alpha-007 526 4/8/2021 4.5.0-alpha-007 is deprecated because it is no longer maintained.
4.5.0-alpha-006 451 4/5/2021 4.5.0-alpha-006 is deprecated because it is no longer maintained.
4.5.0-alpha-005 931 4/3/2021 4.5.0-alpha-005 is deprecated because it is no longer maintained.
4.5.0-alpha-004 500 4/2/2021 4.5.0-alpha-004 is deprecated because it is no longer maintained.
4.5.0-alpha-003 756 3/28/2021 4.5.0-alpha-003 is deprecated because it is no longer maintained.
4.5.0-alpha-002 626 3/22/2021 4.5.0-alpha-002 is deprecated because it is no longer maintained.
4.5.0-alpha-001 4,969 2/26/2021 4.5.0-alpha-001 is deprecated because it is no longer maintained.
4.4.0 29,148 2/25/2021 4.4.0 is deprecated because it is no longer maintained.
4.4.0-beta-008 807 2/19/2021 4.4.0-beta-008 is deprecated because it is no longer maintained.
4.4.0-beta-007 406 2/12/2021 4.4.0-beta-007 is deprecated because it is no longer maintained.
4.4.0-beta-006 663 2/12/2021 4.4.0-beta-006 is deprecated because it is no longer maintained.
4.4.0-beta-005 501 2/9/2021 4.4.0-beta-005 is deprecated because it is no longer maintained.
4.4.0-beta-004 695 2/5/2021 4.4.0-beta-004 is deprecated because it is no longer maintained.
4.4.0-beta-003 760 1/30/2021 4.4.0-beta-003 is deprecated because it is no longer maintained.
4.4.0-beta-002 595 1/23/2021 4.4.0-beta-002 is deprecated because it is no longer maintained.
4.4.0-beta-001 508 1/22/2021 4.4.0-beta-001 is deprecated because it is no longer maintained.
4.4.0-alpha-008 561 1/15/2021 4.4.0-alpha-008 is deprecated because it is no longer maintained.
4.4.0-alpha-007 2,901 12/26/2020 4.4.0-alpha-007 is deprecated because it is no longer maintained.
4.4.0-alpha-006 543 12/25/2020 4.4.0-alpha-006 is deprecated because it is no longer maintained.
4.4.0-alpha-005 543 12/23/2020 4.4.0-alpha-005 is deprecated because it is no longer maintained.
4.4.0-alpha-004 499 12/22/2020 4.4.0-alpha-004 is deprecated because it is no longer maintained.
4.4.0-alpha-003 604 12/18/2020 4.4.0-alpha-003 is deprecated because it is no longer maintained.
4.4.0-alpha-002 484 12/17/2020 4.4.0-alpha-002 is deprecated because it is no longer maintained.
4.4.0-alpha-001 492 12/17/2020 4.4.0-alpha-001 is deprecated because it is no longer maintained.
4.3.0 6,354 12/17/2020 4.3.0 is deprecated because it is no longer maintained.
4.3.0-beta-002 537 12/11/2020 4.3.0-beta-002 is deprecated because it is no longer maintained.
4.3.0-beta-001 514 12/7/2020 4.3.0-beta-001 is deprecated because it is no longer maintained.
4.3.0-alpha-007 538 11/21/2020 4.3.0-alpha-007 is deprecated because it is no longer maintained.
4.3.0-alpha-006 520 11/20/2020 4.3.0-alpha-006 is deprecated because it is no longer maintained.
4.3.0-alpha-005 544 11/16/2020 4.3.0-alpha-005 is deprecated because it is no longer maintained.
4.3.0-alpha-004 511 11/12/2020 4.3.0-alpha-004 is deprecated because it is no longer maintained.
4.3.0-alpha-003 511 11/10/2020 4.3.0-alpha-003 is deprecated because it is no longer maintained.
4.3.0-alpha-002 560 10/26/2020 4.3.0-alpha-002 is deprecated because it is no longer maintained.
4.3.0-alpha-001 1,521 10/23/2020 4.3.0-alpha-001 is deprecated because it is no longer maintained.
4.2.0 6,497 9/25/2020 4.2.0 is deprecated because it is no longer maintained.
4.2.0-alpha-004 663 9/23/2020 4.2.0-alpha-004 is deprecated because it is no longer maintained.
4.2.0-alpha-003 544 9/21/2020 4.2.0-alpha-003 is deprecated because it is no longer maintained.
4.2.0-alpha-002 635 9/19/2020 4.2.0-alpha-002 is deprecated because it is no longer maintained.
4.2.0-alpha-001 608 9/18/2020 4.2.0-alpha-001 is deprecated because it is no longer maintained.
4.1.1 2,218 9/17/2020 4.1.1 is deprecated because it is no longer maintained.
4.1.0 1,283 9/10/2020 4.1.0 is deprecated because it is no longer maintained.
4.1.0-beta-004 740 9/5/2020 4.1.0-beta-004 is deprecated because it is no longer maintained.
4.1.0-beta-003 596 9/4/2020 4.1.0-beta-003 is deprecated because it is no longer maintained.
4.1.0-beta-002 600 9/4/2020 4.1.0-beta-002 is deprecated because it is no longer maintained.
4.1.0-beta-001 593 9/3/2020 4.1.0-beta-001 is deprecated because it is no longer maintained.
4.1.0-alpha-001 558 9/1/2020 4.1.0-alpha-001 is deprecated because it is no longer maintained.
4.0.0 3,187 8/27/2020 4.0.0 is deprecated because it is no longer maintained.
4.0.0-beta-003 619 8/21/2020 4.0.0-beta-003 is deprecated because it is no longer maintained.
4.0.0-beta-002 1,082 8/7/2020 4.0.0-beta-002 is deprecated because it is no longer maintained.
4.0.0-beta-001 828 7/20/2020 4.0.0-beta-001 is deprecated because it is no longer maintained.
4.0.0-alpha-014 561 7/14/2020 4.0.0-alpha-014 is deprecated because it is no longer maintained.
4.0.0-alpha-013 562 7/11/2020 4.0.0-alpha-013 is deprecated because it is no longer maintained.
4.0.0-alpha-012 884 7/6/2020 4.0.0-alpha-012 is deprecated because it is no longer maintained.
4.0.0-alpha-011 531 6/25/2020 4.0.0-alpha-011 is deprecated because it is no longer maintained.
4.0.0-alpha-010 535 6/18/2020 4.0.0-alpha-010 is deprecated because it is no longer maintained.
4.0.0-alpha-009 515 6/12/2020 4.0.0-alpha-009 is deprecated because it is no longer maintained.
4.0.0-alpha-008 557 6/2/2020 4.0.0-alpha-008 is deprecated because it is no longer maintained.
4.0.0-alpha-007 509 6/1/2020 4.0.0-alpha-007 is deprecated because it is no longer maintained.
4.0.0-alpha-006 637 5/23/2020 4.0.0-alpha-006 is deprecated because it is no longer maintained.
4.0.0-alpha-005 768 5/16/2020 4.0.0-alpha-005 is deprecated because it is no longer maintained.
4.0.0-alpha-004 1,042 5/4/2020 4.0.0-alpha-004 is deprecated because it is no longer maintained.
4.0.0-alpha-003 597 5/3/2020 4.0.0-alpha-003 is deprecated because it is no longer maintained.
4.0.0-alpha-002 562 4/26/2020 4.0.0-alpha-002 is deprecated because it is no longer maintained.
4.0.0-alpha-001 530 4/20/2020 4.0.0-alpha-001 is deprecated because it is no longer maintained.
3.3.0 44,400 2/28/2020 3.3.0 is deprecated because it is no longer maintained.
3.3.0-beta-002 1,062 2/21/2020 3.3.0-beta-002 is deprecated because it is no longer maintained.
3.3.0-beta-001 598 2/18/2020 3.3.0-beta-001 is deprecated because it is no longer maintained.
3.2.0 2,782 2/3/2020 3.2.0 is deprecated because it is no longer maintained.
3.2.0-beta-002 796 1/7/2020 3.2.0-beta-002 is deprecated because it is no longer maintained.
3.2.0-beta-001 620 12/26/2019 3.2.0-beta-001 is deprecated because it is no longer maintained.
3.1.0 12,240 11/27/2019 3.1.0 is deprecated because it is no longer maintained.
3.0.0 1,425 10/11/2019 3.0.0 is deprecated because it is no longer maintained.
3.0.0-beta-006 578 10/2/2019 3.0.0-beta-006 is deprecated because it is no longer maintained.
3.0.0-beta-005 587 9/27/2019 3.0.0-beta-005 is deprecated because it is no longer maintained.
3.0.0-beta-004 620 9/18/2019 3.0.0-beta-004 is deprecated because it is no longer maintained.
3.0.0-beta-003 644 9/13/2019 3.0.0-beta-003 is deprecated because it is no longer maintained.
3.0.0-beta-002 954 7/20/2019 3.0.0-beta-002 is deprecated because it is no longer maintained.
3.0.0-beta-001 755 7/12/2019 3.0.0-beta-001 is deprecated because it is no longer maintained.
2.9.2 6,371 2/2/2019 2.9.2 is deprecated because it is no longer maintained.
2.9.1 1,735 11/20/2018 2.9.1 is deprecated because it is no longer maintained.
2.9.0 1,314 10/17/2018 2.9.0 is deprecated because it is no longer maintained.
2.8.1 1,296 9/12/2018 2.8.1 is deprecated because it is no longer maintained.
2.8.0 1,482 7/7/2018 2.8.0 is deprecated because it is no longer maintained.

### Changed
* Target net6.0 for fantomas-tool.