Deprecate @sigmacomputing/plugin in favor of @sigmacomputing/plugin-sdk#60
Draft
Pearce-Ropion wants to merge 4 commits into
Draft
Deprecate @sigmacomputing/plugin in favor of @sigmacomputing/plugin-sdk#60Pearce-Ropion wants to merge 4 commits into
Pearce-Ropion wants to merge 4 commits into
Conversation
Rename the existing package in packages/plugin-sdk to @sigmacomputing/plugin-sdk, and add a new packages/plugin workspace that keeps the @sigmacomputing/plugin name as a thin compatibility shim. The shim depends on @sigmacomputing/plugin-sdk, re-exports its entire public API, and emits a console.warn at import time directing consumers to migrate.
Replace the workspace:^ dependency on @sigmacomputing/plugin-sdk in the deprecated shim with an explicit ^X.Y.Z range, since the workspace protocol is not being rewritten to a concrete version at publish time. Update the bump-version script to keep any @sigmacomputing/* dependency in lockstep with the package version so the two stay in sync on every release bump.
Mirror the plugin-sdk's tsdown.config.ts pattern by merging the repository's shared base config. This restores the UMD bundle (which the base config emits alongside ESM and CJS), so add unpkg and jsdelivr entries back to the shim's package.json to advertise the UMD build.
bump-version.ts keeps every workspace package's version in lockstep with the root, so the per-package __VERSION__ overrides duplicated the root value. Inject __VERSION__ from the root package.json in tsdown.base.ts (already there) and vitest.base.ts (added), and collapse each package's tsdown.config.ts and vitest.config.ts into thin pass-throughs of the base.
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.
Summary
packages/plugin-sdkfrom@sigmacomputing/pluginto@sigmacomputing/plugin-sdk.packages/pluginworkspace that keeps the@sigmacomputing/pluginname as a thin compatibility shim.@sigmacomputing/plugin-sdkviaworkspace:^, re-exports its full public API (export * from '@sigmacomputing/plugin-sdk'), and emits aconsole.warnat import time directing consumers to migrate.packages/plugin/README.mdclearly marks the package as deprecated and walks through migration.Notes
@sigmacomputing/plugin-sdkinto a UMD bundle, which is undesirable for a transitional shim. CDN/UMD users should migrate to@sigmacomputing/plugin-sdk.workspace:^dependency on@sigmacomputing/plugin-sdkwill be rewritten by yarn at publish time to^<version>.README.md/CHANGELOG.md/CONTRIBUTING.mdreferences to@sigmacomputing/pluginwere intentionally left as-is — happy to update those in a follow-up if desired.Test plan
yarn installresolves the new workspace packageyarn buildproducesdist/{esm,cjs}for both packagesyarn typespassesyarn testpasses (the shim has no tests; plugin-sdk tests run unchanged)@sigmacomputing/pluginin a sample project and confirm the deprecationconsole.warnfires and all named exports still resolveGenerated by Claude Code