Fantomas.FCS 5.0.0-beta-005

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

// Install Fantomas.FCS as a Cake Tool
#tool nuget:?package=Fantomas.FCS&version=5.0.0-beta-005&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

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 (1)

Showing the top 1 NuGet packages that depend on Fantomas.FCS:

Package Downloads
Fantomas.Core

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.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.3.0 238 3/15/2024
6.3.0-beta-001 77 3/7/2024
6.3.0-alpha-008 71 3/1/2024
6.3.0-alpha-007 94 1/27/2024
6.3.0-alpha-006 319 1/9/2024
6.3.0-alpha-005 115 12/22/2023
6.3.0-alpha-004 114 12/6/2023
6.3.0-alpha-003 625 11/15/2023
6.3.0-alpha-002 152 11/7/2023
6.3.0-alpha-001 88 11/3/2023
6.2.3 1,044 11/2/2023
6.2.2 7,491 10/18/2023
6.2.1 196 9/18/2023
6.2.0 6,345 8/29/2023
6.1.3 184 8/25/2023
6.1.2 232 7/23/2023
6.1.1 3,082 6/29/2023
6.1.0 202 6/28/2023
6.1.0-alpha-006 134 6/20/2023
6.1.0-alpha-005 147 6/20/2023
6.1.0-alpha-004 120 6/19/2023
6.1.0-alpha-003 226 6/2/2023
6.1.0-alpha-002 185 5/2/2023
6.1.0-alpha-001 139 5/2/2023
6.0.8 183 6/20/2023
6.0.7 178 6/20/2023
6.0.6 182 6/19/2023
6.0.5 11,105 6/6/2023
6.0.4 208 6/2/2023
6.0.3 251 5/14/2023
6.0.2 211 5/5/2023
6.0.1 280 4/19/2023
6.0.0 615 4/13/2023
6.0.0-beta-001 316 4/5/2023
6.0.0-alpha-010 319 4/3/2023
6.0.0-alpha-009 146 3/31/2023
6.0.0-alpha-008 166 3/27/2023
6.0.0-alpha-007 147 3/27/2023
6.0.0-alpha-006 305 3/17/2023
6.0.0-alpha-005 154 2/24/2023
6.0.0-alpha-004 142 2/22/2023
6.0.0-alpha-003 144 2/4/2023
6.0.0-alpha-002 143 2/1/2023
6.0.0-alpha-001 183 1/24/2023
5.2.4 1,256 3/17/2023
5.2.3 571 3/6/2023
5.2.2 473 2/21/2023
5.2.1 8,654 2/4/2023
5.2.0 884 1/19/2023
5.2.0-alpha-012 271 1/14/2023
5.2.0-alpha-011 194 1/12/2023
5.2.0-alpha-010 139 12/30/2022
5.2.0-alpha-009 144 12/29/2022
5.2.0-alpha-008 162 12/28/2022
5.2.0-alpha-007 146 12/26/2022
5.2.0-alpha-006 142 12/22/2022
5.2.0-alpha-005 150 12/16/2022
5.2.0-alpha-004 164 12/8/2022
5.2.0-alpha-003 139 12/6/2022
5.2.0-alpha-002 158 12/4/2022
5.2.0-alpha-001 138 11/30/2022
5.1.5 1,500 12/22/2022
5.1.4 704 11/30/2022
5.1.3 886 11/14/2022
5.1.2 920 11/10/2022
5.1.1 687 11/7/2022
5.1.0 688 11/4/2022
5.1.0-beta-002 162 10/29/2022
5.1.0-beta-001 214 10/19/2022
5.1.0-alpha-007 171 10/14/2022
5.1.0-alpha-006 164 10/14/2022
5.1.0-alpha-005 130 10/7/2022
5.1.0-alpha-004 151 10/7/2022
5.1.0-alpha-003 144 10/2/2022
5.1.0-alpha-002 170 9/29/2022
5.1.0-alpha-001 237 9/18/2022
5.0.6 1,821 10/13/2022
5.0.5 853 10/7/2022
5.0.4 802 10/4/2022
5.0.3 883 9/29/2022
5.0.2 749 9/22/2022
5.0.1 807 9/18/2022
5.0.0 13,884 9/16/2022
5.0.0-beta-010 226 9/10/2022
5.0.0-beta-009 607 9/2/2022
5.0.0-beta-008 453 8/30/2022
5.0.0-beta-007 338 8/19/2022
5.0.0-beta-006 214 8/12/2022
5.0.0-beta-005 201 8/3/2022
5.0.0-beta-004 167 7/27/2022
5.0.0-beta-003 215 7/26/2022
5.0.0-beta-002 199 7/19/2022
5.0.0-beta-001 197 7/15/2022
5.0.0-alpha-011 240 7/8/2022
5.0.0-alpha-010 218 6/27/2022
5.0.0-alpha-009 163 6/21/2022
5.0.0-alpha-008 176 5/28/2022
5.0.0-alpha-007 291 5/16/2022
5.0.0-alpha-006 208 5/13/2022
5.0.0-alpha-005 185 5/7/2022
5.0.0-alpha-004 225 5/7/2022
5.0.0-alpha-003 166 5/6/2022

### Changed

* * Update FCS to 'SynType with single slash and type', commit e1f735546a907b0a511b818f10829b1d75139021

### Fixed

* * Fantomas moves comma and breaks code. [#2381](https://github.com/fsprojects/fantomas/issues/2381)
* * Idempotency problem for unit of measure. [2264](https://github.com/fsprojects/fantomas/issues/2264)
* * Indent interface member after anonymous record as generic type. [#2396](https://github.com/fsprojects/fantomas/issues/2396)
* * Unexpected concatenation of docstring lines after private modifier on DU. [#2401](https://github.com/fsprojects/fantomas/issues/2401)
* * Star in tuple return type lost. [#2403](https://github.com/fsprojects/fantomas/issues/2403)