Fantomas.Extras 5.0.0-alpha-006

This is a prerelease version of Fantomas.Extras.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Fantomas.Extras --version 5.0.0-alpha-006
                    
NuGet\Install-Package Fantomas.Extras -Version 5.0.0-alpha-006
                    
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-006" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Fantomas.Extras" Version="5.0.0-alpha-006" />
                    
Directory.Packages.props
<PackageReference Include="Fantomas.Extras" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Fantomas.Extras --version 5.0.0-alpha-006
                    
#r "nuget: Fantomas.Extras, 5.0.0-alpha-006"
                    
#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.
#:package Fantomas.Extras@5.0.0-alpha-006
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Fantomas.Extras&version=5.0.0-alpha-006&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Fantomas.Extras&version=5.0.0-alpha-006&prerelease
                    
Install as a Cake Tool

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 303 5/16/2022 5.0.0-alpha-007 is deprecated because it is no longer maintained.
5.0.0-alpha-006 285 5/13/2022 5.0.0-alpha-006 is deprecated because it is no longer maintained.
5.0.0-alpha-005 281 5/7/2022 5.0.0-alpha-005 is deprecated because it is no longer maintained.
5.0.0-alpha-004 274 5/7/2022 5.0.0-alpha-004 is deprecated because it is no longer maintained.
5.0.0-alpha-003 274 5/6/2022 5.0.0-alpha-003 is deprecated because it is no longer maintained.
5.0.0-alpha-002 285 4/4/2022 5.0.0-alpha-002 is deprecated because it is no longer maintained.
5.0.0-alpha-001 304 3/19/2022 5.0.0-alpha-001 is deprecated because it is no longer maintained.
4.7.9 2,006 5/2/2022
4.7.8 520 4/25/2022
4.7.7 514 4/20/2022
4.7.6 507 4/4/2022
4.7.5 544 3/27/2022
4.7.4 536 3/25/2022
4.7.3 635 3/12/2022
4.7.2 504 3/11/2022
4.7.1 547 3/8/2022
4.7.0 561 3/4/2022
4.6.6 529 3/4/2022
4.6.5 576 2/18/2022
4.6.4 549 2/11/2022
4.6.3 526 2/8/2022
4.6.2 652 2/6/2022
4.6.1 590 2/1/2022
4.6.0 1,000 1/14/2022
4.6.0-beta-001 252 1/8/2022
4.6.0-alpha-011 244 12/29/2021
4.6.0-alpha-010 277 12/4/2021
4.6.0-alpha-009 2,978 11/24/2021
4.6.0-alpha-008 704 11/19/2021
4.6.0-alpha-007 308 11/7/2021
4.6.0-alpha-006 262 11/3/2021
4.6.0-alpha-005 280 10/27/2021
4.6.0-alpha-004 259 10/20/2021
4.6.0-alpha-003 249 10/5/2021
4.6.0-alpha-002 255 9/7/2021
4.6.0-alpha-001 237 8/11/2021
4.5.12 358 1/8/2022
4.5.11 372 12/29/2021
4.5.10 397 12/4/2021
4.5.9 3,035 11/24/2021
4.5.8 890 11/19/2021
4.5.7 459 11/7/2021
4.5.6 556 11/3/2021
4.5.5 494 10/27/2021
4.5.4 560 10/5/2021
4.5.3 656 9/7/2021
4.5.2 588 8/11/2021
4.5.1 2,222 7/24/2021
4.5.0 1,099 7/7/2021
4.5.0-beta-005 367 7/6/2021
4.5.0-beta-004 312 7/5/2021
4.5.0-beta-003 326 7/5/2021
4.5.0-beta-002 345 6/27/2021
4.5.0-beta-001 816 6/5/2021
4.5.0-alpha-020 319 5/26/2021
4.5.0-alpha-019 322 5/22/2021
4.5.0-alpha-018 306 5/21/2021
4.5.0-alpha-017 347 5/15/2021
4.5.0-alpha-016 292 5/9/2021
4.5.0-alpha-015 321 5/8/2021
4.5.0-alpha-014 357 4/30/2021
4.5.0-alpha-013 291 4/27/2021
4.5.0-alpha-012 315 4/23/2021
4.5.0-alpha-011 364 4/20/2021
4.5.0-alpha-010 292 4/14/2021
4.5.0-alpha-009 313 4/11/2021
4.5.0-alpha-008 320 4/8/2021
4.5.0-alpha-007 321 4/8/2021
4.5.0-alpha-006 324 4/5/2021
4.5.0-alpha-005 333 4/3/2021
4.5.0-alpha-004 343 4/2/2021
4.5.0-alpha-003 371 3/28/2021
4.5.0-alpha-002 269 3/22/2021
4.5.0-alpha-001 1,883 2/26/2021
4.4.0 2,249 2/25/2021
4.4.0-beta-008 343 2/19/2021
4.4.0-beta-007 335 2/12/2021
4.4.0-beta-006 312 2/12/2021
4.4.0-beta-005 332 2/9/2021
4.4.0-beta-004 327 2/5/2021
4.4.0-beta-003 781 1/30/2021
4.4.0-beta-002 338 1/23/2021
4.4.0-beta-001 768 1/22/2021
4.4.0-alpha-008 536 1/15/2021
4.4.0-alpha-007 581 12/26/2020
4.4.0-alpha-006 440 12/25/2020
4.4.0-alpha-005 492 12/23/2020
4.4.0-alpha-004 565 12/22/2020
4.4.0-alpha-003 550 12/18/2020
4.4.0-alpha-002 490 12/17/2020
4.4.0-alpha-001 399 12/17/2020
4.3.0 1,714 12/17/2020
4.3.0-beta-002 478 12/11/2020
4.3.0-beta-001 414 12/7/2020
4.3.0-alpha-007 429 11/21/2020
4.3.0-alpha-006 424 11/20/2020
4.3.0-alpha-005 376 11/16/2020
4.3.0-alpha-004 875 11/12/2020
4.3.0-alpha-003 380 11/10/2020
4.3.0-alpha-002 402 10/26/2020
4.3.0-alpha-001 424 10/23/2020
4.2.0 3,665 9/25/2020
4.2.0-alpha-004 616 9/23/2020
4.2.0-alpha-003 423 9/21/2020
4.2.0-alpha-002 448 9/19/2020
4.2.0-alpha-001 433 9/18/2020
4.1.1 797 9/17/2020
4.1.0 1,042 9/10/2020
4.1.0-beta-004 572 9/5/2020
4.1.0-beta-003 478 9/4/2020
4.1.0-beta-002 852 9/4/2020
4.1.0-beta-001 465 9/3/2020
4.1.0-alpha-001 457 9/1/2020
4.0.0 2,579 8/27/2020
4.0.0-beta-003 501 8/21/2020
4.0.0-beta-002 532 8/7/2020

### Added
* Format function application that end with a list in the Stroustrup bracket style. [#2244](https://github.com/fsprojects/fantomas/pull/2244)
* Option to reduce multiple blank lines from source code. [#2198](https://github.com/fsprojects/fantomas/issues/2198)

### Changed
* Update FCS to 'More cleanup', commit e063dd2a7005faf953619ab4f232d1e3606c7ed2
* Rename `fsharp_ragnarok` to `fsharp_experimental_stroupstrup_style` and `fsharp_keep_indent_in_branch` to `fsharp_experimental_keep_indent_in_branch`. [#2251](https://github.com/fsprojects/fantomas/pull/2251)
* Consider wider default format for record declarations if any XML doc comments are present on fields. [#1879](https://github.com/fsprojects/fantomas/issues/1879)

### Removed
* Remove Elmish settings: `fsharp_max_elmish_width`, `fsharp_single_argument_web_mode` & `fsharp_disable_elmish_syntax`. [#2180](https://github.com/fsprojects/fantomas/issues/2180)
* Remove `fsharp_semicolon_at_end_of_line`. [#2247](https://github.com/fsprojects/fantomas/issues/2247)
* Remove `fsharp_keep_if_then_in_same_line`. [#2248](https://github.com/fsprojects/fantomas/issues/2248)
* Remove `fsharp_indent_on_try_with`. [#2249](https://github.com/fsprojects/fantomas/issues/2249)

### Fixed
* A space was added before paren lambda argument. [#2041](https://github.com/fsprojects/fantomas/issues/2041)
* Linq method call breaks because of space before paren lambda was added. [#2231](https://github.com/fsprojects/fantomas/issues/2231)