Skip to content

README: wire bins via npm scripts, warn against npx - #1

Merged
chalin merged 2 commits into
mainfrom
drop-npx-usage-examples-2026-0722
Jul 22, 2026
Merged

README: wire bins via npm scripts, warn against npx#1
chalin merged 2 commits into
mainfrom
drop-npx-usage-examples-2026-0722

Conversation

@chalin

@chalin chalin commented Jul 22, 2026

Copy link
Copy Markdown
Owner
  • Replaces the README's npx lychee-norm-cache / npx refcache usage examples with npm-script wiring: consumers install this package as a devDependency, and npm run puts node_modules/.bin on the PATH.
  • Adds a warning admonition against invoking the bins via npx/npm exec: on a stale or missing node_modules, both fall back to the public npm registry and execute whatever package claims the name there, whereas a bare bin name fails loudly (exit 127) with zero registry traffic.

chalin added 2 commits July 22, 2026 07:53
- Replaces the `npx`-based usage examples with `package.json` script wiring: this package is a git-only dependency, so `npx BIN` on a stale or missing `node_modules` falls back to the public registry — where the `lychee-norm-cache` name is squatted (dependency-confusion PoC, 2026-06-30).
- Adds a warning admonition naming the hazard and the safe pattern (bare bin names under `npm run` resolve via `node_modules/.bin` or fail loudly, no registry traffic).
@chalin
chalin merged commit a2aeb1c into main Jul 22, 2026
1 check passed
@chalin
chalin deleted the drop-npx-usage-examples-2026-0722 branch July 22, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant