Repository navigation
docs(assets): tell the scaffolded CLAUDE.md how to run scc without installing it - #5
Merged
Merged
Conversation
…stalling it The scaffolded CLAUDE.md pointed at a bare `scc validate`, which is a dead end in any workspace where the binary was never installed — the agent reads the instruction, the command is not on PATH, and the check silently stops happening. Document the npx fallback next to the command it replaces, including the pinned form for CI. Bumps the template-set version to 3: a workspace template changed, so the manifest must be able to tell a pristine copy of the new text from an edited copy of the old one. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RirmHfmNmKTatfRVFhvm7o
📝 WalkthroughWalkthroughThe template documents ChangesTemplate documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@internal/assets/templates/CLAUDE.md`:
- Line 45: Add a language identifier to the fenced code block in CLAUDE.md,
using console or sh as appropriate, while preserving the existing command
examples unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: c0b15efd-b8f5-4026-971f-77a05b1cebfb
📒 Files selected for processing (2)
internal/assets/assets.gointernal/assets/templates/CLAUDE.md
| If `scc` is not installed on this machine, run it with no install — same binary, | ||
| same exit codes: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a language identifier to the fenced block.
Line 45 triggers markdownlint MD040. Use console or sh.
Proposed fix
-```
+```console
npx `@protonspy/scc` validate # always the latest
npx `@protonspy/scc`@<version> ... # pin a version (CI)🧰 Tools
🪛 markdownlint-cli2 (0.23.1)
[warning] 45-45: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@internal/assets/templates/CLAUDE.md` at line 45, Add a language identifier to
the fenced code block in CLAUDE.md, using console or sh as appropriate, while
preserving the existing command examples unchanged.
Source: Linters/SAST tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The
CLAUDE.mdthatscc initwrites into a workspace documented checking yourwork as a bare
scc validate. In any project where the binary was neverinstalled that instruction dead-ends: the agent reads it, the command is not on
PATH, and the check quietly stops happening.
Adds the npx fallback right under the command it replaces — same binary, same
exit codes — plus the pinned form for CI:
Kept to four lines and placed inline rather than as a new section: the file
carries an explicit brevity requirement, and this belongs next to the command,
not in a section of its own.
Template version
assets.Versiongoes2→3. A workspace template changed, so the manifesthas to be able to distinguish a pristine copy of the new text from an edited
copy of the old one.
Checks
go test ./...,gofmt -l, andgo vet ./...are clean.TestFreshArtifactsPassTheirOwnValidatorsstill passes.🤖 Generated with Claude Code
https://claude.ai/code/session_01RirmHfmNmKTatfRVFhvm7o
Summary by CodeRabbit
npxwhen the standard command is unavailable.