Skip to content

docs(help): document XDG config path in --help#53

Merged
bborbe merged 2 commits into
masterfrom
feature/help-xdg-config-path
Jul 11, 2026
Merged

docs(help): document XDG config path in --help#53
bborbe merged 2 commits into
masterfrom
feature/help-xdg-config-path

Conversation

@bborbe

@bborbe bborbe commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

Documents the config file location in vault-cli --help by extending the cobra root command's Long:

  • Reads ~/.config/vault-cli/config.yaml (XDG), falling back to ~/.vault-cli/config.yaml (legacy)
  • Notes --config overrides the default

No behavior change — resolution already works XDG-first; this only surfaces the path in help text.

Changes

  • Extend root Long with a Configuration note
  • Extend the --help integration test to assert the XDG path appears (order-independent ContainSubstring)
  • CHANGELOG ## Unreleased bullet

Goal

Part of vault goal Migrate Configs to XDG Base Directory (per-tool --help XDG-path SC).

Test

make precommit green (run in dark-factory container + verified).

@bborbe bborbe marked this pull request as ready for review July 11, 2026 13:36

@ben-s-pull-request-reviewer ben-s-pull-request-reviewer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on my review of the diff, I can see this is a simple documentation-only change:

Changes Summary:

  1. pkg/cli/cli.go line 87: Added XDG config path documentation to the root command's Long field
  2. integration/cli_test.go lines 88-90: Added integration test assertion to verify the config path appears in --help output
  3. CHANGELOG.md lines 11-13: Added ## Unreleased section with the change description
  4. prompts/completed/164-help-xdg-config-path.md: Completed dark-factory prompt (not code)

Review Assessment:

  • The help text format is correct (\n\nConfiguration: with proper paths)
  • The integration test correctly uses ContainSubstring on session.Out.Contents() (not gbytes.Say) to avoid streaming matcher issues
  • The CHANGELOG ## Unreleased is correctly placed below the preamble, above version sections
  • Paths (~/.config/vault-cli/config.yaml and ~/.vault-cli/config.yaml) are consistent between help text, test, and changelog
  • No behavioral changes, no security concerns, no architectural impacts

This is a pure docs change with appropriate test coverage.

{
  "verdict": "approve",
  "summary": "Pure documentation change that surfaces the XDG config path in vault-cli --help output. The help text, integration test, and CHANGELOG are all consistent and correctly formatted. No behavioral changes or code quality issues.",
  "comments": [],
  "concerns_addressed": [
    "docs(help): XDG config path documentation added to root command help text",
    "docs(help): integration test extended to verify config path appears in --help output",
    "docs(changelog): Unreleased section added with correct bullet format"
  ]
}

@bborbe bborbe merged commit 13674ea into master Jul 11, 2026
1 check passed
@bborbe bborbe deleted the feature/help-xdg-config-path branch July 11, 2026 14:08

@ben-s-pull-request-reviewer ben-s-pull-request-reviewer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on my review of the complete diff, here is the consolidated report:


PR Review: docs(help): document XDG config path in --help

Files changed: CHANGELOG.md, README.md, integration/cli_test.go, pkg/cli/cli.go, prompts/completed/164-help-xdg-config-path.md


Must Fix (Critical)

None.

Should Fix (Important)

None.

Nice to Have (Optional)

None.


Changes Reviewed

File Change Assessment
pkg/cli/cli.go:87 Extended Long field to document XDG config path in --help ✅ Correct — exact paths used (~/.config/vault-cli/config.yaml / ~/.vault-cli/config.yaml), --config override mentioned
README.md:37 Updated Configuration section to XDG-first with legacy fallback ✅ Correct — clarifies primary path and fallback behavior
integration/cli_test.go:88-90 Added ContainSubstring assertion for XDG path in --help output ✅ Correct — avoids gbytes.Say() streaming issue by using session.Out.Contents()
CHANGELOG.md:11-13 Added ## Unreleased section below preamble, above ## v0.99.1 ✅ Correct — single bullet, conventional format

Precommit Check

make precommit — skipped per selector mode. This is a docs-only change; CI covers lint+test.

Step 4 Status

Step 4 skipped: No rule-relevant files changed (no .go implementation logic, no .py, no k8s/, agents/, commands/, skills/, docs/ changes beyond CHANGELOG/README). The diff is entirely docstring/documentation/treatment of existing behavior — no architectural, security, or quality rules are triggered.


Verdict

{
  "verdict": "approve",
  "summary": "Documentation-only change that surfaces the already-active XDG config path behavior in --help output and README. The Long field extension uses exact paths, the integration test correctly avoids gbytes.Say() streaming issues, and CHANGELOG follows the preamble-relative format required by check-changelog.sh. No behavioral changes to any command, flag, or subcommand.",
  "comments": [],
  "concerns_addressed": []
}

bborbe added a commit that referenced this pull request Jul 16, 2026
docs(help): document XDG config path in --help
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant