docs: install and usage list, and fix the pnpm builtin collision in the link script - #4
Merged
Merged
Conversation
The README explained the design and skipped the part someone actually arrives for. Now it opens with a command table, then requirements, then install, then usage per command with runnable examples — the same shape the scripts repo README had, which was the one people used. Renames the link scripts to link:bin / unlink:bin. `link` and `unlink` are pnpm builtins, so `pnpm link` runs pnpm's own command and never touches this script — the README documented a step that would silently do nothing. Every command in the install section was run as written before committing. Also records requirements the tools have always had and never stated: gh authenticated, dig at /usr/bin/dig for domainjson, and OpenRDAP on PATH for its RDAP half. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
ThreatCrush Security Scan0 finding(s) No findings. |
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.
Replaces #3, which conflicted. Nothing was wrong with the change — the branch still carried the commit that #2 had already squashed onto
master, so git was being asked to apply it twice. Rebuilt frommasterwith only the one commit that is actually missing.Note: the vite advisory fix (
vitest@4) is already onmaster— the #2 squash picked it up at merge time.masterhasvitest@^4.1.10and resolvesvite@8.2.1. Nothing security-relevant is outstanding.1. The README now has install and usage
It explained the design and skipped the part someone actually arrives for. Now: command table → requirements → install → usage per command with runnable examples.
Also states requirements the tools always had and never documented:
ghauthenticated,digat/usr/bin/digfordomainjson, OpenRDAP onPATHfor its RDAP half (it degrades to DNS-only without it).2.
link→link:binThis is the part worth reviewing.
linkandunlinkare pnpm builtins.pnpm linkruns pnpm's own command and never touchesscripts/install-links.mjs, so the install step currently documented onmastersilently does nothing:Renamed to
link:bin/unlink:bin, with a//linknote inpackage.jsonso nobody renames it back. Every command in the install section was run as written before committing:pnpm link:bin --dry-run— correctly reports the existing~/scripts/binlinks as not-oursnode scripts/install-links.mjs --remove --dry-run— same, in reversepnpm test— 51 passedpnpm typecheck— clean🤖 Generated with Claude Code