fantomless-tool 4.7.7-prerelease

.NET Core 3.1
This is a prerelease version of fantomless-tool.
There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global fantomless-tool --version 4.7.7-prerelease
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local fantomless-tool --version 4.7.7-prerelease
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=fantomless-tool&version=4.7.7-prerelease&prerelease
nuke :add-package fantomless-tool --version 4.7.7-prerelease

Fantomless

Fantomas logo

F# source code formatter, fork of fantomas, which was inspired by scalariform for Scala, ocp-indent for OCaml and PythonTidy for Python.

Build Status Github Actions Discord

Why a fork

Many reasons:

  1. The most important one is that fantomas' maintainer doesn't agree with fantomas removing unneeded parenthesis, so we're bringing this feature here.
  2. We also implemented a bugfix for comments misplacement that the maintainer doesn't agree with (trying to address his feedback would mean a lot more time to work on it, which we don't have).
  3. We don't hold any resentment about our PullRequests not being accepted; we can just create a fork and be happy (and we would love if at some point our diff is taken and this fork is not needed anymore).
  4. That being said, we don't understand some behaviours from fantomas' maintainer. We recognize that he does superb technical work, and has even fixed many of our issues, etc., but that doesn't, in our opinon, give him the right to keep being, at times, a complete jerk when replying to us in issues and some of our PullRequests. It's even more difficult to understand when, in this opensource world of meritocracy, we have even contributed so many fixes upstream ourselves (more than 10 PullRequests).
  5. Last but not least; we included a feature for generic type normalization which we found out makes fantomas (fantomless) incompatible with units of measure. As we don't use units of measure, we don't mind including this feature. But don't use fantomless if you use F#'s Units of Measure!

Quick install

  • Command line: dotnet tool install -g fantomless-tool

How to use

Command line tool / API

Use this command to install Fantomless as a .NET 5 SDK global tool:

dotnet tool install -g fantomless-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 netcoreapp3.1
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
4.8.999 114 7/11/2022
4.7.999 118 5/13/2022
4.7.999-prerelease 87 5/16/2022
4.7.997 1,453 4/20/2022
4.7.997-prerelease 766 4/20/2022
4.7.996 211 4/7/2022
4.7.995 126 3/31/2022
4.7.99 124 3/29/2022
4.7.7-prerelease 97 4/15/2022
4.5.12.6 144 2/24/2022
4.5.12.5 431 2/16/2022
4.5.12.4 157 2/2/2022
4.5.12.3 128 2/2/2022
4.5.12.2 135 2/2/2022
4.5.7.2 285 11/11/2021
4.5.4.4 391 10/22/2021
4.5.4.2 195 10/21/2021
4.5.4.1 218 10/12/2021
4.5.3.2 200 9/28/2021
4.5.3.1 520 9/23/2021
4.5.3 174 9/20/2021
4.5.1 274 8/7/2021
4.4.0 295 7/31/2021

### Fixed
* Multiline parentheses objectExpression in indexer expression. [#2176](https://github.com/fsprojects/fantomas/issues/2176)
* Blank line over SynEnumCase is restored incorrectly. [#2155](https://github.com/fsprojects/fantomas/issues/2155)
* XML Doc comments on DU cases seem to get shuffled. [#2188](https://github.com/fsprojects/fantomas/issues/2188)
* Comment after bar is lost in single case DU. [#2182](https://github.com/fsprojects/fantomas/issues/2182)