docs(agents): align bundled rule + skill with Tier A flags + visibility column#29
Conversation
…visibility column Tier A query flags (--summary, --changed-since, --group-by, recipe actions) and the new symbols.visibility column landed in main but the bundled rule + skill didn't reference any of them. Agents installed via `codemap agents init` would have a stale view of the CLI surface. Updates four files in lockstep: - templates/agents/rules/codemap.md (ships to npm consumers) - templates/agents/skills/codemap/SKILL.md - .agents/rules/codemap.md (this repo's dev mirror) - .agents/skills/codemap/SKILL.md Per-rule changes: - New CLI table rows for --summary, --changed-since, --group-by - One-liner about per-row recipe `actions` (json + recipe only) - New trigger pattern row mapping "@internal / @beta / @Alpha / @Private" questions to symbols.visibility (parsed JSDoc tag, not regex) - New quick-reference query for visibility Per-skill changes: - symbols.visibility row added to the schema table - Two new query examples (visibility IS NOT NULL; visibility = 'beta') - "Output flags" subsection covering --summary / --changed-since / --group-by / recipe actions - Recipe id list extended with deprecated-symbols / visibility-tags / barrel-files / files-hashes (already shipped, just unlisted) Patch changeset because templates/agents/ is the only ship-affecting surface here — the column + flags themselves were released by their respective minor / patch changesets earlier on main.
🦋 Changeset detectedLatest commit: 527194e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 6 minutes and 23 seconds.Comment |
…d rule + skill
Adds a numbered governance rule capturing the discipline this PR
exists to enforce: when a CLI flag, recipe id, recipe `actions`
template, schema column, or any agent-queryable surface ships, both
copies of the codemap rule + skill must update in the same PR
(templates/agents/ ships to npm; .agents/ is this clone's mirror).
Three-surface update so the rule is discoverable from each entry point:
- docs/README.md Rule 10 (canonical) — cited from PRs by number.
- docs/agents.md One-liner pointing at Rule 10, framed as the
maintenance addendum to the "templates/agents
vs .agents" intro paragraph.
- .agents/lessons.md Lesson entry primed at session start so I'm
reminded before opening any core-surface PR.
References PR #29 as the retro-fix that
motivated codifying this.
Drift between templates/agents/ and .agents/ should remain CLI-prefix
only (codemap vs bun src/index.ts) — anything else means content has
diverged.
1 participant
Summary
The recent merges to
mainshipped:--summary,--changed-since <ref>,--group-by owner|directory|package, plus per-row recipeactions.symbols.visibilitycolumn (PR feat(symbols): add visibility column derived from JSDoc tags (B.7) #28).But the bundled
templates/agents/rule + skill (the surface installed bycodemap agents init) didn't reference any of them. Agents installed downstream would have a stale view of the CLI surface and miss the structured-column path for visibility queries. This PR aligns four files in lockstep:templates/agents/rules/codemap.mdcodemap agents inittemplates/agents/skills/codemap/SKILL.md.agents/rules/codemap.md.agents/skills/codemap/SKILL.mdPer-rule edits
--summary,--changed-since,--group-by(with example commands).actions(json + recipe only; ad-hoc SQL never carries them).@internal/@beta/@alpha/@privateroute tosymbols.visibility(the parsed JSDoc tag) rather thandoc_comment LIKE '%@beta%'.Per-skill edits
symbols.visibilityrow in the schema table.WHERE visibility IS NOT NULLandWHERE visibility = 'beta'.--summary/--changed-since/--group-by/ per-rowactions.deprecated-symbols,visibility-tags,barrel-files,files-hashes(already shipped via earlier PRs but never enumerated in the skill).Why patch (not minor)
templates/agents/is the only ship-affecting surface here. The column + flags themselves were released by their respective minor / patch changesets earlier on main. Per.agents/lessons.md"changesets bump policy (pre-v1)", docs / template churn defaults to patch.Test plan
bun run checkpasses locally (build, format:check, lint:ci, test, typecheck, test:golden — 19/19 golden scenarios green)..agents/) and shipped templates (templates/agents/) confirmed to differ only on the CLI-prefix prose (bun src/index.tsvscodemap) — same content otherwise.