fantomas-tool 4.7.9

Fantomas

F# 源代码格式化工具，灵感来源于 Scala 的 Scalariform、OCaml 的 ocp-indent 和 Python 的 PythonTidy。

快速安装

• 命令行： dotnet tool install -g fantomas-tool
• JetBrains Rider：已预装
• VSCode：是 Ionide 和 fantomas-fmt 的一部分。
• Visual Studio 2019
• Visual Studio 2022

如何使用

命令行工具 / API

使用此命令将 Fantomas 安装为 .NET 5 SDK 全局工具

dotnet tool install -g fantomas-tool

有关详细指南，请阅读 Fantomas：如何使用。

FAKE 构建系统

Fantomas 可以轻松集成到 FAKE 构建系统。查看示例。

JetBrains Rider

Resharper for F# 在底层使用 Fantomas 格式化源代码。无需任何附加插件。

在 Rider 中使用最新版本

由于技术原因，Rider 无法始终使用 NuGet 上找到的最新版本的 Fantomas。作为解决方案，您可以本地安装 fantomas-tool 并使用 dotnet tool install fantomas-tool 配置它为一个 外部工具。

这将对您的 Rider 编辑体验产生影响，外部命令行应用程序对文件的更改可能会触发比必要的更多 Rider 内部逻辑。这在默认格式化体验中可能会很明显。

Visual Studio Code

建议通过使用 Ionide 插件 来使用 Fantomas。Fantomas 集成在 FSAutoComplete 中，这是 Ionide 使用的语言服务器。

或者，您可以安装 fantomas-fmt 扩展。

Visual Studio

F# 格式化扩展将 Fantomas 设置为 F# 文件的默认格式化程序，可在 Visual Studio 的选项中进行配置。

• Visual Studio 2019
• Visual Studio 2022

Visual Studio for Mac

使用 dotnet tool install fantomas-tool 在本地安装 fantomas-tool 并将其配置为 [外部工具]

在线

尝试在线使用 Fantomas 在线工具。

早期构建

偶尔会发布给 https://nuget.net.cn/ 的 alpha 或 beta 版本。我们之前的 MyGet 源已弃用。

基准测试

一些数据可以在 https://fsprojects.github.io/fantomas/ 找到 <br/> 我们使用 BenchmarkDotNet 收集 master 分支上每个构建的数据。

目的

该项目旨在根据给定配置格式化 F# 源文件。Fantomas 将确保源文件中元素的正确缩进和一致的间距。我们假设在将其提供给工具之前，源文件是 F# 编译器可以解析的。Fantomas 遵循两个 F# 风格指南：默认情况下遵循微软的 F# 代码格式化指南 和通过各种 设置 的 G-Research F# 代码格式化指南。

用例

该项目考虑了以下用例进行开发

• 重新格式化一个不熟悉的代码库。当您不是原始编写者时，它会提供可读性。例如，以下示例

   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
  

  将被重写为

   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
  

• 将冗长语法转换为轻量语法。提供在冗长模式下的源文件，Fantomas 将将其适当格式化为轻量模式。这可能有助于代码生成，因为生成冗长源文件更容易。例如，以下代码片段

   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 ();;
  

  被重新格式化为

   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()
  

• 格式化 F# 签名，特别是由 F# 编译器和 F# Interactive 生成的签名。

对于更复杂的示例，请查看 F# 的输出示例，例如 20 个语言大战程序 和 10 个 CodeReview.SE 源文件。

为什么叫“Fantomas”？

选择这样的名字有几个原因。首先，它以“F”开头，就像许多其他 F# 项目一样。其次，Fantomas 是我文学作品中最喜欢的角色。最后，Fantomas 与 “phantom” 的希腊词根相同；巧合的是，F# AST 和格式化规则在正确处理起来时非常 神秘。

贡献指南

请参阅 贡献指南。

鸣谢

我们衷心感谢以下人员所做的贡献。

• Eric Taucher
• Steffen Forkmann
• Jack Pappas
• Ivan Towlson
• Don Syme
• Gustavo Guerra
• Jared Parsons
• Denis Ok
• Enrico Sada

许可

本库和工具可在Apache 2.0许可下使用。更多信息请参阅许可文件。