Fantomas.Extras 5.0.0-alpha-007

This is a prerelease version of Fantomas.Extras.
dotnet add package Fantomas.Extras --version 5.0.0-alpha-007
NuGet\Install-Package Fantomas.Extras -Version 5.0.0-alpha-007
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="5.0.0-alpha-007" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fantomas.Extras --version 5.0.0-alpha-007
#r "nuget: Fantomas.Extras, 5.0.0-alpha-007"
#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=5.0.0-alpha-007&prerelease

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

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 161 5/16/2022
5.0.0-alpha-006 152 5/13/2022
5.0.0-alpha-005 150 5/7/2022
5.0.0-alpha-004 140 5/7/2022
5.0.0-alpha-003 145 5/6/2022
5.0.0-alpha-002 156 4/4/2022
5.0.0-alpha-001 161 3/19/2022
4.7.9 1,786 5/2/2022
4.7.8 395 4/25/2022
4.7.7 413 4/20/2022
4.7.6 410 4/4/2022
4.7.5 446 3/27/2022
4.7.4 440 3/25/2022
4.7.3 531 3/12/2022
4.7.2 403 3/11/2022
4.7.1 427 3/8/2022
4.7.0 430 3/4/2022
4.6.6 428 3/4/2022
4.6.5 476 2/18/2022
4.6.4 422 2/11/2022
4.6.3 431 2/8/2022
4.6.2 549 2/6/2022
4.6.1 467 2/1/2022
4.6.0 896 1/14/2022
4.6.0-beta-001 149 1/8/2022
4.6.0-alpha-011 150 12/29/2021
4.6.0-alpha-010 170 12/4/2021
4.6.0-alpha-009 2,882 11/24/2021
4.6.0-alpha-008 630 11/19/2021
4.6.0-alpha-007 202 11/7/2021
4.6.0-alpha-006 180 11/3/2021
4.6.0-alpha-005 202 10/27/2021
4.6.0-alpha-004 178 10/20/2021
4.6.0-alpha-003 160 10/5/2021
4.6.0-alpha-002 170 9/7/2021
4.6.0-alpha-001 154 8/11/2021
4.5.12 259 1/8/2022
4.5.11 274 12/29/2021
4.5.10 299 12/4/2021
4.5.9 2,928 11/24/2021
4.5.8 788 11/19/2021
4.5.7 355 11/7/2021
4.5.6 452 11/3/2021
4.5.5 394 10/27/2021
4.5.4 458 10/5/2021
4.5.3 551 9/7/2021
4.5.2 484 8/11/2021
4.5.1 2,119 7/24/2021
4.5.0 1,000 7/7/2021
4.5.0-beta-005 273 7/6/2021
4.5.0-beta-004 222 7/5/2021
4.5.0-beta-003 232 7/5/2021
4.5.0-beta-002 250 6/27/2021
4.5.0-beta-001 718 6/5/2021
4.5.0-alpha-020 240 5/26/2021
4.5.0-alpha-019 206 5/22/2021
4.5.0-alpha-018 203 5/21/2021
4.5.0-alpha-017 255 5/15/2021
4.5.0-alpha-016 190 5/9/2021
4.5.0-alpha-015 240 5/8/2021
4.5.0-alpha-014 241 4/30/2021
4.5.0-alpha-013 207 4/27/2021
4.5.0-alpha-012 211 4/23/2021
4.5.0-alpha-011 267 4/20/2021
4.5.0-alpha-010 196 4/14/2021
4.5.0-alpha-009 216 4/11/2021
4.5.0-alpha-008 221 4/8/2021
4.5.0-alpha-007 222 4/8/2021
4.5.0-alpha-006 220 4/5/2021
4.5.0-alpha-005 226 4/3/2021
4.5.0-alpha-004 238 4/2/2021
4.5.0-alpha-003 244 3/28/2021
4.5.0-alpha-002 173 3/22/2021
4.5.0-alpha-001 1,772 2/26/2021
4.4.0 2,122 2/25/2021
4.4.0-beta-008 238 2/19/2021
4.4.0-beta-007 230 2/12/2021
4.4.0-beta-006 203 2/12/2021
4.4.0-beta-005 226 2/9/2021
4.4.0-beta-004 220 2/5/2021
4.4.0-beta-003 671 1/30/2021
4.4.0-beta-002 232 1/23/2021
4.4.0-beta-001 665 1/22/2021
4.4.0-alpha-008 450 1/15/2021
4.4.0-alpha-007 477 12/26/2020
4.4.0-alpha-006 333 12/25/2020
4.4.0-alpha-005 390 12/23/2020
4.4.0-alpha-004 452 12/22/2020
4.4.0-alpha-003 436 12/18/2020
4.4.0-alpha-002 391 12/17/2020
4.4.0-alpha-001 294 12/17/2020
4.3.0 1,599 12/17/2020
4.3.0-beta-002 372 12/11/2020
4.3.0-beta-001 291 12/7/2020
4.3.0-alpha-007 325 11/21/2020
4.3.0-alpha-006 317 11/20/2020
4.3.0-alpha-005 274 11/16/2020
4.3.0-alpha-004 786 11/12/2020
4.3.0-alpha-003 276 11/10/2020
4.3.0-alpha-002 297 10/26/2020
4.3.0-alpha-001 313 10/23/2020
4.2.0 3,532 9/25/2020
4.2.0-alpha-004 487 9/23/2020
4.2.0-alpha-003 301 9/21/2020
4.2.0-alpha-002 360 9/19/2020
4.2.0-alpha-001 330 9/18/2020
4.1.1 672 9/17/2020
4.1.0 929 9/10/2020
4.1.0-beta-004 465 9/5/2020
4.1.0-beta-003 369 9/4/2020
4.1.0-beta-002 738 9/4/2020
4.1.0-beta-001 338 9/3/2020
4.1.0-alpha-001 355 9/1/2020
4.0.0 2,445 8/27/2020
4.0.0-beta-003 368 8/21/2020
4.0.0-beta-002 437 8/7/2020

### Changed
* Update FCS to 'Add SynExpr.Dynamic to SyntaxTree.', commit b822e2793bd6387c40cfd5b25d604e002a253257
* Restore the validation API. [#2236](https://github.com/fsprojects/fantomas/issues/2236)
* Renamed `fsharp_experimental_stroupstrup_style` to `fsharp_experimental_stroustrup_style`. [#2257](https://github.com/fsprojects/fantomas/pull/2257)