Rename the project to shadowtools - #9
Merged
Conversation
Covers the whole repository: README title, CI badge and clone URLs, the package name and bin entry, the usage banner, the module name in the documented examples, and the CLI entry point, which moves from shadowboxKey.js to shadowtools.js with git mv so history follows it. Three mentions of Shadowbox deliberately stay: the README and package description both name 'Outline VPN (Shadowbox) server', and the npm keyword. Shadowbox is Outline's own server component, not this project, so renaming those would make the docs wrong. The npm name shadowtools is unregistered, so nothing needs a scope. Version bumped to 4.0.0 since the package identity changes; nothing has been published under the old name, so no upgrade path is owed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QJR2DDBimsijgYgZS3bUS8
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
2 participants
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.
Renames everything in the repository from ShadowboxKeys to
shadowtools.What changes
# ShadowboxKeys# shadowtoolsrahmanow/ShadowboxKeysrahmanow/shadowtoolsshadowbox-keysshadowtoolsbin)shadowbox-keysshadowtoolsshadowboxKey.jsshadowtools.jsShadowboxKeys - manage…shadowtools - manage…require('shadowbox-keys')require('shadowtools')The entry point moves with
git mv, so history follows it, and its executable bit survives — which matters, since it is thebintarget.shadowtoolsis unregistered on npm, so no scope is needed. I checked before committing to it. Version bumped to4.0.0because the package identity changes; nothing was ever published under the old name, so no upgrade path is owed to anyone.What deliberately does not change
Three mentions of "Shadowbox" stay, because they refer to Outline's own server component, not to this project:
shadowboxnpm keyword, which is real discoverability for people searching for Outline toolingRenaming those would have made the documentation wrong rather than merely renamed.
Testing
62 tests pass, no skips. Beyond the suite I confirmed the renamed entry point still works everywhere it is referenced:
node shadowtools.js listagainst a mock Management API,npm start, theuicommand serving and answering an authenticated API call, and — vianpm link—shadowtools listas an installed command, which is what actually exercises the newbinentry.npm packships the right files under the new name.Two things this PR cannot do
require('shadowbox-keys')and links to the old repo. I have the fix committed locally but my write access to that repository was revoked partway through this session, so the push is refused with a 403. Details in the session; it needs re-authorising before I can land it.Generated by Claude Code