配置

Mago 从单一文件读取配置,通常是项目根目录下的 mago.toml。运行 mago init 可以生成一份骨架,也可以手写。

本页涵盖配置发现、extends 指令、全局选项以及 [source] 和 [parser] 小节。各工具特有的选项记录在每个工具的参考页面下。

发现

未传入 --config 时,Mago 按以下顺序查找配置文件:

1. 工作区目录(当前工作目录,或由 --workspace 指定的路径)。
2. 已设置时的 $XDG_CONFIG_HOME,例如 $XDG_CONFIG_HOME/mago.toml。
3. $HOME/.config,例如 ~/.config/mago.toml。
4. $HOME,例如 ~/mago.toml。

在每个位置,会先查找 mago.{toml,yaml,yml,json},再查找 mago.dist.{toml,yaml,yml,json}。同一目录内的格式优先级是 toml > yaml > yml > json。第一个被找到的文件胜出,这让你可以为没有本地配置的项目在 ~/.config/mago.toml 中保留一份全局配置。

编辑器 Schema

每个发布都会发布一个描述完整配置树的 JSON Schema。能识别该 Schema 的编辑器可以为 mago.{toml,yaml,yml,json} 提供自动补全、悬停文档与内联校验。

Schema 托管在:

• https://mago.carthage.software/<version>/schema.json,对应某个具体版本(如 1.26.0)。
• https://mago.carthage.software/latest/schema.json,最新的稳定版本。
• https://mago.carthage.software/main/schema.json,来自 main 分支的开发构建。

请将 URL 固定到你已安装的 Mago 版本,这样 Schema 与二进制就能保持同步。mago init 会把固定版本的 URL 写入它生成的配置文件中。

引用方式因格式而异:

#:schema https://mago.carthage.software/1.26.0/schema.json
version = "1"
php-version = "8.3"

# yaml-language-server: $schema=https://mago.carthage.software/1.26.0/schema.json
version: "1"
php-version: "8.3"

{
  "$schema": "https://mago.carthage.software/1.26.0/schema.json",
  "version": "1",
  "php-version": "8.3"
}

对于 TOML,该注释会被 Taplo 语言服务器读取,VS Code 的「Even Better TOML」扩展和 JetBrains 的 TOML 支持均基于它。对于 YAML,该注释会被 Red Hat YAML 语言服务器 读取。对于 JSON,所有现代编辑器都原生识别 $schema。Mago 本身会忽略 $schema 键以及这些魔法注释,它们仅用于编辑器工具。

如果你需要在 CI 中重新生成 Schema(例如,以编程方式校验配置文件),mago config --schema 会把它打印到 stdout。

用 extends 共享配置

自 Mago 1.25 起可用。更早的版本会默默忽略该指令。

extends 指令让一份配置可以叠加在其他配置之上,而不必复制粘贴。在多个项目共享同一份基线规范时很有用。

# 单个父配置
extends = "vendor/some-org/mago-config/mago.toml"

# 或使用列表,从左到右应用;后面的层覆盖前面的层
extends = [
  "vendor/some-org/mago-config",     # 目录:在其中查找 mago.{toml,yaml,yml,json}
  "configs/strict.json",              # 可以混合使用不同格式
  "../shared/team-defaults.toml",
]

# 本文件自身的键会覆盖以上各层中的任何内容
php-version = "8.3"

路径解析

绝对路径按原样使用。相对路径相对于声明 extends 的文件所在目录解析,而不是相对于当前工作目录。所以 mago --config some/dir/config.toml 配合 extends = "base.toml" 时,会查找 some/dir/base.toml。

文件类条目必须存在,且使用受支持的扩展名(.toml、.yaml、.yml、.json)。目录类条目会按上述优先级在其中扫描 mago.{toml,yaml,yml,json};一个不含可识别文件的目录会被跳过并打印一条警告,而不是让构建失败。

实际优先级

各层按"后写入者覆盖、最深层先解析"的方式合并:

1. 内置默认值。
2. 每一个 extends 层,递归处理。父层自身的 extends 会先解析,再应用其键。
3. 拥有该 extends 的文件自身的键。
4. 针对 受支持的标量 的 MAGO_* 环境变量。
5. CLI 参数,如 --php-version、--threads。

合并语义

按顶层键划分:

• 表(table)和对象进行深度合并。子层可以覆盖嵌套表中的某个键,而无需重定义整张表。
• 像 source.excludes 以及每条规则的 exclude 列表这类数组按顺序拼接,父层在前。如果基础配置排除了 vendor/,你保留这条排除并追加自己的。
• 标量(字符串、数字、布尔)由子层覆盖。

# base.toml
threads = 4
[source]
excludes = ["vendor", "node_modules"]

# project mago.toml
extends = "base.toml"
threads = 8
[source]
excludes = ["build"]   # 追加后 -> ["vendor", "node_modules", "build"]

通过追踪规范化路径来检测环路,并以清晰的错误提示中断,而不是无限递归。菱形继承(A 继承 B 和 C,两者都继承 D)会只处理 D 一次,完全没有问题。各层可以自由混用格式;每一层由其对应的解析驱动负责解析,在通用值层面合并,最终文档再依据 schema 进行校验。

全局选项

这些键位于 mago.toml 的根层。

version = "1"
php-version = "8.2"
threads = 8
stack-size = 8388608     # 8 MiB
editor-url = "phpstorm://open?file=%file%&line=%line%&column=%column%"

版本锁定

锁定版本能让已安装二进制与项目期望之间的差异尽早暴露,而不是默默地输出不同结果。

三种锁定级别:

• 主版本锁定(version = "1"):任何 1.x.y 都满足。升级到 2.x 会硬性报错,因为新主版本可能带来不兼容的默认值、schema 变化或规则行为。这是 mago init 默认写入的级别。
• 次版本锁定(version = "1.26"):任何 1.26.y 都满足。漂移到不同的次版本会发出警告;跨主版本仍然是致命错误。
• 精确锁定(version = "1.26.0"):任何漂移都会发出警告;跨主版本仍然是致命错误。

警告可通过 --no-version-check、MAGO_NO_VERSION_CHECK 环境变量,或配置中的 no-version-check = true 关闭。这些都不会影响主版本漂移,而后者正是版本锁定的全部意义所在。

把已安装二进制同步到项目的锁定版本:

mago self-update --to-project-version

对于精确锁定,会直接解析到对应的发布 tag。对于主版本或次版本锁定,Mago 会扫描近期的 GitHub 发布,安装满足锁定的最高版本。所以即便 2.0 已经发布,version = "1" 仍会安装最新的 1.x。

version 目前是可选项。未来某个 Mago 版本可能在未设置时开始警告,以提醒项目为最终的 2.0 升级做准备。

[source]

[source] 小节控制 Mago 如何发现和处理文件。

三类路径

Mago 区分你的代码、第三方代码,以及完全要忽略的代码:

• paths 是你的源码文件。Mago 会对它们进行分析、lint 和格式化。
• includes 是依赖(通常是 vendor)。Mago 会解析它们以解析符号和类型,但绝不会分析、lint 或重写它们。
• excludes 是 Mago 完全忽略的路径或 glob。它们对所有工具生效。

如果一个文件同时匹配 paths 和 includes,更具体的模式胜出。精确文件路径最具体,其次是更深的目录路径,然后是较浅的目录路径,最后是 glob 模式。当模式具体程度相同,includes 胜出,这让你可以显式地把某个路径标记为依赖。

[source]
paths     = ["src", "tests"]
includes  = ["vendor"]
excludes  = ["cache/**", "build/**", "var/**"]
extensions = ["php"]

三种列表都支持 glob 模式:

[source]
paths    = ["src/**/*.php"]
includes = ["vendor/symfony/**/*.php"]   # 仅包含 vendor 中的 Symfony
excludes = [
  "**/*_generated.php",
  "**/tests/**",
  "src/Legacy/**",
]

参考

Glob 设置

[source.glob] 用于调整 glob 的匹配方式。自 1.19 起可用。

[source.glob]
literal-separator = true     # `*` 不匹配 `/`;用 `**` 进行递归匹配
case-insensitive  = false
backslash-escape  = true     # `\` 用于转义特殊字符
empty-alternates  = false    # 为 true 时,`{,a}` 匹配 "" 和 "a"

mago init 生成的项目会设置 literal-separator = true。它让 * 的行为符合大多数用户的预期,即与 .gitignore 一样只匹配单层目录。

工具特定的排除

每个工具都有自己的可选 excludes。它们是叠加的:文件只要匹配全局列表或工具特定列表中的任意一项,就会被排除。

[source]
paths    = ["src", "tests"]
excludes = ["cache/**"]            # 对所有工具生效

[analyzer]
excludes = ["tests/**/*.php"]      # 仅对分析器生效

[formatter]
excludes = ["src/**/AutoGenerated/**/*.php"]

[linter]
excludes = ["database/migrations/**"]

linter 还支持按规则的路径排除,适用于让某条规则跳过某个路径而其他规则照常生效的场景。glob 模式在那里需要 Mago 1.20 或更高版本。完整参考见 linter 配置页面。

[linter.rules]
prefer-static-closure = { exclude = ["tests/"] }
no-global             = { exclude = ["**/*Test.php"] }

用 mago list-files 来确认 Mago 实际会处理的文件。mago list-files --command formatter 显示格式化器会触及的文件,--command analyzer 显示分析器的视角,以此类推。

[parser]

[parser]
enable-short-tags = false

当你的 .php 文件包含字面量 <?xml 声明,或并非真正 PHP 的模板片段时,可关闭短开标签。设置 enable-short-tags = false 后,像 <?xml version="1.0"?> 这样的序列会被当作内联文本而不是解析错误。代价是:任何依赖 <? 作为 PHP 开标签的代码不再被识别。

编辑器集成

Mago 可以把诊断输出中的文件路径渲染为 OSC 8 超链接。在终端里点击路径,你的编辑器会在对应的行号和列号上打开文件。受支持的终端包括 iTerm2、WezTerm、Kitty、Windows Terminal、Ghostty 以及其他若干款。

Mago 会在可能的情况下自动检测正在运行的编辑器。在 macOS 上读取 __CFBundleIdentifier;其他平台上检查 TERM_PROGRAM。下列编辑器开箱即被识别:

• PhpStorm、IntelliJ IDEA、WebStorm
• VS Code、VS Code Insiders
• Zed
• Sublime Text

如果自动检测失败,可显式配置 URL。优先级遵循"先匹配先生效":

1. MAGO_EDITOR_URL 环境变量。
2. mago.toml 中的 editor-url。
3. 自动检测。

export MAGO_EDITOR_URL="vscode://file/%file%:%line%:%column%"

editor-url = "phpstorm://open?file=%file%&line=%line%&column=%column%"

常用模板:

只有在输出是启用了颜色的终端时,超链接才会被渲染。当输出被管道接收或设置了 --colors=never 时,超链接会被自动抑制,不会干扰脚本或 CI。

超链接在 rich(默认)、medium、short 和 emacs 报告格式中出现。机器可读格式(json、github、gitlab、checkstyle、sarif)不受影响。

工具特定的配置

每个工具都有自己的参考页面,涵盖该工具的选项:

• Linter
• 格式化器
• 分析器
• Guard

检视合并后的配置

mago config 打印 Mago 实际使用的配置,即把默认值、每一层 extends、环境变量和 CLI 参数合并之后的结果。当某些行为不符合预期时很有用。

mago config                       # 以美化 JSON 格式输出完整配置
mago config --show linter         # 仅输出 [linter] 小节
mago config --show formatter
mago config --default             # 输出内置默认值
mago config --schema              # 输出完整配置的 JSON Schema
mago config --schema --show linter

全局参数必须放在 config 之前。完整列表见 CLI 概览。