docs: retarget all install instructions to @deepl/cli and document Homebrew - #100
Merged
Conversation
…mebrew Replace all 10 occurrences of the unpublished install string with npm install -g @deepl/cli — including src/services/git-hooks.ts, the one PR #70 missed, which the CLI emits into generated hook output. A regression test now asserts generated hooks never reference an unpublished package name. README installation now documents Homebrew (brew install deepl/tap/deepl), npm, and from-source, with a Node 24 prerequisite, and drops the better-sqlite3 native-compilation caveat. The TROUBLESHOOTING NODE_MODULE_VERSION entry is replaced with accurate guidance for the remaining degradation cause (Node < 24). Six stale DeepLcom URLs now point at the DeepL org. CONTRIBUTING gains the Node 24 prerequisite; SECURITY.md's supported-versions table reflects that only 2.x is a published line. Credit to @maa-xx (#70) for reporting the broken install instructions. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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.
Summary
Retargets every install instruction to the real published name and documents all three install paths (sync-8mqh.4). This is the last code change before the v2.0.0 tag: the only occurrence in source — a broken install string the CLI emits into generated git hooks — is fixed and pinned by a regression test.
Changes Made
src/services/git-hooks.ts— thepre-pushtemplate's install hint now names@deepl/cli. This is the site PR docs: stop instructing readers to npm install the unpublished package #70's docs fix missed, so users received a broken instruction from the CLI itself.tests/unit/services/git-hooks.test.ts— newgenerated hook contentblock (TDD, red-then-green): for every hook type, generated output must never matchinstall -g deepl-cliand any npm instruction must name@deepl/cli. This is the guard that would have caught docs: stop instructing readers to npm install the unpublished package #70's omission.docs/SYNC.md(3),examples/31-sync-ci.sh(3),examples/18-cicd-integration.sh,examples/05-document-translation.sh,examples/README.md.brew install deepl/tap/deepl, installs Node itself), npm (npm install -g @deepl/cli), and from-source, with an explicit Node.js 24 prerequisite. Deletes thebetter-sqlite3native-compilation caveat (Xcode CLT / python3-make-gcc / windows-build-tools) and the stale "not yet published" npm section.docs/TROUBLESHOOTING.md— theNODE_MODULE_VERSION/npm rebuild better-sqlite3entry is replaced with accurate guidance for the one remaining cause of the same warning (running on Node < 24).DeepLcomURLs →DeepLorg (README badge + 2 clone URLs, CONTRIBUTING clone URL + issues link, TROUBLESHOOTING issues link).CONTRIBUTING.md— development prerequisite is now Node >= 24.0.0 (was >= 20.0.0).SECURITY.md— supported-versions table updated: 2.x supported; pre-2.0 versions were never published and are not supported.CHANGELOG.md— entries under Unreleased, crediting @maa-xx (docs: stop instructing readers to npm install the unpublished package #70) for reporting the broken install instructions.docs/API.md— audited, deliberately untouched: its remainingdeepl-clistrings are config/cache filesystem paths (~/.deepl-cli/,$XDG_CONFIG_HOME/deepl-cli/), which are correct as-is. CLAUDE.md architecture lines were already updated by feat(cache)!: migrate from better-sqlite3 to node:sqlite; require Node 24 #96 (verified, not redone).Test Coverage
New regression tests (4 — one per hook type) confirmed red against the old string, green after. Full suite: 236 suites / 5,540 tests pass on Node 24; lint and type-check clean. Acceptance greps: 0 hits for the unpublished install string anywhere (including CHANGELOG prose), 0
DeepLcomin tracked files.Backward Compatibility
✅ Runtime behavior unchanged except one emitted string in generated hook output (the broken instruction becomes a working one).
✅ Config/cache paths (
~/.deepl-cli/, XDG dirs) unchanged — deliberately not renamed.Size: Medium ✓
Wide but shallow: one source line + its tests, the rest documentation.
🤖 Generated with Claude Code