Fantomas 5.0.0-alpha-001

.NET Standard 2.0
This is a prerelease version of Fantomas.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Fantomas --version 5.0.0-alpha-001
NuGet\Install-Package Fantomas -Version 5.0.0-alpha-001
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Fantomas" Version="5.0.0-alpha-001" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fantomas --version 5.0.0-alpha-001
#r "nuget: Fantomas, 5.0.0-alpha-001"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Fantomas as a Cake Addin
#addin nuget:?package=Fantomas&version=5.0.0-alpha-001&prerelease

// Install Fantomas as a Cake Tool
#tool nuget:?package=Fantomas&version=5.0.0-alpha-001&prerelease

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 net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Fantomas:

Package Downloads
dotnet-fantomas

This library 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. Some common use cases include (1) Reformatting a code base to conform a universal page width (2) Converting legacy code from verbose syntax to light syntax (3) Formatting auto-generated F# signatures.

Falanx.Machinery

Package Description

GiraffeGenerator.Core

Package Description

CellScript.FCS

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.1.0-alpha-003 39 6/2/2023
6.1.0-alpha-002 60 5/2/2023
6.1.0-alpha-001 49 5/2/2023
6.0.4 302 6/2/2023
6.0.3 2,221 5/14/2023
6.0.2 1,656 5/5/2023
6.0.1 7,819 4/19/2023
6.0.0 4,030 4/13/2023
6.0.0-beta-001 404 4/5/2023
6.0.0-alpha-010 269 4/3/2023
6.0.0-alpha-009 108 3/31/2023
6.0.0-alpha-008 1,147 3/27/2023
6.0.0-alpha-007 367 3/27/2023
6.0.0-alpha-006 552 3/17/2023
6.0.0-alpha-005 520 2/24/2023
6.0.0-alpha-004 3,837 2/22/2023
6.0.0-alpha-003 2,051 2/4/2023
6.0.0-alpha-002 90 2/1/2023
6.0.0-alpha-001 100 1/24/2023
5.2.4 3,474 3/17/2023
5.2.3 3,467 3/6/2023
5.2.2 7,625 2/21/2023
5.2.1 14,346 2/4/2023
5.2.0 5,328 1/19/2023
5.2.0-alpha-012 303 1/14/2023
5.2.0-alpha-011 538 1/12/2023
5.2.0-alpha-010 127 12/30/2022
5.2.0-alpha-009 85 12/29/2022
5.2.0-alpha-008 207 12/28/2022
5.2.0-alpha-007 85 12/26/2022
5.2.0-alpha-006 81 12/22/2022
5.2.0-alpha-005 111 12/16/2022
5.2.0-alpha-004 355 12/8/2022
5.2.0-alpha-003 111 12/6/2022
5.2.0-alpha-002 89 12/4/2022
5.2.0-alpha-001 111 11/30/2022
5.1.5 14,198 12/22/2022
5.1.4 15,292 11/30/2022
5.1.3 4,473 11/14/2022
5.1.2 778 11/10/2022
5.1.1 2,812 11/7/2022
5.1.0 1,801 11/4/2022
5.1.0-beta-002 147 10/29/2022
5.1.0-beta-001 205 10/19/2022
5.1.0-alpha-007 125 10/14/2022
5.1.0-alpha-006 98 10/14/2022
5.1.0-alpha-005 144 10/7/2022
5.1.0-alpha-004 107 10/7/2022
5.1.0-alpha-003 133 10/2/2022
5.1.0-alpha-002 122 9/29/2022
5.1.0-alpha-001 201 9/18/2022
5.0.6 18,164 10/13/2022
5.0.5 6,616 10/7/2022
5.0.4 872 10/4/2022
5.0.3 6,611 9/29/2022
5.0.2 4,196 9/22/2022
5.0.1 3,428 9/18/2022
5.0.0 15,388 9/16/2022
5.0.0-beta-010 8,168 9/10/2022
5.0.0-beta-009 7,044 9/2/2022
5.0.0-beta-008 2,058 8/30/2022
5.0.0-beta-007 510 8/19/2022
5.0.0-beta-006 1,855 8/12/2022
5.0.0-beta-005 3,899 8/3/2022
5.0.0-beta-004 803 7/27/2022
5.0.0-beta-003 2,691 7/26/2022
5.0.0-beta-002 838 7/19/2022
5.0.0-beta-001 1,922 7/15/2022
5.0.0-alpha-011 479 7/8/2022
5.0.0-alpha-010 1,092 6/27/2022
5.0.0-alpha-009 33,632 6/21/2022
5.0.0-alpha-008 1,448 5/28/2022
5.0.0-alpha-007 640 5/16/2022
5.0.0-alpha-006 698 5/13/2022
5.0.0-alpha-005 202 5/7/2022
5.0.0-alpha-004 424 5/7/2022
5.0.0-alpha-003 623 5/6/2022
5.0.0-alpha-002 120 4/4/2022
5.0.0-alpha-001 109 3/19/2022
4.7.9 9,273 5/2/2022
4.7.8 9,854 4/25/2022
4.7.7 500 4/20/2022
4.7.6 703 4/4/2022
4.7.5 613 3/27/2022
4.7.4 541 3/25/2022
4.7.3 4,144 3/12/2022
4.7.2 513 3/11/2022
4.7.1 478 3/8/2022
4.7.0 593 3/4/2022
4.6.6 485 3/4/2022
4.6.5 1,245 2/18/2022
4.6.4 824 2/11/2022
4.6.3 815 2/8/2022
4.6.2 881 2/6/2022
4.6.1 854 2/1/2022
4.6.0 1,327 1/14/2022
4.6.0-beta-001 130 1/8/2022
4.6.0-alpha-011 139 12/29/2021
4.6.0-alpha-010 151 12/4/2021
4.6.0-alpha-009 2,807 11/24/2021
4.6.0-alpha-008 621 11/19/2021
4.6.0-alpha-007 232 11/7/2021
4.6.0-alpha-006 166 11/3/2021
4.6.0-alpha-005 192 10/27/2021
4.6.0-alpha-004 170 10/20/2021
4.6.0-alpha-003 151 10/5/2021
4.6.0-alpha-002 159 9/7/2021
4.6.0-alpha-001 143 8/11/2021
4.5.12 898 1/8/2022
4.5.11 1,659 12/29/2021
4.5.10 1,980 12/4/2021
4.5.9 6,788 11/24/2021
4.5.8 1,018 11/19/2021
4.5.7 872 11/7/2021
4.5.6 690 11/3/2021
4.5.5 830 10/27/2021
4.5.4 699 10/5/2021
4.5.3 2,277 9/7/2021
4.5.2 853 8/11/2021
4.5.1 2,602 7/24/2021
4.5.0 2,632 7/7/2021
4.5.0-beta-005 289 7/6/2021
4.5.0-beta-004 271 7/5/2021
4.5.0-beta-003 277 7/5/2021
4.5.0-beta-002 288 6/27/2021
4.5.0-beta-001 787 6/5/2021
4.5.0-alpha-020 282 5/26/2021
4.5.0-alpha-019 248 5/22/2021
4.5.0-alpha-018 259 5/21/2021
4.5.0-alpha-017 309 5/15/2021
4.5.0-alpha-016 241 5/9/2021
4.5.0-alpha-015 298 5/8/2021
4.5.0-alpha-014 297 4/30/2021
4.5.0-alpha-013 272 4/27/2021
4.5.0-alpha-012 253 4/23/2021
4.5.0-alpha-011 328 4/20/2021
4.5.0-alpha-010 276 4/14/2021
4.5.0-alpha-009 268 4/11/2021
4.5.0-alpha-008 303 4/8/2021
4.5.0-alpha-007 297 4/8/2021
4.5.0-alpha-006 266 4/5/2021
4.5.0-alpha-005 270 4/3/2021
4.5.0-alpha-004 297 4/2/2021
4.5.0-alpha-003 311 3/28/2021
4.5.0-alpha-002 258 3/22/2021
4.5.0-alpha-001 1,870 2/26/2021
4.4.0 11,030 2/25/2021
4.4.0-beta-008 306 2/19/2021
4.4.0-beta-007 299 2/12/2021
4.4.0-beta-006 301 2/12/2021
4.4.0-beta-005 295 2/9/2021
4.4.0-beta-004 302 2/5/2021
4.4.0-beta-003 737 1/30/2021
4.4.0-beta-002 297 1/23/2021
4.4.0-beta-001 732 1/22/2021
4.4.0-alpha-008 520 1/15/2021
4.4.0-alpha-007 1,015 12/26/2020
4.4.0-alpha-006 408 12/25/2020
4.4.0-alpha-005 469 12/23/2020
4.4.0-alpha-004 517 12/22/2020
4.4.0-alpha-003 508 12/18/2020
4.4.0-alpha-002 443 12/17/2020
4.4.0-alpha-001 375 12/17/2020
4.3.0 3,132 12/17/2020
4.3.0-beta-002 448 12/11/2020
4.3.0-beta-001 382 12/7/2020
4.3.0-alpha-007 438 11/21/2020
4.3.0-alpha-006 393 11/20/2020
4.3.0-alpha-005 352 11/16/2020
4.3.0-alpha-004 840 11/12/2020
4.3.0-alpha-003 384 11/10/2020
4.3.0-alpha-002 393 10/26/2020
4.3.0-alpha-001 428 10/23/2020
4.2.0 4,167 9/25/2020
4.2.0-alpha-004 586 9/23/2020
4.2.0-alpha-003 400 9/21/2020
4.2.0-alpha-002 442 9/19/2020
4.2.0-alpha-001 510 9/18/2020
4.1.1 997 9/17/2020
4.1.0 1,196 9/10/2020
4.1.0-beta-004 548 9/5/2020
4.1.0-beta-003 446 9/4/2020
4.1.0-beta-002 855 9/4/2020
4.1.0-beta-001 453 9/3/2020
4.1.0-alpha-001 431 9/1/2020
4.0.0 3,278 8/27/2020
4.0.0-beta-003 461 8/21/2020
4.0.0-beta-002 536 8/7/2020
4.0.0-beta-001 861 7/20/2020
4.0.0-alpha-014 705 7/14/2020
4.0.0-alpha-013 468 7/11/2020
4.0.0-alpha-012 1,054 7/6/2020
4.0.0-alpha-011 353 6/25/2020
4.0.0-alpha-010 735 6/18/2020
4.0.0-alpha-009 377 6/12/2020
4.0.0-alpha-008 514 6/2/2020
4.0.0-alpha-007 364 6/1/2020
4.0.0-alpha-006 1,443 5/23/2020
4.0.0-alpha-005 1,310 5/16/2020
4.0.0-alpha-004 808 5/4/2020
4.0.0-alpha-003 438 5/3/2020
4.0.0-alpha-002 463 4/26/2020
4.0.0-alpha-001 353 4/20/2020
3.3.0 11,803 2/28/2020
3.3.0-beta-002 1,322 2/21/2020
3.3.0-beta-001 484 2/18/2020
3.2.0 20,323 2/3/2020
3.2.0-beta-002 1,083 1/7/2020
3.2.0-beta-001 627 12/26/2019
3.1.0 9,904 11/27/2019
3.0.0 4,295 10/11/2019
3.0.0-beta-006 1,201 10/2/2019
3.0.0-beta-005 397 9/27/2019
3.0.0-beta-004 996 9/18/2019
3.0.0-beta-003 525 9/13/2019
3.0.0-beta-002 14,433 7/20/2019
3.0.0-beta-001 5,168 7/12/2019
2.9.2 23,725 2/2/2019
2.9.1 4,052 11/20/2018
2.9.0 8,904 10/17/2018
2.8.1 1,966 9/12/2018
2.8.0 5,193 7/7/2018
2.7.1 4,074 5/2/2018
2.7.0 1,705 5/2/2018
2.6.1 44,876 4/22/2017
2.5.0 2,173 2/19/2017
2.4.0 2,268 10/24/2016
2.3.0 1,942 7/9/2016
2.2.0 1,703 4/24/2016
2.1.0 1,581 4/1/2016
2.0.2 8,312 11/15/2015
1.11.0 2,113 9/12/2015
1.10.0 1,504 8/29/2015
1.9.0 1,914 8/10/2015
1.8.0-beta 1,201 7/19/2015
1.7.0 1,627 6/10/2015
1.6.0 2,464 10/25/2014
1.5.0 1,901 9/18/2014
1.4.0 2,255 7/1/2014
1.3.0 1,775 5/17/2014
1.2.0 1,773 4/21/2014
1.1.0 1,683 3/29/2014
1.0.7 1,678 3/12/2014
1.0.5.1 1,751 1/15/2014
1.0.5 1,479 1/7/2014
1.0.4 1,548 11/16/2013
1.0.3 1,575 10/6/2013
1.0.2 1,535 8/16/2013
1.0.1 1,667 7/22/2013
1.0.0 4,403 7/16/2013
0.9.9.2 1,873 7/2/2013
0.9.9.1 1,686 6/22/2013
0.9.8 1,679 6/14/2013
0.9.7 1,647 6/7/2013
0.9.6 1,597 5/31/2013
0.9.5 1,707 5/23/2013
0.9.4 1,581 5/19/2013
0.9.3 1,563 5/9/2013
0.9.2 1,592 5/3/2013
0.9.1 1,842 4/26/2013
0.9.0 1,613 4/19/2013
0.8.9 1,643 4/12/2013
0.8.8 1,597 4/11/2013
0.8.7 1,570 4/9/2013
0.8.6 1,571 4/4/2013
0.8.5 1,637 4/2/2013
0.8.4 1,556 4/1/2013
0.8.3 1,613 4/1/2013
0.8.2 1,582 4/1/2013
0.8.1 1,644 3/31/2013
0.8.0 1,637 3/31/2013

### Added
* Initial settings for strousrup bracket style. [#2161](https://github.com/fsprojects/fantomas/pull/2161)

### Fixed
* DotGet in quotation should be further indented. [#2154](https://github.com/fsprojects/fantomas/issues/2154)