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,787 4/4/2022 5.0.0-alpha-002 is deprecated because it is no longer maintained.
5.0.0-alpha-001 750 3/19/2022 5.0.0-alpha-001 is deprecated because it is no longer maintained.
4.7.9 99,146 5/2/2022 4.7.9 is deprecated because it is no longer maintained.
4.7.8 3,336 4/25/2022 4.7.8 is deprecated because it is no longer maintained.
4.7.7 9,062 4/20/2022 4.7.7 is deprecated because it is no longer maintained.
4.7.6 78,239 4/4/2022 4.7.6 is deprecated because it is no longer maintained.
4.7.5 8,895 3/27/2022 4.7.5 is deprecated because it is no longer maintained.
4.7.4 1,037 3/25/2022 4.7.4 is deprecated because it is no longer maintained.
4.7.3 10,149 3/12/2022 4.7.3 is deprecated because it is no longer maintained.
4.7.2 74,251 3/11/2022 4.7.2 is deprecated because it is no longer maintained.
4.7.1 20,015 3/8/2022 4.7.1 is deprecated because it is no longer maintained.
4.7.0 7,547 3/4/2022 4.7.0 is deprecated because it is no longer maintained.
4.6.6 750 3/4/2022 4.6.6 is deprecated because it is no longer maintained.
4.6.5 71,323 2/18/2022 4.6.5 is deprecated because it is no longer maintained.
4.6.4 5,501 2/11/2022 4.6.4 is deprecated because it is no longer maintained.
4.6.3 5,385 2/8/2022 4.6.3 is deprecated because it is no longer maintained.
4.6.2 2,505 2/6/2022 4.6.2 is deprecated because it is no longer maintained.
4.6.1 8,150 2/1/2022 4.6.1 is deprecated because it is no longer maintained.
4.6.0 82,537 1/14/2022 4.6.0 is deprecated because it is no longer maintained.
4.6.0-beta-001 755 1/8/2022 4.6.0-beta-001 is deprecated because it is no longer maintained.
4.6.0-alpha-011 1,725 12/29/2021 4.6.0-alpha-011 is deprecated because it is no longer maintained.
4.6.0-alpha-010 1,537 12/4/2021 4.6.0-alpha-010 is deprecated because it is no longer maintained.
4.6.0-alpha-009 3,533 11/24/2021 4.6.0-alpha-009 is deprecated because it is no longer maintained.
4.6.0-alpha-008 1,060 11/19/2021 4.6.0-alpha-008 is deprecated because it is no longer maintained.
4.6.0-alpha-007 1,274 11/7/2021 4.6.0-alpha-007 is deprecated because it is no longer maintained.
4.6.0-alpha-006 1,302 11/3/2021 4.6.0-alpha-006 is deprecated because it is no longer maintained.
4.6.0-alpha-005 770 10/27/2021 4.6.0-alpha-005 is deprecated because it is no longer maintained.
4.6.0-alpha-004 38,754 10/20/2021 4.6.0-alpha-004 is deprecated because it is no longer maintained.
4.6.0-alpha-003 688 10/5/2021 4.6.0-alpha-003 is deprecated because it is no longer maintained.
4.6.0-alpha-002 538 9/7/2021 4.6.0-alpha-002 is deprecated because it is no longer maintained.
4.6.0-alpha-001 442 8/11/2021 4.6.0-alpha-001 is deprecated because it is no longer maintained.
4.5.12 1,124 1/8/2022 4.5.12 is deprecated because it is no longer maintained.
4.5.11 2,363 12/29/2021 4.5.11 is deprecated because it is no longer maintained.
4.5.10 8,896 12/4/2021 4.5.10 is deprecated because it is no longer maintained.
4.5.9 7,999 11/24/2021 4.5.9 is deprecated because it is no longer maintained.
4.5.8 2,527 11/19/2021 4.5.8 is deprecated because it is no longer maintained.
4.5.7 1,615 11/7/2021 4.5.7 is deprecated because it is no longer maintained.
4.5.6 1,799 11/3/2021 4.5.6 is deprecated because it is no longer maintained.
4.5.5 1,269 10/27/2021 4.5.5 is deprecated because it is no longer maintained.
4.5.4 12,353 10/5/2021 4.5.4 is deprecated because it is no longer maintained.
4.5.3 8,626 9/7/2021 4.5.3 is deprecated because it is no longer maintained.
4.5.2 13,149 8/11/2021 4.5.2 is deprecated because it is no longer maintained.
4.5.1 5,427 7/24/2021 4.5.1 is deprecated because it is no longer maintained.
4.5.0 68,164 7/7/2021 4.5.0 is deprecated because it is no longer maintained.
4.5.0-beta-005 529 7/6/2021 4.5.0-beta-005 is deprecated because it is no longer maintained.
4.5.0-beta-004 446 7/5/2021 4.5.0-beta-004 is deprecated because it is no longer maintained.
4.5.0-beta-003 549 7/5/2021 4.5.0-beta-003 is deprecated because it is no longer maintained.
4.5.0-beta-002 978 6/27/2021 4.5.0-beta-002 is deprecated because it is no longer maintained.
4.5.0-beta-001 2,535 6/5/2021 4.5.0-beta-001 is deprecated because it is no longer maintained.
4.5.0-alpha-020 486 5/26/2021 4.5.0-alpha-020 is deprecated because it is no longer maintained.
4.5.0-alpha-019 890 5/22/2021 4.5.0-alpha-019 is deprecated because it is no longer maintained.
4.5.0-alpha-018 550 5/21/2021 4.5.0-alpha-018 is deprecated because it is no longer maintained.
4.5.0-alpha-017 800 5/15/2021 4.5.0-alpha-017 is deprecated because it is no longer maintained.
4.5.0-alpha-016 526 5/9/2021 4.5.0-alpha-016 is deprecated because it is no longer maintained.
4.5.0-alpha-015 713 5/8/2021 4.5.0-alpha-015 is deprecated because it is no longer maintained.
4.5.0-alpha-014 735 4/30/2021 4.5.0-alpha-014 is deprecated because it is no longer maintained.
4.5.0-alpha-013 647 4/27/2021 4.5.0-alpha-013 is deprecated because it is no longer maintained.
4.5.0-alpha-012 540 4/23/2021 4.5.0-alpha-012 is deprecated because it is no longer maintained.
4.5.0-alpha-011 786 4/20/2021 4.5.0-alpha-011 is deprecated because it is no longer maintained.
4.5.0-alpha-010 769 4/14/2021 4.5.0-alpha-010 is deprecated because it is no longer maintained.
4.5.0-alpha-009 519 4/11/2021 4.5.0-alpha-009 is deprecated because it is no longer maintained.
4.5.0-alpha-008 784 4/8/2021 4.5.0-alpha-008 is deprecated because it is no longer maintained.
4.5.0-alpha-007 614 4/8/2021 4.5.0-alpha-007 is deprecated because it is no longer maintained.
4.5.0-alpha-006 530 4/5/2021 4.5.0-alpha-006 is deprecated because it is no longer maintained.
4.5.0-alpha-005 1,007 4/3/2021 4.5.0-alpha-005 is deprecated because it is no longer maintained.
4.5.0-alpha-004 580 4/2/2021 4.5.0-alpha-004 is deprecated because it is no longer maintained.
4.5.0-alpha-003 837 3/28/2021 4.5.0-alpha-003 is deprecated because it is no longer maintained.
4.5.0-alpha-002 702 3/22/2021 4.5.0-alpha-002 is deprecated because it is no longer maintained.
4.5.0-alpha-001 5,050 2/26/2021 4.5.0-alpha-001 is deprecated because it is no longer maintained.
4.4.0 29,849 2/25/2021 4.4.0 is deprecated because it is no longer maintained.
4.4.0-beta-008 886 2/19/2021 4.4.0-beta-008 is deprecated because it is no longer maintained.
4.4.0-beta-007 484 2/12/2021 4.4.0-beta-007 is deprecated because it is no longer maintained.
4.4.0-beta-006 744 2/12/2021 4.4.0-beta-006 is deprecated because it is no longer maintained.
4.4.0-beta-005 583 2/9/2021 4.4.0-beta-005 is deprecated because it is no longer maintained.
4.4.0-beta-004 774 2/5/2021 4.4.0-beta-004 is deprecated because it is no longer maintained.
4.4.0-beta-003 841 1/30/2021 4.4.0-beta-003 is deprecated because it is no longer maintained.
4.4.0-beta-002 673 1/23/2021 4.4.0-beta-002 is deprecated because it is no longer maintained.
4.4.0-beta-001 589 1/22/2021 4.4.0-beta-001 is deprecated because it is no longer maintained.
4.4.0-alpha-008 642 1/15/2021 4.4.0-alpha-008 is deprecated because it is no longer maintained.
4.4.0-alpha-007 2,982 12/26/2020 4.4.0-alpha-007 is deprecated because it is no longer maintained.
4.4.0-alpha-006 623 12/25/2020 4.4.0-alpha-006 is deprecated because it is no longer maintained.
4.4.0-alpha-005 630 12/23/2020 4.4.0-alpha-005 is deprecated because it is no longer maintained.
4.4.0-alpha-004 585 12/22/2020 4.4.0-alpha-004 is deprecated because it is no longer maintained.
4.4.0-alpha-003 684 12/18/2020 4.4.0-alpha-003 is deprecated because it is no longer maintained.
4.4.0-alpha-002 565 12/17/2020 4.4.0-alpha-002 is deprecated because it is no longer maintained.
4.4.0-alpha-001 572 12/17/2020 4.4.0-alpha-001 is deprecated because it is no longer maintained.
4.3.0 6,481 12/17/2020 4.3.0 is deprecated because it is no longer maintained.
4.3.0-beta-002 618 12/11/2020 4.3.0-beta-002 is deprecated because it is no longer maintained.
4.3.0-beta-001 596 12/7/2020 4.3.0-beta-001 is deprecated because it is no longer maintained.
4.3.0-alpha-007 620 11/21/2020 4.3.0-alpha-007 is deprecated because it is no longer maintained.
4.3.0-alpha-006 601 11/20/2020 4.3.0-alpha-006 is deprecated because it is no longer maintained.
4.3.0-alpha-005 625 11/16/2020 4.3.0-alpha-005 is deprecated because it is no longer maintained.
4.3.0-alpha-004 597 11/12/2020 4.3.0-alpha-004 is deprecated because it is no longer maintained.
4.3.0-alpha-003 591 11/10/2020 4.3.0-alpha-003 is deprecated because it is no longer maintained.
4.3.0-alpha-002 641 10/26/2020 4.3.0-alpha-002 is deprecated because it is no longer maintained.
4.3.0-alpha-001 1,600 10/23/2020 4.3.0-alpha-001 is deprecated because it is no longer maintained.
4.2.0 6,588 9/25/2020 4.2.0 is deprecated because it is no longer maintained.
4.2.0-alpha-004 744 9/23/2020 4.2.0-alpha-004 is deprecated because it is no longer maintained.
4.2.0-alpha-003 621 9/21/2020 4.2.0-alpha-003 is deprecated because it is no longer maintained.
4.2.0-alpha-002 713 9/19/2020 4.2.0-alpha-002 is deprecated because it is no longer maintained.
4.2.0-alpha-001 687 9/18/2020 4.2.0-alpha-001 is deprecated because it is no longer maintained.
4.1.1 2,305 9/17/2020 4.1.1 is deprecated because it is no longer maintained.
4.1.0 1,368 9/10/2020 4.1.0 is deprecated because it is no longer maintained.
4.1.0-beta-004 820 9/5/2020 4.1.0-beta-004 is deprecated because it is no longer maintained.
4.1.0-beta-003 675 9/4/2020 4.1.0-beta-003 is deprecated because it is no longer maintained.
4.1.0-beta-002 682 9/4/2020 4.1.0-beta-002 is deprecated because it is no longer maintained.
4.1.0-beta-001 670 9/3/2020 4.1.0-beta-001 is deprecated because it is no longer maintained.
4.1.0-alpha-001 635 9/1/2020 4.1.0-alpha-001 is deprecated because it is no longer maintained.
4.0.0 3,278 8/27/2020 4.0.0 is deprecated because it is no longer maintained.
4.0.0-beta-003 698 8/21/2020 4.0.0-beta-003 is deprecated because it is no longer maintained.
4.0.0-beta-002 1,158 8/7/2020 4.0.0-beta-002 is deprecated because it is no longer maintained.
4.0.0-beta-001 906 7/20/2020 4.0.0-beta-001 is deprecated because it is no longer maintained.
4.0.0-alpha-014 650 7/14/2020 4.0.0-alpha-014 is deprecated because it is no longer maintained.
4.0.0-alpha-013 642 7/11/2020 4.0.0-alpha-013 is deprecated because it is no longer maintained.
4.0.0-alpha-012 967 7/6/2020 4.0.0-alpha-012 is deprecated because it is no longer maintained.
4.0.0-alpha-011 611 6/25/2020 4.0.0-alpha-011 is deprecated because it is no longer maintained.
4.0.0-alpha-010 615 6/18/2020 4.0.0-alpha-010 is deprecated because it is no longer maintained.
4.0.0-alpha-009 595 6/12/2020 4.0.0-alpha-009 is deprecated because it is no longer maintained.
4.0.0-alpha-008 638 6/2/2020 4.0.0-alpha-008 is deprecated because it is no longer maintained.
4.0.0-alpha-007 592 6/1/2020 4.0.0-alpha-007 is deprecated because it is no longer maintained.
4.0.0-alpha-006 723 5/23/2020 4.0.0-alpha-006 is deprecated because it is no longer maintained.
4.0.0-alpha-005 852 5/16/2020 4.0.0-alpha-005 is deprecated because it is no longer maintained.
4.0.0-alpha-004 1,133 5/4/2020 4.0.0-alpha-004 is deprecated because it is no longer maintained.
4.0.0-alpha-003 686 5/3/2020 4.0.0-alpha-003 is deprecated because it is no longer maintained.
4.0.0-alpha-002 649 4/26/2020 4.0.0-alpha-002 is deprecated because it is no longer maintained.
4.0.0-alpha-001 621 4/20/2020 4.0.0-alpha-001 is deprecated because it is no longer maintained.
3.3.0 65,586 2/28/2020 3.3.0 is deprecated because it is no longer maintained.
3.3.0-beta-002 1,148 2/21/2020 3.3.0-beta-002 is deprecated because it is no longer maintained.
3.3.0-beta-001 685 2/18/2020 3.3.0-beta-001 is deprecated because it is no longer maintained.
3.2.0 2,941 2/3/2020 3.2.0 is deprecated because it is no longer maintained.
3.2.0-beta-002 882 1/7/2020 3.2.0-beta-002 is deprecated because it is no longer maintained.
3.2.0-beta-001 706 12/26/2019 3.2.0-beta-001 is deprecated because it is no longer maintained.
3.1.0 12,334 11/27/2019 3.1.0 is deprecated because it is no longer maintained.
3.0.0 1,518 10/11/2019 3.0.0 is deprecated because it is no longer maintained.
3.0.0-beta-006 665 10/2/2019 3.0.0-beta-006 is deprecated because it is no longer maintained.
3.0.0-beta-005 674 9/27/2019 3.0.0-beta-005 is deprecated because it is no longer maintained.
3.0.0-beta-004 709 9/18/2019 3.0.0-beta-004 is deprecated because it is no longer maintained.
3.0.0-beta-003 729 9/13/2019 3.0.0-beta-003 is deprecated because it is no longer maintained.
3.0.0-beta-002 1,044 7/20/2019 3.0.0-beta-002 is deprecated because it is no longer maintained.
3.0.0-beta-001 897 7/12/2019 3.0.0-beta-001 is deprecated because it is no longer maintained.
2.9.2 6,468 2/2/2019 2.9.2 is deprecated because it is no longer maintained.
2.9.1 1,841 11/20/2018 2.9.1 is deprecated because it is no longer maintained.
2.9.0 1,424 10/17/2018 2.9.0 is deprecated because it is no longer maintained.
2.8.1 1,408 9/12/2018 2.8.1 is deprecated because it is no longer maintained.
2.8.0 1,719 7/7/2018 2.8.0 is deprecated because it is no longer maintained.

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