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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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,835 4/4/2022 5.0.0-alpha-002 is deprecated because it is no longer maintained.
5.0.0-alpha-001 794 3/19/2022 5.0.0-alpha-001 is deprecated because it is no longer maintained.
4.7.9 99,956 5/2/2022 4.7.9 is deprecated because it is no longer maintained.
4.7.8 3,431 4/25/2022 4.7.8 is deprecated because it is no longer maintained.
4.7.7 9,173 4/20/2022 4.7.7 is deprecated because it is no longer maintained.
4.7.6 81,077 4/4/2022 4.7.6 is deprecated because it is no longer maintained.
4.7.5 8,981 3/27/2022 4.7.5 is deprecated because it is no longer maintained.
4.7.4 1,084 3/25/2022 4.7.4 is deprecated because it is no longer maintained.
4.7.3 10,227 3/12/2022 4.7.3 is deprecated because it is no longer maintained.
4.7.2 77,423 3/11/2022 4.7.2 is deprecated because it is no longer maintained.
4.7.1 20,149 3/8/2022 4.7.1 is deprecated because it is no longer maintained.
4.7.0 7,589 3/4/2022 4.7.0 is deprecated because it is no longer maintained.
4.6.6 793 3/4/2022 4.6.6 is deprecated because it is no longer maintained.
4.6.5 71,374 2/18/2022 4.6.5 is deprecated because it is no longer maintained.
4.6.4 5,554 2/11/2022 4.6.4 is deprecated because it is no longer maintained.
4.6.3 5,434 2/8/2022 4.6.3 is deprecated because it is no longer maintained.
4.6.2 2,637 2/6/2022 4.6.2 is deprecated because it is no longer maintained.
4.6.1 8,200 2/1/2022 4.6.1 is deprecated because it is no longer maintained.
4.6.0 85,383 1/14/2022 4.6.0 is deprecated because it is no longer maintained.
4.6.0-beta-001 806 1/8/2022 4.6.0-beta-001 is deprecated because it is no longer maintained.
4.6.0-alpha-011 1,770 12/29/2021 4.6.0-alpha-011 is deprecated because it is no longer maintained.
4.6.0-alpha-010 1,589 12/4/2021 4.6.0-alpha-010 is deprecated because it is no longer maintained.
4.6.0-alpha-009 3,580 11/24/2021 4.6.0-alpha-009 is deprecated because it is no longer maintained.
4.6.0-alpha-008 1,117 11/19/2021 4.6.0-alpha-008 is deprecated because it is no longer maintained.
4.6.0-alpha-007 1,324 11/7/2021 4.6.0-alpha-007 is deprecated because it is no longer maintained.
4.6.0-alpha-006 1,346 11/3/2021 4.6.0-alpha-006 is deprecated because it is no longer maintained.
4.6.0-alpha-005 819 10/27/2021 4.6.0-alpha-005 is deprecated because it is no longer maintained.
4.6.0-alpha-004 38,804 10/20/2021 4.6.0-alpha-004 is deprecated because it is no longer maintained.
4.6.0-alpha-003 738 10/5/2021 4.6.0-alpha-003 is deprecated because it is no longer maintained.
4.6.0-alpha-002 582 9/7/2021 4.6.0-alpha-002 is deprecated because it is no longer maintained.
4.6.0-alpha-001 493 8/11/2021 4.6.0-alpha-001 is deprecated because it is no longer maintained.
4.5.12 1,177 1/8/2022 4.5.12 is deprecated because it is no longer maintained.
4.5.11 2,412 12/29/2021 4.5.11 is deprecated because it is no longer maintained.
4.5.10 8,945 12/4/2021 4.5.10 is deprecated because it is no longer maintained.
4.5.9 8,047 11/24/2021 4.5.9 is deprecated because it is no longer maintained.
4.5.8 2,575 11/19/2021 4.5.8 is deprecated because it is no longer maintained.
4.5.7 1,664 11/7/2021 4.5.7 is deprecated because it is no longer maintained.
4.5.6 1,850 11/3/2021 4.5.6 is deprecated because it is no longer maintained.
4.5.5 1,323 10/27/2021 4.5.5 is deprecated because it is no longer maintained.
4.5.4 12,399 10/5/2021 4.5.4 is deprecated because it is no longer maintained.
4.5.3 8,678 9/7/2021 4.5.3 is deprecated because it is no longer maintained.
4.5.2 13,197 8/11/2021 4.5.2 is deprecated because it is no longer maintained.
4.5.1 5,472 7/24/2021 4.5.1 is deprecated because it is no longer maintained.
4.5.0 70,980 7/7/2021 4.5.0 is deprecated because it is no longer maintained.
4.5.0-beta-005 571 7/6/2021 4.5.0-beta-005 is deprecated because it is no longer maintained.
4.5.0-beta-004 488 7/5/2021 4.5.0-beta-004 is deprecated because it is no longer maintained.
4.5.0-beta-003 595 7/5/2021 4.5.0-beta-003 is deprecated because it is no longer maintained.
4.5.0-beta-002 1,025 6/27/2021 4.5.0-beta-002 is deprecated because it is no longer maintained.
4.5.0-beta-001 2,587 6/5/2021 4.5.0-beta-001 is deprecated because it is no longer maintained.
4.5.0-alpha-020 537 5/26/2021 4.5.0-alpha-020 is deprecated because it is no longer maintained.
4.5.0-alpha-019 936 5/22/2021 4.5.0-alpha-019 is deprecated because it is no longer maintained.
4.5.0-alpha-018 594 5/21/2021 4.5.0-alpha-018 is deprecated because it is no longer maintained.
4.5.0-alpha-017 843 5/15/2021 4.5.0-alpha-017 is deprecated because it is no longer maintained.
4.5.0-alpha-016 571 5/9/2021 4.5.0-alpha-016 is deprecated because it is no longer maintained.
4.5.0-alpha-015 755 5/8/2021 4.5.0-alpha-015 is deprecated because it is no longer maintained.
4.5.0-alpha-014 782 4/30/2021 4.5.0-alpha-014 is deprecated because it is no longer maintained.
4.5.0-alpha-013 689 4/27/2021 4.5.0-alpha-013 is deprecated because it is no longer maintained.
4.5.0-alpha-012 582 4/23/2021 4.5.0-alpha-012 is deprecated because it is no longer maintained.
4.5.0-alpha-011 830 4/20/2021 4.5.0-alpha-011 is deprecated because it is no longer maintained.
4.5.0-alpha-010 821 4/14/2021 4.5.0-alpha-010 is deprecated because it is no longer maintained.
4.5.0-alpha-009 561 4/11/2021 4.5.0-alpha-009 is deprecated because it is no longer maintained.
4.5.0-alpha-008 831 4/8/2021 4.5.0-alpha-008 is deprecated because it is no longer maintained.
4.5.0-alpha-007 659 4/8/2021 4.5.0-alpha-007 is deprecated because it is no longer maintained.
4.5.0-alpha-006 575 4/5/2021 4.5.0-alpha-006 is deprecated because it is no longer maintained.
4.5.0-alpha-005 1,054 4/3/2021 4.5.0-alpha-005 is deprecated because it is no longer maintained.
4.5.0-alpha-004 630 4/2/2021 4.5.0-alpha-004 is deprecated because it is no longer maintained.
4.5.0-alpha-003 888 3/28/2021 4.5.0-alpha-003 is deprecated because it is no longer maintained.
4.5.0-alpha-002 753 3/22/2021 4.5.0-alpha-002 is deprecated because it is no longer maintained.
4.5.0-alpha-001 5,100 2/26/2021 4.5.0-alpha-001 is deprecated because it is no longer maintained.
4.4.0 29,913 2/25/2021 4.4.0 is deprecated because it is no longer maintained.
4.4.0-beta-008 928 2/19/2021 4.4.0-beta-008 is deprecated because it is no longer maintained.
4.4.0-beta-007 531 2/12/2021 4.4.0-beta-007 is deprecated because it is no longer maintained.
4.4.0-beta-006 790 2/12/2021 4.4.0-beta-006 is deprecated because it is no longer maintained.
4.4.0-beta-005 632 2/9/2021 4.4.0-beta-005 is deprecated because it is no longer maintained.
4.4.0-beta-004 825 2/5/2021 4.4.0-beta-004 is deprecated because it is no longer maintained.
4.4.0-beta-003 888 1/30/2021 4.4.0-beta-003 is deprecated because it is no longer maintained.
4.4.0-beta-002 718 1/23/2021 4.4.0-beta-002 is deprecated because it is no longer maintained.
4.4.0-beta-001 642 1/22/2021 4.4.0-beta-001 is deprecated because it is no longer maintained.
4.4.0-alpha-008 688 1/15/2021 4.4.0-alpha-008 is deprecated because it is no longer maintained.
4.4.0-alpha-007 3,026 12/26/2020 4.4.0-alpha-007 is deprecated because it is no longer maintained.
4.4.0-alpha-006 668 12/25/2020 4.4.0-alpha-006 is deprecated because it is no longer maintained.
4.4.0-alpha-005 681 12/23/2020 4.4.0-alpha-005 is deprecated because it is no longer maintained.
4.4.0-alpha-004 633 12/22/2020 4.4.0-alpha-004 is deprecated because it is no longer maintained.
4.4.0-alpha-003 728 12/18/2020 4.4.0-alpha-003 is deprecated because it is no longer maintained.
4.4.0-alpha-002 615 12/17/2020 4.4.0-alpha-002 is deprecated because it is no longer maintained.
4.4.0-alpha-001 616 12/17/2020 4.4.0-alpha-001 is deprecated because it is no longer maintained.
4.3.0 6,524 12/17/2020 4.3.0 is deprecated because it is no longer maintained.
4.3.0-beta-002 670 12/11/2020 4.3.0-beta-002 is deprecated because it is no longer maintained.
4.3.0-beta-001 647 12/7/2020 4.3.0-beta-001 is deprecated because it is no longer maintained.
4.3.0-alpha-007 668 11/21/2020 4.3.0-alpha-007 is deprecated because it is no longer maintained.
4.3.0-alpha-006 649 11/20/2020 4.3.0-alpha-006 is deprecated because it is no longer maintained.
4.3.0-alpha-005 672 11/16/2020 4.3.0-alpha-005 is deprecated because it is no longer maintained.
4.3.0-alpha-004 647 11/12/2020 4.3.0-alpha-004 is deprecated because it is no longer maintained.
4.3.0-alpha-003 638 11/10/2020 4.3.0-alpha-003 is deprecated because it is no longer maintained.
4.3.0-alpha-002 692 10/26/2020 4.3.0-alpha-002 is deprecated because it is no longer maintained.
4.3.0-alpha-001 1,647 10/23/2020 4.3.0-alpha-001 is deprecated because it is no longer maintained.
4.2.0 6,636 9/25/2020 4.2.0 is deprecated because it is no longer maintained.
4.2.0-alpha-004 793 9/23/2020 4.2.0-alpha-004 is deprecated because it is no longer maintained.
4.2.0-alpha-003 670 9/21/2020 4.2.0-alpha-003 is deprecated because it is no longer maintained.
4.2.0-alpha-002 759 9/19/2020 4.2.0-alpha-002 is deprecated because it is no longer maintained.
4.2.0-alpha-001 731 9/18/2020 4.2.0-alpha-001 is deprecated because it is no longer maintained.
4.1.1 2,352 9/17/2020 4.1.1 is deprecated because it is no longer maintained.
4.1.0 1,419 9/10/2020 4.1.0 is deprecated because it is no longer maintained.
4.1.0-beta-004 869 9/5/2020 4.1.0-beta-004 is deprecated because it is no longer maintained.
4.1.0-beta-003 725 9/4/2020 4.1.0-beta-003 is deprecated because it is no longer maintained.
4.1.0-beta-002 730 9/4/2020 4.1.0-beta-002 is deprecated because it is no longer maintained.
4.1.0-beta-001 716 9/3/2020 4.1.0-beta-001 is deprecated because it is no longer maintained.
4.1.0-alpha-001 678 9/1/2020 4.1.0-alpha-001 is deprecated because it is no longer maintained.
4.0.0 3,322 8/27/2020 4.0.0 is deprecated because it is no longer maintained.
4.0.0-beta-003 743 8/21/2020 4.0.0-beta-003 is deprecated because it is no longer maintained.
4.0.0-beta-002 1,203 8/7/2020 4.0.0-beta-002 is deprecated because it is no longer maintained.
4.0.0-beta-001 949 7/20/2020 4.0.0-beta-001 is deprecated because it is no longer maintained.
4.0.0-alpha-014 694 7/14/2020 4.0.0-alpha-014 is deprecated because it is no longer maintained.
4.0.0-alpha-013 692 7/11/2020 4.0.0-alpha-013 is deprecated because it is no longer maintained.
4.0.0-alpha-012 1,019 7/6/2020 4.0.0-alpha-012 is deprecated because it is no longer maintained.
4.0.0-alpha-011 656 6/25/2020 4.0.0-alpha-011 is deprecated because it is no longer maintained.
4.0.0-alpha-010 660 6/18/2020 4.0.0-alpha-010 is deprecated because it is no longer maintained.
4.0.0-alpha-009 638 6/12/2020 4.0.0-alpha-009 is deprecated because it is no longer maintained.
4.0.0-alpha-008 682 6/2/2020 4.0.0-alpha-008 is deprecated because it is no longer maintained.
4.0.0-alpha-007 639 6/1/2020 4.0.0-alpha-007 is deprecated because it is no longer maintained.
4.0.0-alpha-006 768 5/23/2020 4.0.0-alpha-006 is deprecated because it is no longer maintained.
4.0.0-alpha-005 899 5/16/2020 4.0.0-alpha-005 is deprecated because it is no longer maintained.
4.0.0-alpha-004 1,180 5/4/2020 4.0.0-alpha-004 is deprecated because it is no longer maintained.
4.0.0-alpha-003 734 5/3/2020 4.0.0-alpha-003 is deprecated because it is no longer maintained.
4.0.0-alpha-002 699 4/26/2020 4.0.0-alpha-002 is deprecated because it is no longer maintained.
4.0.0-alpha-001 672 4/20/2020 4.0.0-alpha-001 is deprecated because it is no longer maintained.
3.3.0 68,395 2/28/2020 3.3.0 is deprecated because it is no longer maintained.
3.3.0-beta-002 1,192 2/21/2020 3.3.0-beta-002 is deprecated because it is no longer maintained.
3.3.0-beta-001 735 2/18/2020 3.3.0-beta-001 is deprecated because it is no longer maintained.
3.2.0 2,995 2/3/2020 3.2.0 is deprecated because it is no longer maintained.
3.2.0-beta-002 931 1/7/2020 3.2.0-beta-002 is deprecated because it is no longer maintained.
3.2.0-beta-001 757 12/26/2019 3.2.0-beta-001 is deprecated because it is no longer maintained.
3.1.0 12,380 11/27/2019 3.1.0 is deprecated because it is no longer maintained.
3.0.0 1,569 10/11/2019 3.0.0 is deprecated because it is no longer maintained.
3.0.0-beta-006 716 10/2/2019 3.0.0-beta-006 is deprecated because it is no longer maintained.
3.0.0-beta-005 724 9/27/2019 3.0.0-beta-005 is deprecated because it is no longer maintained.
3.0.0-beta-004 756 9/18/2019 3.0.0-beta-004 is deprecated because it is no longer maintained.
3.0.0-beta-003 778 9/13/2019 3.0.0-beta-003 is deprecated because it is no longer maintained.
3.0.0-beta-002 1,095 7/20/2019 3.0.0-beta-002 is deprecated because it is no longer maintained.
3.0.0-beta-001 963 7/12/2019 3.0.0-beta-001 is deprecated because it is no longer maintained.
2.9.2 6,519 2/2/2019 2.9.2 is deprecated because it is no longer maintained.
2.9.1 1,888 11/20/2018 2.9.1 is deprecated because it is no longer maintained.
2.9.0 1,476 10/17/2018 2.9.0 is deprecated because it is no longer maintained.
2.8.1 1,454 9/12/2018 2.8.1 is deprecated because it is no longer maintained.
2.8.0 1,820 7/7/2018 2.8.0 is deprecated because it is no longer maintained.

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