Repository navigation
docs: link CONTRIBUTING.md absolutely and stop calling db a manager - #179
Conversation
The package ships README.md but not CONTRIBUTING.md, so the relative link was dead in node_modules. db has had nothing to manage since db reset left in 0.5.0, and its description was the one top-level description without a period. The "~110 kB binary" claim from the same issue went with #161. Closes #152 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018qh9xqviBHYmzVtmQWSKqA
 [Low impact] The PR appears safe to merge; the existing gap in the README link test is non-blocking. Findings
SummaryFixes the contribution link for installed packages and updates the top-level
Reviews (2) · Last reviewed commit: "Merge remote-tracking branch 'origin/mai..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| const shipped = ((await Bun.file(join(ROOT, 'package.json')).json()) as { files: string[] }).files.filter(f => !f.startsWith('!')); | ||
| const relative = [...readme.matchAll(/\]\(([^)#][^)]*)\)/g)].map(m => m[1]!).filter(t => !/^[a-z]+:/.test(t)); | ||
| expect(relative.filter(t => !shipped.some(f => t === f || t.startsWith(`${f.replace(/\/$/, '')}/`)))).toEqual([]); |
There was a problem hiding this comment.
The new check accepts any target inside an included folder without checking whether the file exists or ships. For example, docs/schemas/missing.json passes, as does a link under src/__snapshots__, even though package.json excludes those directories. This leaves broken links inside allowed folders undetected.
Check targets against the packed file list, accepting directory links when they contain shipped files.
# Conflicts: # CHANGELOG.md
Closes #152.
What
CONTRIBUTING.mdon GitHub.package.jsonfilesships README.md but not CONTRIBUTING.md, so the relative link was dead in an installed package.dbdescription changes from "Query and manage the local SQLite database" to "Query the local cache.". Nothing has been manageable sincedb resetleft in 0.5.0, and it was the only top-level description without a period. The describe snapshot moves with it.Why
What #161 left of the issue, checked on main (
ebcf1cc):grep -c "110 kB" README.md→ 0). Commented on the issue; nothing to fix.CONTRIBUTING.mdlink and thedbdescription: both still there.dbsubcommand descriptions to fit the 80-column banner, so the style choice is better made once both have landed.How checked
src/readme.test.ts: every relative README link resolves to a path that a non-negatedfilesentry covers, and every top-level description in the real registry ends with a period. Both fail on main.src/readme.test.ts:description: 'Query the local cache.'→description: 'Query the local cache'indb.ts: 1 of 2 fails (the period test).bun run check: typecheck, Biome, Knip clean; 713 tests pass.Overlap:
src/commands/db.tsand the describe snapshot are also changed by #176 (other descriptions). Whichever lands second needs the snapshot regenerated.🤖 Generated with Claude Code
https://claude.ai/code/session_018qh9xqviBHYmzVtmQWSKqA