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.
NuGet\Install-Package Fantomas.Extras -Version 4.7.9
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.
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
#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

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 79 5/16/2022
5.0.0-alpha-006 84 5/13/2022
5.0.0-alpha-005 80 5/7/2022
5.0.0-alpha-004 69 5/7/2022
5.0.0-alpha-003 77 5/6/2022
5.0.0-alpha-002 93 4/4/2022
5.0.0-alpha-001 89 3/19/2022
4.7.9 563 5/2/2022
4.7.8 93 4/25/2022
4.7.7 104 4/20/2022
4.7.6 101 4/4/2022
4.7.5 106 3/27/2022
4.7.4 96 3/25/2022
4.7.3 217 3/12/2022
4.7.2 90 3/11/2022
4.7.1 109 3/8/2022
4.7.0 117 3/4/2022
4.6.6 101 3/4/2022
4.6.5 146 2/18/2022
4.6.4 102 2/11/2022
4.6.3 110 2/8/2022
4.6.2 203 2/6/2022
4.6.1 116 2/1/2022
4.6.0 512 1/14/2022
4.6.0-beta-001 83 1/8/2022
4.6.0-alpha-011 80 12/29/2021
4.6.0-alpha-010 102 12/4/2021
4.6.0-alpha-009 2,817 11/24/2021
4.6.0-alpha-008 570 11/19/2021
4.6.0-alpha-007 140 11/7/2021
4.6.0-alpha-006 128 11/3/2021
4.6.0-alpha-005 152 10/27/2021
4.6.0-alpha-004 124 10/20/2021
4.6.0-alpha-003 106 10/5/2021
4.6.0-alpha-002 120 9/7/2021
4.6.0-alpha-001 102 8/11/2021
4.5.12 119 1/8/2022
4.5.11 129 12/29/2021
4.5.10 156 12/4/2021
4.5.9 2,783 11/24/2021
4.5.8 642 11/19/2021
4.5.7 203 11/7/2021
4.5.6 310 11/3/2021
4.5.5 249 10/27/2021
4.5.4 304 10/5/2021
4.5.3 383 9/7/2021
4.5.2 312 8/11/2021
4.5.1 1,939 7/24/2021
4.5.0 841 7/7/2021
4.5.0-beta-005 188 7/6/2021
4.5.0-beta-004 130 7/5/2021
4.5.0-beta-003 176 7/5/2021
4.5.0-beta-002 192 6/27/2021
4.5.0-beta-001 663 6/5/2021
4.5.0-alpha-020 168 5/26/2021
4.5.0-alpha-019 143 5/22/2021
4.5.0-alpha-018 141 5/21/2021
4.5.0-alpha-017 192 5/15/2021
4.5.0-alpha-016 134 5/9/2021
4.5.0-alpha-015 168 5/8/2021
4.5.0-alpha-014 172 4/30/2021
4.5.0-alpha-013 138 4/27/2021
4.5.0-alpha-012 138 4/23/2021
4.5.0-alpha-011 201 4/20/2021
4.5.0-alpha-010 145 4/14/2021
4.5.0-alpha-009 149 4/11/2021
4.5.0-alpha-008 170 4/8/2021
4.5.0-alpha-007 166 4/8/2021
4.5.0-alpha-006 158 4/5/2021
4.5.0-alpha-005 156 4/3/2021
4.5.0-alpha-004 173 4/2/2021
4.5.0-alpha-003 175 3/28/2021
4.5.0-alpha-002 119 3/22/2021
4.5.0-alpha-001 1,721 2/26/2021
4.4.0 1,517 2/25/2021
4.4.0-beta-008 173 2/19/2021
4.4.0-beta-007 161 2/12/2021
4.4.0-beta-006 150 2/12/2021
4.4.0-beta-005 157 2/9/2021
4.4.0-beta-004 161 2/5/2021
4.4.0-beta-003 609 1/30/2021
4.4.0-beta-002 166 1/23/2021
4.4.0-beta-001 606 1/22/2021
4.4.0-alpha-008 383 1/15/2021
4.4.0-alpha-007 413 12/26/2020
4.4.0-alpha-006 267 12/25/2020
4.4.0-alpha-005 324 12/23/2020
4.4.0-alpha-004 388 12/22/2020
4.4.0-alpha-003 371 12/18/2020
4.4.0-alpha-002 324 12/17/2020
4.4.0-alpha-001 242 12/17/2020
4.3.0 1,446 12/17/2020
4.3.0-beta-002 305 12/11/2020
4.3.0-beta-001 222 12/7/2020
4.3.0-alpha-007 272 11/21/2020
4.3.0-alpha-006 257 11/20/2020
4.3.0-alpha-005 207 11/16/2020
4.3.0-alpha-004 718 11/12/2020
4.3.0-alpha-003 208 11/10/2020
4.3.0-alpha-002 229 10/26/2020
4.3.0-alpha-001 263 10/23/2020
4.2.0 3,341 9/25/2020
4.2.0-alpha-004 419 9/23/2020
4.2.0-alpha-003 234 9/21/2020
4.2.0-alpha-002 292 9/19/2020
4.2.0-alpha-001 273 9/18/2020
4.1.1 502 9/17/2020
4.1.0 783 9/10/2020
4.1.0-beta-004 407 9/5/2020
4.1.0-beta-003 302 9/4/2020
4.1.0-beta-002 686 9/4/2020
4.1.0-beta-001 281 9/3/2020
4.1.0-alpha-001 286 9/1/2020
4.0.0 2,294 8/27/2020
4.0.0-beta-003 300 8/21/2020
4.0.0-beta-002 366 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)