Fantomas.Core 5.0.0-alpha-011

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-alpha-011
NuGet\Install-Package Fantomas.Core -Version 5.0.0-alpha-011
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-alpha-011" />
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-alpha-011
#r "nuget: Fantomas.Core, 5.0.0-alpha-011"
#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-alpha-011&prerelease

// Install Fantomas.Core as a Cake Tool
#tool nuget:?package=Fantomas.Core&version=5.0.0-alpha-011&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 (3)

Showing the top 3 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#.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.3.0 229 3/15/2024
6.3.0-beta-001 69 3/7/2024
6.3.0-alpha-008 67 3/1/2024
6.3.0-alpha-007 85 1/27/2024
6.3.0-alpha-006 319 1/9/2024
6.3.0-alpha-005 87 12/22/2023
6.3.0-alpha-004 111 12/6/2023
6.3.0-alpha-003 625 11/15/2023
6.3.0-alpha-002 136 11/7/2023
6.3.0-alpha-001 82 11/3/2023
6.2.3 998 11/2/2023
6.2.2 7,489 10/18/2023
6.2.1 171 9/18/2023
6.2.0 5,963 8/29/2023
6.1.3 141 8/25/2023
6.1.2 204 7/23/2023
6.1.1 3,046 6/29/2023
6.1.0 182 6/28/2023
6.1.0-alpha-006 110 6/20/2023
6.1.0-alpha-005 111 6/20/2023
6.1.0-alpha-004 101 6/19/2023
6.1.0-alpha-003 198 6/2/2023
6.1.0-alpha-002 166 5/2/2023
6.1.0-alpha-001 107 5/2/2023
6.0.8 153 6/20/2023
6.0.7 142 6/20/2023
6.0.6 140 6/19/2023
6.0.5 11,057 6/6/2023
6.0.4 152 6/2/2023
6.0.3 200 5/14/2023
6.0.2 159 5/5/2023
6.0.1 220 4/19/2023
6.0.0 554 4/13/2023
6.0.0-beta-001 282 4/5/2023
6.0.0-alpha-010 257 4/3/2023
6.0.0-alpha-009 117 3/31/2023
6.0.0-alpha-008 113 3/27/2023
6.0.0-alpha-007 105 3/27/2023
6.0.0-alpha-006 239 3/17/2023
6.0.0-alpha-005 122 2/24/2023
6.0.0-alpha-004 121 2/22/2023
6.0.0-alpha-003 125 2/4/2023
6.0.0-alpha-002 134 2/1/2023
6.0.0-alpha-001 134 1/24/2023
5.2.4 1,152 3/17/2023
5.2.3 466 3/6/2023
5.2.2 321 2/21/2023
5.2.1 8,533 2/4/2023
5.2.0 719 1/19/2023
5.2.0-alpha-012 240 1/14/2023
5.2.0-alpha-011 113 1/12/2023
5.2.0-alpha-010 106 12/30/2022
5.2.0-alpha-009 124 12/29/2022
5.2.0-alpha-008 114 12/28/2022
5.2.0-alpha-007 128 12/26/2022
5.2.0-alpha-006 120 12/22/2022
5.2.0-alpha-005 117 12/16/2022
5.2.0-alpha-004 126 12/8/2022
5.2.0-alpha-003 112 12/6/2022
5.2.0-alpha-002 114 12/4/2022
5.2.0-alpha-001 121 11/30/2022
5.1.5 1,325 12/22/2022
5.1.4 536 11/30/2022
5.1.3 656 11/14/2022
5.1.2 696 11/10/2022
5.1.1 427 11/7/2022
5.1.0 453 11/4/2022
5.1.0-beta-002 133 10/29/2022
5.1.0-beta-001 159 10/19/2022
5.1.0-alpha-007 130 10/14/2022
5.1.0-alpha-006 133 10/14/2022
5.1.0-alpha-005 100 10/7/2022
5.1.0-alpha-004 125 10/7/2022
5.1.0-alpha-003 122 10/2/2022
5.1.0-alpha-002 148 9/29/2022
5.1.0-alpha-001 221 9/18/2022
5.0.6 1,547 10/13/2022
5.0.5 570 10/7/2022
5.0.4 501 10/4/2022
5.0.3 601 9/29/2022
5.0.2 477 9/22/2022
5.0.1 544 9/18/2022
5.0.0 13,611 9/16/2022
5.0.0-beta-010 207 9/10/2022
5.0.0-beta-009 583 9/2/2022
5.0.0-beta-008 336 8/30/2022
5.0.0-beta-007 305 8/19/2022
5.0.0-beta-006 137 8/12/2022
5.0.0-beta-005 137 8/3/2022
5.0.0-beta-004 144 7/27/2022
5.0.0-beta-003 135 7/26/2022
5.0.0-beta-002 168 7/19/2022
5.0.0-beta-001 157 7/15/2022
5.0.0-alpha-011 146 7/8/2022
5.0.0-alpha-010 158 6/27/2022
5.0.0-alpha-009 143 6/21/2022
5.0.0-alpha-008 149 5/28/2022
5.0.0-alpha-007 158 5/16/2022
5.0.0-alpha-006 151 5/13/2022
5.0.0-alpha-005 151 5/7/2022
5.0.0-alpha-004 153 5/7/2022
5.0.0-alpha-003 158 5/6/2022

### Added
* Add setting `fsharp_max_if_then_short_width`. [#2299](https://github.com/fsprojects/fantomas/issues/2299)

### Changed
* Restore the CodeFormatter.MakeRange public API. [#2306](https://github.com/fsprojects/fantomas/pull/2306)
* Update FCS to 'Add arrow to SynType.Fun trivia.', commit 5a5a5f6cd07aa4a8326baa07d4f7af1305ced6f4
* Update FCS to 'Fix setter first', commit 267d0a57f217df756d9ac33c6aa4ffbfe3b53097
* Update style of long if/match expressions (See [fslang-design#646](https://github.com/fsharp/fslang-design/issues/646)). [#2334](https://github.com/fsprojects/fantomas/pull/2334)
* `--force` will now write a file even when the result is invalid. [#2346](https://github.com/fsprojects/fantomas/issues/2346)

### Removed
* `--stdin`, `--stdout` and `--fsi` flags. [#2346](https://github.com/fsprojects/fantomas/issues/2346)

### Fixed
* KeepIndentInBranch not respected inside a let and match. [1825](https://github.com/fsprojects/fantomas/issues/1825)