fantomas-tool 5.0.0-alpha-002

.NET 6.0
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
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package fantomas-tool --version 5.0.0-alpha-002
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
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 579 4/4/2022
5.0.0-alpha-001 416 3/19/2022
4.7.9 14,436 5/2/2022
4.7.8 2,009 4/25/2022
4.7.7 2,921 4/20/2022
4.7.6 8,019 4/4/2022
4.7.5 3,896 3/27/2022
4.7.4 418 3/25/2022
4.7.3 5,225 3/12/2022
4.7.2 3,135 3/11/2022
4.7.1 3,058 3/8/2022
4.7.0 3,330 3/4/2022
4.6.6 194 3/4/2022
4.6.5 10,744 2/18/2022
4.6.4 2,546 2/11/2022
4.6.3 3,073 2/8/2022
4.6.2 865 2/6/2022
4.6.1 5,008 2/1/2022
4.6.0 14,290 1/14/2022
4.6.0-beta-001 420 1/8/2022
4.6.0-alpha-011 1,114 12/29/2021
4.6.0-alpha-010 1,157 12/4/2021
4.6.0-alpha-009 3,183 11/24/2021
4.6.0-alpha-008 702 11/19/2021
4.6.0-alpha-007 865 11/7/2021
4.6.0-alpha-006 1,008 11/3/2021
4.6.0-alpha-005 354 10/27/2021
4.6.0-alpha-004 36,473 10/20/2021
4.6.0-alpha-003 353 10/5/2021
4.6.0-alpha-002 292 9/7/2021
4.6.0-alpha-001 190 8/11/2021
4.5.12 471 1/8/2022
4.5.11 1,402 12/29/2021
4.5.10 7,500 12/4/2021
4.5.9 5,566 11/24/2021
4.5.8 1,922 11/19/2021
4.5.7 891 11/7/2021
4.5.6 1,004 11/3/2021
4.5.5 624 10/27/2021
4.5.4 7,990 10/5/2021
4.5.3 7,715 9/7/2021
4.5.2 9,060 8/11/2021
4.5.1 4,279 7/24/2021
4.5.0 5,144 7/7/2021
4.5.0-beta-005 254 7/6/2021
4.5.0-beta-004 202 7/5/2021
4.5.0-beta-003 255 7/5/2021
4.5.0-beta-002 640 6/27/2021
4.5.0-beta-001 2,290 6/5/2021
4.5.0-alpha-020 266 5/26/2021
4.5.0-alpha-019 635 5/22/2021
4.5.0-alpha-018 209 5/21/2021
4.5.0-alpha-017 502 5/15/2021
4.5.0-alpha-016 266 5/9/2021
4.5.0-alpha-015 438 5/8/2021
4.5.0-alpha-014 449 4/30/2021
4.5.0-alpha-013 347 4/27/2021
4.5.0-alpha-012 258 4/23/2021
4.5.0-alpha-011 475 4/20/2021
4.5.0-alpha-010 510 4/14/2021
4.5.0-alpha-009 217 4/11/2021
4.5.0-alpha-008 457 4/8/2021
4.5.0-alpha-007 250 4/8/2021
4.5.0-alpha-006 226 4/5/2021
4.5.0-alpha-005 657 4/3/2021
4.5.0-alpha-004 251 4/2/2021
4.5.0-alpha-003 561 3/28/2021
4.5.0-alpha-002 389 3/22/2021
4.5.0-alpha-001 4,805 2/26/2021
4.4.0 24,239 2/25/2021
4.4.0-beta-008 593 2/19/2021
4.4.0-beta-007 239 2/12/2021
4.4.0-beta-006 484 2/12/2021
4.4.0-beta-005 284 2/9/2021
4.4.0-beta-004 448 2/5/2021
4.4.0-beta-003 501 1/30/2021
4.4.0-beta-002 388 1/23/2021
4.4.0-beta-001 267 1/22/2021
4.4.0-alpha-008 338 1/15/2021
4.4.0-alpha-007 2,638 12/26/2020
4.4.0-alpha-006 313 12/25/2020
4.4.0-alpha-005 296 12/23/2020
4.4.0-alpha-004 268 12/22/2020
4.4.0-alpha-003 329 12/18/2020
4.4.0-alpha-002 308 12/17/2020
4.4.0-alpha-001 325 12/17/2020
4.3.0 4,520 12/17/2020
4.3.0-beta-002 336 12/11/2020
4.3.0-beta-001 298 12/7/2020
4.3.0-alpha-007 340 11/21/2020
4.3.0-alpha-006 349 11/20/2020
4.3.0-alpha-005 305 11/16/2020
4.3.0-alpha-004 301 11/12/2020
4.3.0-alpha-003 289 11/10/2020
4.3.0-alpha-002 333 10/26/2020
4.3.0-alpha-001 1,240 10/23/2020
4.2.0 5,823 9/25/2020
4.2.0-alpha-004 436 9/23/2020
4.2.0-alpha-003 333 9/21/2020
4.2.0-alpha-002 378 9/19/2020
4.2.0-alpha-001 351 9/18/2020
4.1.1 1,609 9/17/2020
4.1.0 694 9/10/2020
4.1.0-beta-004 416 9/5/2020
4.1.0-beta-003 393 9/4/2020
4.1.0-beta-002 365 9/4/2020
4.1.0-beta-001 365 9/3/2020
4.1.0-alpha-001 377 9/1/2020
4.0.0 2,600 8/27/2020
4.0.0-beta-003 334 8/21/2020
4.0.0-beta-002 918 8/7/2020
4.0.0-beta-001 610 7/20/2020
4.0.0-alpha-014 397 7/14/2020
4.0.0-alpha-013 346 7/11/2020
4.0.0-alpha-012 658 7/6/2020
4.0.0-alpha-011 334 6/25/2020
4.0.0-alpha-010 329 6/18/2020
4.0.0-alpha-009 328 6/12/2020
4.0.0-alpha-008 345 6/2/2020
4.0.0-alpha-007 319 6/1/2020
4.0.0-alpha-006 385 5/23/2020
4.0.0-alpha-005 545 5/16/2020
4.0.0-alpha-004 852 5/4/2020
4.0.0-alpha-003 379 5/3/2020
4.0.0-alpha-002 330 4/26/2020
4.0.0-alpha-001 325 4/20/2020
3.3.0 6,215 2/28/2020
3.3.0-beta-002 929 2/21/2020
3.3.0-beta-001 433 2/18/2020
3.2.0 1,550 2/3/2020
3.2.0-beta-002 621 1/7/2020
3.2.0-beta-001 400 12/26/2019
3.1.0 11,557 11/27/2019
3.0.0 832 10/11/2019
3.0.0-beta-006 371 10/2/2019
3.0.0-beta-005 360 9/27/2019
3.0.0-beta-004 373 9/18/2019
3.0.0-beta-003 383 9/13/2019
3.0.0-beta-002 734 7/20/2019
3.0.0-beta-001 497 7/12/2019
2.9.2 5,788 2/2/2019
2.9.1 1,162 11/20/2018
2.9.0 803 10/17/2018
2.8.1 770 9/12/2018
2.8.0 852 7/7/2018

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