chore: rename package to chesscom-sdk, add examples and discovery metadata#29
Merged
Merged
Conversation
…adata Rename the npm package from @dpianelli/chesscom to the unscoped chesscom-sdk for discoverability (the scoped name read as a personal project and ranks poorly in npm search). The repository, public API, and version are unchanged. - Update the name across package.json, release-please config, lockfile, README badges/install/imports, docs, and the issue template. - Add an examples/ directory (profile, game streaming, leaderboards/puzzle, typed error handling) importing the package by name via self-reference. - Broaden package keywords for npm search. - Stop linting the local .claude/ harness directory and the examples/ dir (type-aware lint needs a built project); ignore .claude/ in Prettier too. Co-Authored-By: Claude Opus 4.8 <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.
Why
The package was published as the scoped
@dpianelli/chesscom. A scoped, personal-namespace name reads as a one-off project and ranks poorly in npm search — a real drag on discovery for what is otherwise a feature-complete SDK. The unscopedchesscom-sdkis available on npm, and renaming now (3 days post-launch, ~no real users) is the cheapest it will ever be.The repository, the public TypeScript API, and the version are all unchanged — this is a distribution/name change only.
What
@dpianelli/chesscom→chesscom-sdkacrosspackage.json,release-please-config.json, the lockfile, README badges/install/imports, docs (SPEC/STYLE/CONTRIBUTING/RELEASING), the issue template, and thesrc/index.tsheader.examples/— four runnable, self-contained scripts (player profile + stats, lazy game streaming with filters, leaderboards/titled/puzzle, typed error handling). They import the package by name (chesscom-sdk) via Node self-referencing, so they double as copy-paste-real usage docs. Field access was checked against the actual schemas.chess-com,chess-com-api,published-data-api,pgn, …); 15 GitHub topics set on the repo..claude/harness dir andexamples/from ESLint (type-aware linting needs a built project), and ignore.claude/in Prettier. This is whynpm run checkwas red locally but green in CI (.claude/is untracked).Follow-up after merge (manual, npm-side)
Trusted publishing (OIDC) can't bootstrap a package that doesn't exist yet, so:
npm run build && npm publish --access public(publisheschesscom-sdk@1.0.1).chesscom-sdk→ this repo'spublish.yml, so release-please-driven releases resume via OIDC.npm deprecate @dpianelli/chesscom "Renamed to chesscom-sdk — npm i chesscom-sdk".Validation
npm run checkpasses — lint, format, typecheck, 111 tests.🤖 Generated with Claude Code