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,642 4/4/2022
5.0.0-alpha-001 655 3/19/2022
4.7.9 81,644 5/2/2022
4.7.8 2,970 4/25/2022
4.7.7 7,311 4/20/2022
4.7.6 37,094 4/4/2022
4.7.5 7,969 3/27/2022
4.7.4 932 3/25/2022
4.7.3 9,662 3/12/2022
4.7.2 23,822 3/11/2022
4.7.1 15,454 3/8/2022
4.7.0 7,386 3/4/2022
4.6.6 641 3/4/2022
4.6.5 70,483 2/18/2022
4.6.4 4,947 2/11/2022
4.6.3 5,238 2/8/2022
4.6.2 2,171 2/6/2022
4.6.1 8,010 2/1/2022
4.6.0 41,016 1/14/2022
4.6.0-beta-001 658 1/8/2022
4.6.0-alpha-011 1,629 12/29/2021
4.6.0-alpha-010 1,402 12/4/2021
4.6.0-alpha-009 3,437 11/24/2021
4.6.0-alpha-008 963 11/19/2021
4.6.0-alpha-007 1,140 11/7/2021
4.6.0-alpha-006 1,208 11/3/2021
4.6.0-alpha-005 660 10/27/2021
4.6.0-alpha-004 38,324 10/20/2021
4.6.0-alpha-003 598 10/5/2021
4.6.0-alpha-002 457 9/7/2021
4.6.0-alpha-001 339 8/11/2021
4.5.12 992 1/8/2022
4.5.11 2,273 12/29/2021
4.5.10 8,770 12/4/2021
4.5.9 7,862 11/24/2021
4.5.8 2,409 11/19/2021
4.5.7 1,497 11/7/2021
4.5.6 1,605 11/3/2021
4.5.5 1,159 10/27/2021
4.5.4 12,080 10/5/2021
4.5.3 8,500 9/7/2021
4.5.2 12,915 8/11/2021
4.5.1 5,322 7/24/2021
4.5.0 27,987 7/7/2021
4.5.0-beta-005 427 7/6/2021
4.5.0-beta-004 351 7/5/2021
4.5.0-beta-003 461 7/5/2021
4.5.0-beta-002 885 6/27/2021
4.5.0-beta-001 2,442 6/5/2021
4.5.0-alpha-020 410 5/26/2021
4.5.0-alpha-019 815 5/22/2021
4.5.0-alpha-018 459 5/21/2021
4.5.0-alpha-017 706 5/15/2021
4.5.0-alpha-016 445 5/9/2021
4.5.0-alpha-015 610 5/8/2021
4.5.0-alpha-014 653 4/30/2021
4.5.0-alpha-013 536 4/27/2021
4.5.0-alpha-012 431 4/23/2021
4.5.0-alpha-011 684 4/20/2021
4.5.0-alpha-010 675 4/14/2021
4.5.0-alpha-009 411 4/11/2021
4.5.0-alpha-008 674 4/8/2021
4.5.0-alpha-007 493 4/8/2021
4.5.0-alpha-006 444 4/5/2021
4.5.0-alpha-005 906 4/3/2021
4.5.0-alpha-004 470 4/2/2021
4.5.0-alpha-003 728 3/28/2021
4.5.0-alpha-002 594 3/22/2021
4.5.0-alpha-001 4,942 2/26/2021
4.4.0 28,568 2/25/2021
4.4.0-beta-008 777 2/19/2021
4.4.0-beta-007 378 2/12/2021
4.4.0-beta-006 638 2/12/2021
4.4.0-beta-005 465 2/9/2021
4.4.0-beta-004 666 2/5/2021
4.4.0-beta-003 727 1/30/2021
4.4.0-beta-002 566 1/23/2021
4.4.0-beta-001 482 1/22/2021
4.4.0-alpha-008 537 1/15/2021
4.4.0-alpha-007 2,875 12/26/2020
4.4.0-alpha-006 512 12/25/2020
4.4.0-alpha-005 520 12/23/2020
4.4.0-alpha-004 473 12/22/2020
4.4.0-alpha-003 570 12/18/2020
4.4.0-alpha-002 460 12/17/2020
4.4.0-alpha-001 467 12/17/2020
4.3.0 6,318 12/17/2020
4.3.0-beta-002 515 12/11/2020
4.3.0-beta-001 472 12/7/2020
4.3.0-alpha-007 514 11/21/2020
4.3.0-alpha-006 494 11/20/2020
4.3.0-alpha-005 518 11/16/2020
4.3.0-alpha-004 485 11/12/2020
4.3.0-alpha-003 488 11/10/2020
4.3.0-alpha-002 535 10/26/2020
4.3.0-alpha-001 1,495 10/23/2020
4.2.0 6,449 9/25/2020
4.2.0-alpha-004 636 9/23/2020
4.2.0-alpha-003 514 9/21/2020
4.2.0-alpha-002 606 9/19/2020
4.2.0-alpha-001 574 9/18/2020
4.1.1 2,182 9/17/2020
4.1.0 1,248 9/10/2020
4.1.0-beta-004 651 9/5/2020
4.1.0-beta-003 571 9/4/2020
4.1.0-beta-002 576 9/4/2020
4.1.0-beta-001 564 9/3/2020
4.1.0-alpha-001 547 9/1/2020
4.0.0 3,146 8/27/2020
4.0.0-beta-003 582 8/21/2020
4.0.0-beta-002 1,060 8/7/2020
4.0.0-beta-001 802 7/20/2020
4.0.0-alpha-014 538 7/14/2020
4.0.0-alpha-013 538 7/11/2020
4.0.0-alpha-012 859 7/6/2020
4.0.0-alpha-011 506 6/25/2020
4.0.0-alpha-010 513 6/18/2020
4.0.0-alpha-009 491 6/12/2020
4.0.0-alpha-008 535 6/2/2020
4.0.0-alpha-007 487 6/1/2020
4.0.0-alpha-006 619 5/23/2020
4.0.0-alpha-005 741 5/16/2020
4.0.0-alpha-004 1,019 5/4/2020
4.0.0-alpha-003 577 5/3/2020
4.0.0-alpha-002 536 4/26/2020
4.0.0-alpha-001 513 4/20/2020
3.3.0 27,746 2/28/2020
3.3.0-beta-002 1,039 2/21/2020
3.3.0-beta-001 576 2/18/2020
3.2.0 2,621 2/3/2020
3.2.0-beta-002 774 1/7/2020
3.2.0-beta-001 598 12/26/2019
3.1.0 12,208 11/27/2019
3.0.0 1,401 10/11/2019
3.0.0-beta-006 558 10/2/2019
3.0.0-beta-005 567 9/27/2019
3.0.0-beta-004 594 9/18/2019
3.0.0-beta-003 621 9/13/2019
3.0.0-beta-002 927 7/20/2019
3.0.0-beta-001 728 7/12/2019
2.9.2 6,336 2/2/2019
2.9.1 1,706 11/20/2018
2.9.0 1,286 10/17/2018
2.8.1 1,282 9/12/2018
2.8.0 1,468 7/7/2018

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