查看源代码 mix format (Mix v1.18.0-dev)
格式化给定的文件和模式。
$ mix format mix.exs "lib/**/*.{ex,exs}" "test/**/*.{ex,exs}"
如果任何文件是 -，则从 stdin 读取输入，并将输出写入 stdout。
格式化选项
格式化程序将读取当前目录中的 .formatter.exs 文件以进行格式化配置。评估此文件应返回一个关键字列表。
这是一个作为起点工作的 .formatter.exs 文件示例
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]除了 Code.format_string!/2 中列出的选项外，.formatter.exs 文件还支持以下选项
:inputs(路径和模式列表) - 指定此任务要使用的默认输入。例如，["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]。模式使用Path.wildcard/2展开。:plugins(模块列表) (自 v1.13.0 起) - 指定一个模块列表来自定义格式化程序的工作方式。有关更多信息，请参见下面的“插件”部分。:subdirectories(路径和模式列表) - 指定具有其自身格式化规则的子目录。每个子目录都应该有一个.formatter.exs来配置如何格式化该子目录中的条目。.formatter.exs之间的配置不共享也不继承。如果一个.formatter.exs将“lib/app”列为子目录，则.formatter.exs中的规则将不可用在lib/app/.formatter.exs中。请注意，父.formatter.exs必须在其:inputs配置中不指定“lib/app”子目录内的文件。如果发生这种情况，将选择哪个格式化程序配置的行为是不确定的。:import_deps(依赖项列表，以原子形式) - 指定依赖项列表，其格式化程序配置将被导入。有关更多信息，请参见下面的“导入依赖项配置”部分。:export(关键字列表) - 指定要导出的格式化程序配置。有关更多信息，请参见下面的“导入依赖项配置”部分。
任务特定选项
--force- 强制对所有文件进行格式化，而不是依赖缓存。--check-formatted- 检查文件是否已格式化。这在预提交钩子和 CI 脚本中很有用，如果您想拒绝具有未格式化代码的贡献。如果检查失败，则不会将格式化后的内容写入磁盘。请记住，格式化后的输出可能在 Elixir 版本之间有所不同，因为对格式化程序进行了改进和修复。--no-exit- 仅在与--check-formatted一起使用时有效。如果您不希望此 Mix 任务失败（并返回非零退出代码），但仍想检查格式错误并将其打印到控制台，请传递此选项。--dry-run- 格式化后不保存文件。--dot-formatter- 格式化程序配置文件的路径。如果存在，则默认为.formatter.exs。有关更多信息，请参见上面的“格式化选项”部分。--stdin-filename- 在 stdin 上格式化的文件的路径。如果您使用插件来支持自定义文件类型（如.heex），这很有用。如果不传递此标志，则假定通过 stdin 传递的代码是有效的 Elixir 代码。默认为“stdin.exs”。
何时格式化代码
我们建议开发人员直接在他们的编辑器中格式化代码，无论是在保存文件时自动格式化，还是通过显式命令或键绑定进行格式化。如果您的编辑器中没有此选项，则通常只需调用以下命令来添加所需的集成
$ cd $project && mix format $file
其中 $file 指的是当前文件，$project 是您的项目的根目录。
还可以通过将模式和文件列表传递给 mix format 来格式化整个项目中的代码，如本任务文档顶部所示。此列表也可以在 .formatter.exs 文件的 :inputs 键下设置。
插件
可以自定义格式化程序的行为。插件必须实现 Mix.Tasks.Format 行为。例如，假设您的项目以两种不同的方式使用 Markdown：通过自定义 ~M 标识符和通过具有 .md 和 .markdown 扩展名的文件。自定义插件将如下所示
defmodule MixMarkdownFormatter do
@behaviour Mix.Tasks.Format
def features(_opts) do
[sigils: [:M], extensions: [".md", ".markdown"]]
end
def format(contents, opts) do
# logic that formats markdown
end
end传递给 format/2 的 opts 包含所有格式化选项，以及以下两种情况之一
:sigil(原子) - 要格式化的标识符，例如:M。:modifiers(字符列表) - 标识符修饰符列表。:extension(字符串) - 要格式化的文件的扩展名，例如".md"。
现在，任何应用程序都可以按如下方式使用您的格式化程序
# .formatter.exs
[
# Define the desired plugins
plugins: [MixMarkdownFormatter, AnotherMarkdownFormatter],
# Remember to update the inputs list to include the new extensions
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}", "posts/*.{md,markdown}"]
]请注意，在使用插件运行格式化程序时，将首先编译您的代码。
此外，输入插件的顺序就是格式顺序。因此，在上面的 .formatter.exs 中，MixMarkdownFormatter 将在 AnotherMarkdownFormatter 之前格式化 markdown 文件和标识符。
导入依赖项配置
此任务支持从依赖项导入格式化程序配置。
想要导出格式化程序配置的依赖项需要在项目根目录中有一个 .formatter.exs 文件。在此文件中，依赖项可以列出一个 :export 选项，其中包含要导出的配置。目前，:export 下仅支持一个选项：:locals_without_parens（其值与 Code.format_string!/2 中 :locals_without_parens 的值具有相同的形状）。
在依赖项的 :export 选项中列出的 :locals_without_parens 下的函数可以通过在项目的格式化程序配置文件的 :import_deps 选项中列出该依赖项来导入到项目中。
例如，假设您有一个名为 my_app 的项目，它依赖于另一个名为 my_dep 的项目。 my_dep 想要导出一些配置，因此 my_dep/.formatter.exs 将如下所示
# my_dep/.formatter.exs
[
# Regular formatter configuration for my_dep
# ...
export: [
locals_without_parens: [some_dsl_call: 2, some_dsl_call: 3]
]
]为了导入配置，my_app 的 .formatter.exs 将如下所示
# my_app/.formatter.exs
[
import_deps: [:my_dep]
]