Fantomas.Extras 4.7.9

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Fantomas.Extras --version 4.7.9                
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.
<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 and Polyglot Notebooks. 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 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

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 165 5/16/2022
5.0.0-alpha-006 153 5/13/2022
5.0.0-alpha-005 151 5/7/2022
5.0.0-alpha-004 141 5/7/2022
5.0.0-alpha-003 146 5/6/2022
5.0.0-alpha-002 157 4/4/2022
5.0.0-alpha-001 163 3/19/2022
4.7.9 1,821 5/2/2022
4.7.8 398 4/25/2022
4.7.7 415 4/20/2022
4.7.6 414 4/4/2022
4.7.5 451 3/27/2022
4.7.4 444 3/25/2022
4.7.3 538 3/12/2022
4.7.2 407 3/11/2022
4.7.1 431 3/8/2022
4.7.0 435 3/4/2022
4.6.6 434 3/4/2022
4.6.5 479 2/18/2022
4.6.4 424 2/11/2022
4.6.3 434 2/8/2022
4.6.2 553 2/6/2022
4.6.1 470 2/1/2022
4.6.0 899 1/14/2022
4.6.0-beta-001 152 1/8/2022
4.6.0-alpha-011 151 12/29/2021
4.6.0-alpha-010 171 12/4/2021
4.6.0-alpha-009 2,884 11/24/2021
4.6.0-alpha-008 631 11/19/2021
4.6.0-alpha-007 205 11/7/2021
4.6.0-alpha-006 181 11/3/2021
4.6.0-alpha-005 203 10/27/2021
4.6.0-alpha-004 179 10/20/2021
4.6.0-alpha-003 164 10/5/2021
4.6.0-alpha-002 173 9/7/2021
4.6.0-alpha-001 155 8/11/2021
4.5.12 262 1/8/2022
4.5.11 277 12/29/2021
4.5.10 301 12/4/2021
4.5.9 2,935 11/24/2021
4.5.8 790 11/19/2021
4.5.7 357 11/7/2021
4.5.6 454 11/3/2021
4.5.5 397 10/27/2021
4.5.4 460 10/5/2021
4.5.3 554 9/7/2021
4.5.2 487 8/11/2021
4.5.1 2,124 7/24/2021
4.5.0 1,004 7/7/2021
4.5.0-beta-005 276 7/6/2021
4.5.0-beta-004 224 7/5/2021
4.5.0-beta-003 234 7/5/2021
4.5.0-beta-002 254 6/27/2021
4.5.0-beta-001 719 6/5/2021
4.5.0-alpha-020 242 5/26/2021
4.5.0-alpha-019 208 5/22/2021
4.5.0-alpha-018 205 5/21/2021
4.5.0-alpha-017 257 5/15/2021
4.5.0-alpha-016 193 5/9/2021
4.5.0-alpha-015 243 5/8/2021
4.5.0-alpha-014 244 4/30/2021
4.5.0-alpha-013 210 4/27/2021
4.5.0-alpha-012 214 4/23/2021
4.5.0-alpha-011 270 4/20/2021
4.5.0-alpha-010 199 4/14/2021
4.5.0-alpha-009 219 4/11/2021
4.5.0-alpha-008 224 4/8/2021
4.5.0-alpha-007 227 4/8/2021
4.5.0-alpha-006 224 4/5/2021
4.5.0-alpha-005 228 4/3/2021
4.5.0-alpha-004 242 4/2/2021
4.5.0-alpha-003 247 3/28/2021
4.5.0-alpha-002 177 3/22/2021
4.5.0-alpha-001 1,775 2/26/2021
4.4.0 2,127 2/25/2021
4.4.0-beta-008 242 2/19/2021
4.4.0-beta-007 233 2/12/2021
4.4.0-beta-006 204 2/12/2021
4.4.0-beta-005 229 2/9/2021
4.4.0-beta-004 222 2/5/2021
4.4.0-beta-003 673 1/30/2021
4.4.0-beta-002 234 1/23/2021
4.4.0-beta-001 667 1/22/2021
4.4.0-alpha-008 452 1/15/2021
4.4.0-alpha-007 479 12/26/2020
4.4.0-alpha-006 337 12/25/2020
4.4.0-alpha-005 392 12/23/2020
4.4.0-alpha-004 454 12/22/2020
4.4.0-alpha-003 438 12/18/2020
4.4.0-alpha-002 393 12/17/2020
4.4.0-alpha-001 296 12/17/2020
4.3.0 1,605 12/17/2020
4.3.0-beta-002 376 12/11/2020
4.3.0-beta-001 293 12/7/2020
4.3.0-alpha-007 327 11/21/2020
4.3.0-alpha-006 319 11/20/2020
4.3.0-alpha-005 276 11/16/2020
4.3.0-alpha-004 790 11/12/2020
4.3.0-alpha-003 278 11/10/2020
4.3.0-alpha-002 299 10/26/2020
4.3.0-alpha-001 315 10/23/2020
4.2.0 3,539 9/25/2020
4.2.0-alpha-004 491 9/23/2020
4.2.0-alpha-003 306 9/21/2020
4.2.0-alpha-002 363 9/19/2020
4.2.0-alpha-001 333 9/18/2020
4.1.1 677 9/17/2020
4.1.0 933 9/10/2020
4.1.0-beta-004 469 9/5/2020
4.1.0-beta-003 372 9/4/2020
4.1.0-beta-002 741 9/4/2020
4.1.0-beta-001 341 9/3/2020
4.1.0-alpha-001 358 9/1/2020
4.0.0 2,449 8/27/2020
4.0.0-beta-003 371 8/21/2020
4.0.0-beta-002 439 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)