Fantomas.Core 5.0.0-beta-006

This is a prerelease version of Fantomas.Core.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Fantomas.Core --version 5.0.0-beta-006                
NuGet\Install-Package Fantomas.Core -Version 5.0.0-beta-006                
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.Core" Version="5.0.0-beta-006" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fantomas.Core --version 5.0.0-beta-006                
#r "nuget: Fantomas.Core, 5.0.0-beta-006"                
#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.Core as a Cake Addin
#addin nuget:?package=Fantomas.Core&version=5.0.0-beta-006&prerelease

// Install Fantomas.Core as a Cake Tool
#tool nuget:?package=Fantomas.Core&version=5.0.0-beta-006&prerelease                

Fantomas

Fantomas logo

F# source code formatter, inspired by scalariform for Scala, ocp-indent for OCaml and PythonTidy for Python.

GitHub Workflow Status (event) Discord Nuget (with prereleases)

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 --prerelease

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 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 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 "(%O -> %O)" t1 t2
                 | 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 "(%O -> %O)" t1 t2
             | 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.  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. 
.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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Fantomas.Core:

Package Downloads
Fantomas.Extras

Utility package for Fantomas

Myriad.Core

Core Myriad library used for developing plugins

Fabulous.AST

Fabulous.AST, an Abstract Syntax Tree (AST) Domain Specific Language (DSL) for F#.

WoofWare.Whippet.Fantomas

Helpers for accessing Fantomas syntax trees.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.0.0-alpha-002 59 11/2/2024
7.0.0-alpha-001 118 9/16/2024
6.3.16 419 10/29/2024
6.3.15 1,587 9/14/2024
6.3.14 99 9/14/2024
6.3.13 133 9/10/2024
6.3.12 259 9/5/2024
6.3.11 684 8/16/2024
6.3.10 979 7/12/2024
6.3.9 7,710 6/9/2024
6.3.8 118 6/6/2024
6.3.7 607 6/1/2024
6.3.6 104 6/1/2024
6.3.5 119 5/30/2024
6.3.4 1,650 4/16/2024
6.3.3 762 4/12/2024
6.3.2 117 4/12/2024
6.3.1 1,503 3/30/2024
6.3.0 532 3/15/2024
6.3.0-beta-001 133 3/7/2024
6.3.0-alpha-008 115 3/1/2024
6.3.0-alpha-007 132 1/27/2024
6.3.0-alpha-006 428 1/9/2024
6.3.0-alpha-005 112 12/22/2023
6.3.0-alpha-004 134 12/6/2023
6.3.0-alpha-003 838 11/15/2023
6.3.0-alpha-002 161 11/7/2023
6.3.0-alpha-001 109 11/3/2023
6.2.3 1,182 11/2/2023
6.2.2 18,338 10/18/2023
6.2.1 203 9/18/2023
6.2.0 6,993 8/29/2023
6.1.3 168 8/25/2023
6.1.2 235 7/23/2023
6.1.1 9,434 6/29/2023
6.1.0 213 6/28/2023
6.1.0-alpha-006 130 6/20/2023
6.1.0-alpha-005 132 6/20/2023
6.1.0-alpha-004 124 6/19/2023
6.1.0-alpha-003 224 6/2/2023
6.1.0-alpha-002 194 5/2/2023
6.1.0-alpha-001 129 5/2/2023
6.0.8 184 6/20/2023
6.0.7 172 6/20/2023
6.0.6 169 6/19/2023
6.0.5 11,355 6/6/2023
6.0.4 180 6/2/2023
6.0.3 227 5/14/2023
6.0.2 187 5/5/2023
6.0.1 248 4/19/2023
6.0.0 653 4/13/2023
6.0.0-beta-001 317 4/5/2023
6.0.0-alpha-010 300 4/3/2023
6.0.0-alpha-009 141 3/31/2023
6.0.0-alpha-008 134 3/27/2023
6.0.0-alpha-007 122 3/27/2023
6.0.0-alpha-006 263 3/17/2023
6.0.0-alpha-005 142 2/24/2023
6.0.0-alpha-004 145 2/22/2023
6.0.0-alpha-003 144 2/4/2023
6.0.0-alpha-002 156 2/1/2023
6.0.0-alpha-001 156 1/24/2023
5.2.4 1,301 3/17/2023
5.2.3 491 3/6/2023
5.2.2 348 2/21/2023
5.2.1 8,573 2/4/2023
5.2.0 756 1/19/2023
5.2.0-alpha-012 265 1/14/2023
5.2.0-alpha-011 136 1/12/2023
5.2.0-alpha-010 130 12/30/2022
5.2.0-alpha-009 146 12/29/2022
5.2.0-alpha-008 138 12/28/2022
5.2.0-alpha-007 150 12/26/2022
5.2.0-alpha-006 145 12/22/2022
5.2.0-alpha-005 144 12/16/2022
5.2.0-alpha-004 146 12/8/2022
5.2.0-alpha-003 131 12/6/2022
5.2.0-alpha-002 140 12/4/2022
5.2.0-alpha-001 143 11/30/2022
5.1.5 1,541 12/22/2022
5.1.4 561 11/30/2022
5.1.3 696 11/14/2022
5.1.2 725 11/10/2022
5.1.1 451 11/7/2022
5.1.0 482 11/4/2022
5.1.0-beta-002 155 10/29/2022
5.1.0-beta-001 183 10/19/2022
5.1.0-alpha-007 152 10/14/2022
5.1.0-alpha-006 159 10/14/2022
5.1.0-alpha-005 124 10/7/2022
5.1.0-alpha-004 148 10/7/2022
5.1.0-alpha-003 146 10/2/2022
5.1.0-alpha-002 171 9/29/2022
5.1.0-alpha-001 244 9/18/2022
5.0.6 1,602 10/13/2022
5.0.5 597 10/7/2022
5.0.4 526 10/4/2022
5.0.3 629 9/29/2022
5.0.2 509 9/22/2022
5.0.1 572 9/18/2022
5.0.0 13,658 9/16/2022
5.0.0-beta-010 231 9/10/2022
5.0.0-beta-009 603 9/2/2022
5.0.0-beta-008 360 8/30/2022
5.0.0-beta-007 330 8/19/2022
5.0.0-beta-006 157 8/12/2022
5.0.0-beta-005 156 8/3/2022
5.0.0-beta-004 168 7/27/2022
5.0.0-beta-003 159 7/26/2022
5.0.0-beta-002 192 7/19/2022
5.0.0-beta-001 177 7/15/2022
5.0.0-alpha-011 170 7/8/2022
5.0.0-alpha-010 187 6/27/2022
5.0.0-alpha-009 167 6/21/2022
5.0.0-alpha-008 175 5/28/2022
5.0.0-alpha-007 190 5/16/2022
5.0.0-alpha-006 186 5/13/2022
5.0.0-alpha-005 180 5/7/2022
5.0.0-alpha-004 188 5/7/2022
5.0.0-alpha-003 192 5/6/2022

### Changed
* Update FCS to 'Include star in topTupleType rule', commit f8b56cb6db3c90348810263fd7a5d37dc5719e92

### Fixed
* Wrong comma placement results in "Possible incorrect indentation". [#2159](https://github.com/fsprojects/fantomas/issues/2159)
* Indentation warning for update record in infix operation. [#2355](https://github.com/fsprojects/fantomas/issues/2355)
* Use of A | B as c fails to format correctly. [#2289](https://github.com/fsprojects/fantomas/issues/2289)