build(typescript): use workspace for TypeScript packages #157
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR transitions TypeScript packages to use a bun workspace, centralizing dependency version management via catalog references.
- Moves dependency versions to catalog-based references, reducing version duplication.
- Updates peer dependencies (e.g., using workspace:* for algokit-transact) to align with the workspace model.
- Introduces a new workspaces configuration and catalog definitions in the root package.json.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/typescript/algokit_transact/package.json | Converted version numbers to catalog references; binaryen moved from dependencies to devDependencies. |
| packages/typescript/algod_api/package.json | Updated dependency versions to catalog references and redefined a peer dependency to workspace:* |
| package.json | Added workspaces, catalog, and catalogs sections to manage dependency versions centrally. |
Comments suppressed due to low confidence (3)
packages/typescript/algod_api/package.json:69
- Using 'workspace:*' for the peer dependency ensures local consistency, but consider if additional version constraints might be beneficial for external consumers.
"@algorandfoundation/algokit-transact": "workspace:*"
package.json:2
- With the new workspaces and catalog configurations introduced, updating the project documentation to reflect these changes would help maintain clarity.
"description": "Defines the workspace for typescript packages and the deps/scripts for serving the docs and semantic release.",
packages/typescript/algokit_transact/package.json:32
- Binaryen has been moved from dependencies to devDependencies; please verify that this change aligns with its runtime requirements.
"binaryen": "catalog:wasm2js"
| }, | ||
| "peerDependencies": { | ||
| "@algorandfoundation/algokit-transact": "^1.0.0-alpha.18" | ||
| "@algorandfoundation/algokit-transact": "workspace:*" |
There was a problem hiding this comment.
How does this work when the package is published and has a dependency that needs to be resolved from the package registry when published rather than the workspace?
There was a problem hiding this comment.
When published bun will fill in the correct version numbers in the package.json. This makes me realize though that we might need to change the release to use bun publish (presumably it uses npm publish)
There was a problem hiding this comment.
From a versioning perspective, we potentially need some control here. Is there a way to control this?
If we add a new feature to algokit-transact we may need to ensure a new version of that package is published before algod-api and the version is updated. In other scenarios we potentially want to keep the min compatible version of algokit-transact to give the widest version support.
Uses a bun workspace for typescript packages