config-loading-precedence
GitHub描述 Xberg 配置加载与优先级规则,涵盖 CLI/Server 模式、文件发现、JSON 合并及静默失败机制。用于配置调试或修改时的参考。
Trigger Scenarios
Install
npx skills add xberg-io/xberg --skill config-loading-precedence -g -y
SKILL.md
Frontmatter
{
"name": "config-loading-precedence",
"description": "How Xberg resolves configuration — CLI-mode and server\/MCP-mode precedence orders, config file auto-discovery (xberg.toml walk-up, then the user config dir), field-level inline JSON merge (merge_json_into_config), the ExtractionOverrides CLI layer, and the two mechanisms that make a config change silently do nothing. Load when adding a config flag or env var, changing config precedence, or debugging why a setting is or isn't taking effect."
}
Configuration Loading & Precedence
CLI Mode Precedence (highest to lowest)
- Individual CLI flags (
--ocr,--output-format,--chunk) - Inline JSON config (
--config-jsonor--config-json-base64) - Config file (
--config path.toml) - Auto-discovered config (
xberg.tomlin cwd/parents, then the user config dir) - Default values
Server/MCP Mode Precedence
- CLI arguments (
--host,--port) - Environment variables (
XBERG_HOST,XBERG_PORT) - Config file
[server]section - Defaults (
127.0.0.1:8000)
Config File Discovery
ExtractionConfig::discover() (core/config/extraction/loaders.rs) does two different things:
- Walks the current directory and its parents looking for
xberg.tomlonly — no.yaml/.yml/.jsonat this stage. First hit wins. - If that finds nothing, falls back to the per-user global config directory
(
dirs::config_dir()/xberg) and probes four basenames in a fixed order:xberg.toml,xberg.yaml,xberg.yml,xberg.json.
So a project-local xberg.yaml is not auto-discovered — pass it with --config.
Inline JSON Config
Field-level merge (not whole-object replacement):
fn merge_json_into_config(base: &ExtractionConfig, json: Value) -> Result<ExtractionConfig> {
let mut config_json = serde_json::to_value(base)?;
// Merge fields from json into config_json
serde_json::from_value(merged)?
}
Use --config-json-base64 for shell escaping.
Config File Formats
TOML (xberg.toml):
use_cache = true
[ocr]
backend = "tesseract"
languages = ["eng", "deu"]
[security_limits]
max_archive_size = 524288000
YAML and JSON follow equivalent structure.
CLI Flag Overrides
crates/xberg-cli/src/commands/overrides.rs: the ExtractionOverrides struct's validate()
runs first, then apply(self, config: &mut ExtractionConfig) lays individual CLI flags over
the merged config. There is no apply_extraction_overrides() and no commands.rs —
commands/ is a directory.
Inline JSON enters through apply_json_overrides(config, config_json, config_json_base64)
(crates/xberg-cli/src/input.rs), which delegates to merge_json_into_config.
Two silent no-op mechanisms
Duplicate Default impls. TesseractConfig is defined twice — public
(types/formats.rs, binding-friendly types) and internal (ocr/types.rs, engine-side types)
— bridged by a From impl, each with its own Default. Changing one default fixes only the
routes that materialise that struct. Before changing any config default, grep the bare
type name (a pub use module::*; makes a qualified path unsearchable) and check for a second
definition.
Unknown keys are ignored. #[serde(deny_unknown_fields)] is on exactly two structs:
ExtractionConfig (core/config/extraction/core.rs) and UrlExtractionConfig
(core/config/extraction/types.rs). Every nested config silently ignores a typo'd key, so a
wrong setting parses clean, does nothing, and the test still passes. Write config fixtures
against the serde wire names (ChunkingConfig declares max_characters but renames to
max_chars), and assert the parsed config differs from the default rather than that it parsed.
Critical Rules
- CLI flags always win over config file
- JSON merge is field-level, not whole-object
- Auto-discovery walks parents for
xberg.tomlonly; other extensions need--config --config-json-base64for shell-safe JSON passing- Server config uses
[server]section + extraction config
Version History
-
d8e4815
Current 2026-08-28 18:30
修正了配置自动发现逻辑的描述(不再自动发现 yaml/json),更新了 CLI Flag 覆盖机制的代码路径说明,并补充了关于重复 Default impl 和未知键被忽略的静默无操作机制。
- 531e0f7 2026-08-20 07:47


