Skip to content

docs(assets): tell the scaffolded CLAUDE.md how to run scc without installing it #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
protonspy merged 1 commit into from
Aug 1, 2026
Merged

docs(assets): tell the scaffolded CLAUDE.md how to run scc without installing it #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion internal/assets/assets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ import (
// of touching every managed file to record a number nobody read.
//
// 2: the knowledge-base skills and their commands.
const Version = "2"
// 3: CLAUDE.md documents the npx fallback for running scc uninstalled.
const Version = "3"

// The embedded tree. "all:" so nothing is silently dropped for having a name the
// default embed pattern skips.
Expand Down
8 changes: 8 additions & 0 deletions internal/assets/templates/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ docs/ the knowledge base — wiki, adr, codewiki, glossary, stack
scc validate # every applicable validator; exit 2 means findings
```

If `scc` is not installed on this machine, run it with no install — same binary,
same exit codes:

```

@coderabbitai coderabbitai Bot Aug 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 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

npx @protonspy/scc validate # always the latest
npx @protonspy/scc@<version> ... # pin a version (CI)
```

Exit codes are the contract: `0` ok, `1` the command could not run, `2` it ran and
found something. A finding is an answer, not a crash.

Expand Down
Loading