Fantomas.Extras 4.7.9

.NET Standard 2.0
There is a newer prerelease version of this package available.
See the version list below for details.
Install-Package Fantomas.Extras -Version 4.7.9
dotnet add package Fantomas.Extras --version 4.7.9
<PackageReference Include="Fantomas.Extras" Version="4.7.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fantomas.Extras --version 4.7.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Fantomas.Extras, 4.7.9"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Fantomas.Extras as a Cake Addin
#addin nuget:?package=Fantomas.Extras&version=4.7.9

// Install Fantomas.Extras as a Cake Tool
#tool nuget:?package=Fantomas.Extras&version=4.7.9
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 net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.0-alpha-007 40 5/16/2022
5.0.0-alpha-006 39 5/13/2022
5.0.0-alpha-005 40 5/7/2022
5.0.0-alpha-004 33 5/7/2022
5.0.0-alpha-003 41 5/6/2022
5.0.0-alpha-002 47 4/4/2022
5.0.0-alpha-001 37 3/19/2022
4.7.9 136 5/2/2022
4.7.8 48 4/25/2022
4.7.7 55 4/20/2022
4.7.6 58 4/4/2022
4.7.5 69 3/27/2022
4.7.4 59 3/25/2022
4.7.3 181 3/12/2022
4.7.2 53 3/11/2022
4.7.1 74 3/8/2022
4.7.0 84 3/4/2022
4.6.6 58 3/4/2022
4.6.5 107 2/18/2022
4.6.4 64 2/11/2022
4.6.3 70 2/8/2022
4.6.2 157 2/6/2022
4.6.1 81 2/1/2022
4.6.0 432 1/14/2022
4.6.0-beta-001 58 1/8/2022
4.6.0-alpha-011 57 12/29/2021
4.6.0-alpha-010 77 12/4/2021
4.6.0-alpha-009 2,798 11/24/2021
4.6.0-alpha-008 551 11/19/2021
4.6.0-alpha-007 111 11/7/2021
4.6.0-alpha-006 108 11/3/2021
4.6.0-alpha-005 133 10/27/2021
4.6.0-alpha-004 108 10/20/2021
4.6.0-alpha-003 92 10/5/2021
4.6.0-alpha-002 102 9/7/2021
4.6.0-alpha-001 80 8/11/2021
4.5.12 92 1/8/2022
4.5.11 98 12/29/2021
4.5.10 119 12/4/2021
4.5.9 2,750 11/24/2021
4.5.8 608 11/19/2021
4.5.7 161 11/7/2021
4.5.6 282 11/3/2021
4.5.5 223 10/27/2021
4.5.4 287 10/5/2021
4.5.3 353 9/7/2021
4.5.2 278 8/11/2021
4.5.1 1,911 7/24/2021
4.5.0 816 7/7/2021
4.5.0-beta-005 171 7/6/2021
4.5.0-beta-004 112 7/5/2021
4.5.0-beta-003 156 7/5/2021
4.5.0-beta-002 164 6/27/2021
4.5.0-beta-001 644 6/5/2021
4.5.0-alpha-020 148 5/26/2021
4.5.0-alpha-019 121 5/22/2021
4.5.0-alpha-018 120 5/21/2021
4.5.0-alpha-017 171 5/15/2021
4.5.0-alpha-016 111 5/9/2021
4.5.0-alpha-015 145 5/8/2021
4.5.0-alpha-014 148 4/30/2021
4.5.0-alpha-013 115 4/27/2021
4.5.0-alpha-012 115 4/23/2021
4.5.0-alpha-011 182 4/20/2021
4.5.0-alpha-010 126 4/14/2021
4.5.0-alpha-009 125 4/11/2021
4.5.0-alpha-008 141 4/8/2021
4.5.0-alpha-007 147 4/8/2021
4.5.0-alpha-006 131 4/5/2021
4.5.0-alpha-005 135 4/3/2021
4.5.0-alpha-004 146 4/2/2021
4.5.0-alpha-003 152 3/28/2021
4.5.0-alpha-002 99 3/22/2021
4.5.0-alpha-001 1,700 2/26/2021
4.4.0 1,390 2/25/2021
4.4.0-beta-008 150 2/19/2021
4.4.0-beta-007 138 2/12/2021
4.4.0-beta-006 130 2/12/2021
4.4.0-beta-005 137 2/9/2021
4.4.0-beta-004 138 2/5/2021
4.4.0-beta-003 588 1/30/2021
4.4.0-beta-002 149 1/23/2021
4.4.0-beta-001 583 1/22/2021
4.4.0-alpha-008 361 1/15/2021
4.4.0-alpha-007 391 12/26/2020
4.4.0-alpha-006 247 12/25/2020
4.4.0-alpha-005 301 12/23/2020
4.4.0-alpha-004 363 12/22/2020
4.4.0-alpha-003 345 12/18/2020
4.4.0-alpha-002 303 12/17/2020
4.4.0-alpha-001 217 12/17/2020
4.3.0 1,412 12/17/2020
4.3.0-beta-002 282 12/11/2020
4.3.0-beta-001 199 12/7/2020
4.3.0-alpha-007 252 11/21/2020
4.3.0-alpha-006 238 11/20/2020
4.3.0-alpha-005 183 11/16/2020
4.3.0-alpha-004 699 11/12/2020
4.3.0-alpha-003 187 11/10/2020
4.3.0-alpha-002 211 10/26/2020
4.3.0-alpha-001 242 10/23/2020
4.2.0 3,291 9/25/2020
4.2.0-alpha-004 392 9/23/2020
4.2.0-alpha-003 208 9/21/2020
4.2.0-alpha-002 267 9/19/2020
4.2.0-alpha-001 244 9/18/2020
4.1.1 464 9/17/2020
4.1.0 745 9/10/2020
4.1.0-beta-004 377 9/5/2020
4.1.0-beta-003 275 9/4/2020
4.1.0-beta-002 662 9/4/2020
4.1.0-beta-001 251 9/3/2020
4.1.0-alpha-001 261 9/1/2020
4.0.0 2,218 8/27/2020
4.0.0-beta-003 270 8/21/2020
4.0.0-beta-002 344 8/7/2020

### Changed
* Add `fable_modules` to the directories which are always excluded. [Fable 3.4](https://github.com/fable-compiler/Fable/releases/tag/3.4.0)

### Fixed
* Let binding after match lambda is moved outside of nested module. [#2214](https://github.com/fsprojects/fantomas/issues/2214)