resolve_config.py 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. #!/usr/bin/env python3
  2. """
  3. Resolve BMad's central config using four-layer TOML merge.
  4. Reads from four layers (highest priority last):
  5. 1. {project-root}/_bmad/config.toml (installer-owned team)
  6. 2. {project-root}/_bmad/config.user.toml (installer-owned user)
  7. 3. {project-root}/_bmad/custom/config.toml (human-authored team, committed)
  8. 4. {project-root}/_bmad/custom/config.user.toml (human-authored user, gitignored)
  9. Outputs merged JSON to stdout. Errors go to stderr.
  10. Uses only the Python stdlib (`tomllib`) — no third-party dependencies.
  11. BMad is standardizing on `uv run` to invoke scripts (uv provisions a suitable
  12. interpreter for you); a plain `python3` on PATH still works during the
  13. transition. Either runner needs Python 3.11+ for `tomllib`.
  14. uv run resolve_config.py --project-root /abs/path/to/project
  15. uv run resolve_config.py --project-root ... --key core
  16. uv run resolve_config.py --project-root ... --key agents
  17. Merge rules (same as resolve_customization.py):
  18. - Scalars: override wins
  19. - Tables: deep merge
  20. - Arrays of tables where every item shares `code` or `id`: merge by that key
  21. - All other arrays: append
  22. """
  23. import argparse
  24. import json
  25. import sys
  26. from pathlib import Path
  27. try:
  28. import tomllib
  29. except ImportError:
  30. sys.stderr.write(
  31. "error: Python 3.11+ is required (stdlib `tomllib` not found).\n"
  32. )
  33. sys.exit(3)
  34. _MISSING = object()
  35. _KEYED_MERGE_FIELDS = ("code", "id")
  36. def load_toml(file_path: Path, required: bool = False) -> dict:
  37. if not file_path.exists():
  38. if required:
  39. sys.stderr.write(f"error: required config file not found: {file_path}\n")
  40. sys.exit(1)
  41. return {}
  42. try:
  43. with file_path.open("rb") as f:
  44. parsed = tomllib.load(f)
  45. if not isinstance(parsed, dict):
  46. return {}
  47. return parsed
  48. except tomllib.TOMLDecodeError as error:
  49. level = "error" if required else "warning"
  50. sys.stderr.write(f"{level}: failed to parse {file_path}: {error}\n")
  51. if required:
  52. sys.exit(1)
  53. return {}
  54. except OSError as error:
  55. level = "error" if required else "warning"
  56. sys.stderr.write(f"{level}: failed to read {file_path}: {error}\n")
  57. if required:
  58. sys.exit(1)
  59. return {}
  60. def _detect_keyed_merge_field(items):
  61. if not items or not all(isinstance(item, dict) for item in items):
  62. return None
  63. for candidate in _KEYED_MERGE_FIELDS:
  64. if all(item.get(candidate) is not None for item in items):
  65. return candidate
  66. return None
  67. def _merge_by_key(base, override, key_name):
  68. result = []
  69. index_by_key = {}
  70. for item in base:
  71. if not isinstance(item, dict):
  72. continue
  73. if item.get(key_name) is not None:
  74. index_by_key[item[key_name]] = len(result)
  75. result.append(dict(item))
  76. for item in override:
  77. if not isinstance(item, dict):
  78. result.append(item)
  79. continue
  80. key = item.get(key_name)
  81. if key is not None and key in index_by_key:
  82. result[index_by_key[key]] = dict(item)
  83. else:
  84. if key is not None:
  85. index_by_key[key] = len(result)
  86. result.append(dict(item))
  87. return result
  88. def _merge_arrays(base, override):
  89. base_arr = base if isinstance(base, list) else []
  90. override_arr = override if isinstance(override, list) else []
  91. keyed_field = _detect_keyed_merge_field(base_arr + override_arr)
  92. if keyed_field:
  93. return _merge_by_key(base_arr, override_arr, keyed_field)
  94. return base_arr + override_arr
  95. def deep_merge(base, override):
  96. if isinstance(base, dict) and isinstance(override, dict):
  97. result = dict(base)
  98. for key, over_val in override.items():
  99. if key in result:
  100. result[key] = deep_merge(result[key], over_val)
  101. else:
  102. result[key] = over_val
  103. return result
  104. if isinstance(base, list) and isinstance(override, list):
  105. return _merge_arrays(base, override)
  106. return override
  107. def extract_key(data, dotted_key: str):
  108. parts = dotted_key.split(".")
  109. current = data
  110. for part in parts:
  111. if isinstance(current, dict) and part in current:
  112. current = current[part]
  113. else:
  114. return _MISSING
  115. return current
  116. def main():
  117. parser = argparse.ArgumentParser(
  118. description="Resolve BMad central config using four-layer TOML merge.",
  119. )
  120. parser.add_argument(
  121. "--project-root", "-p", required=True,
  122. help="Absolute path to the project root (contains _bmad/)",
  123. )
  124. parser.add_argument(
  125. "--key", "-k", action="append", default=[],
  126. help="Dotted field path to resolve (repeatable). Omit for full dump.",
  127. )
  128. args = parser.parse_args()
  129. project_root = Path(args.project_root).resolve()
  130. bmad_dir = project_root / "_bmad"
  131. base_team = load_toml(bmad_dir / "config.toml", required=True)
  132. base_user = load_toml(bmad_dir / "config.user.toml")
  133. custom_team = load_toml(bmad_dir / "custom" / "config.toml")
  134. custom_user = load_toml(bmad_dir / "custom" / "config.user.toml")
  135. merged = deep_merge(base_team, base_user)
  136. merged = deep_merge(merged, custom_team)
  137. merged = deep_merge(merged, custom_user)
  138. if args.key:
  139. output = {}
  140. for key in args.key:
  141. value = extract_key(merged, key)
  142. if value is not _MISSING:
  143. output[key] = value
  144. else:
  145. output = merged
  146. sys.stdout.write(json.dumps(output, indent=2, ensure_ascii=False) + "\n")
  147. if __name__ == "__main__":
  148. main()