Modernize: dedupe verify test run, add knip, docs routing - #43
Merged
Conversation
verify ran the suite twice (vp test, then vp test run --coverage); keep only the coverage run. Add knip in default and production mode, mirroring putio-sdk-typescript. ignoreExportsUsedInFile covers the four internal interfaces that declaration emit (TS4023) requires to stay exported. Pin vite-plus through the workspace catalog to clear the unused catalog entry knip found. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
README Docs now links docs/DISTRIBUTION.md, previously unreachable from any doc entrypoint. AGENTS.md documents the tracked .worktreeinclude and lists the clean script. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Use the unencoded /users/<app-slug>[bot] path, the user-id output key, and drop the redundant shell override, matching putio-sdk-typescript ci.yml exactly. No trust-boundary changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Modernizes the repo’s verification and maintenance workflow by removing duplicated test runs, introducing an unused-code gate via Knip, and improving documentation routing and release automation consistency.
Changes:
- Update
verifyto run a single coverage test pass and addknipchecks (dev + production modes), plus newlint:unused*scripts. - Add
knip.jsonconfiguration and alignvite-plusdependency management with the workspace catalog. - Route distribution docs from README, document worktree behavior/commands in AGENTS, and normalize the release bot identity resolution in CI.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds a Docs link to docs/DISTRIBUTION.md. |
| pnpm-lock.yaml | Adds Knip + catalog entry updates (incl. vite-plus). |
| package.json | Adds unused-code lint scripts and updates verify pipeline to include Knip and avoid duplicate tests. |
| knip.json | Introduces Knip config for entry/project globs and export-ignore behavior. |
| AGENTS.md | Documents clean and adds Worktrees guidance. |
| .github/workflows/ci.yml | Adjusts release bot identity lookup/output naming to match the intended shape. |
Files not reviewed (1)
- pnpm-lock.yaml: Generated file
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
vite-plus now resolves through catalog: in package.json, so setup-vp must read the concrete version from pnpm-workspace.yaml, matching putio-sdk-typescript's action. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
🎉 This PR is included in version 3.0.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
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.
Fixes #42. Part of the repo modernization program.
Problem
verifyran the unit suite twice:vp test, thenvp test run --coverage.vite-pluswas pinned directly while the workspace catalog entry sat unused.docs/DISTRIBUTION.mdwas unreachable from the README..worktreeincludeand thecleanscript were undocumented in AGENTS.md./users/${APP_SLUG}%5Bbot%5Dwith auser_idoutput key, diverging from putio-sdk-typescript.Solution
verifyis nowvp check . && vp pack && knip && knip --production --no-gitignore && vp test run --coverage; addedlint:unusedandlint:unused:prodmirroring putio-sdk-typescript.knip.jsonmirrors putio-sdk-typescript's config adapted to this repo's layout. Findings handled:IPutioAnalyticsAPIRetryItem,IPutioAnalyticsCacheOptions,IPutioAnalyticsUserAttributes,IPutioAnalyticsUser): un-exporting them breaks declaration emit with TS4023 because they leak into the inferred public types, so they are covered byignoreExportsUsedInFile(each is consumed in its own module) instead of removal.vite-plusdevDependency now usescatalog:instead of a direct pin.docs/DISTRIBUTION.md.vp run clean.[bot]path,user-idoutput key, noshelloverride. No other release trust-boundary changes.Proof
vp run verifygreen locally: check, pack, knip x2, coverage 100% (71/71 statements).vp run test:consumer4/4 pass with the pinned node 24.18.0.