Extract CLI into @eventcatalog/cli package#2109
Merged
Conversation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 38cde3c The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
What This PR Does
Extracts the CLI from
@eventcatalog/sdkinto a new standalone@eventcatalog/clipackage. This gives cleaner separation of concerns — the SDK remains a pure programmatic API, while the CLI lives in its own package with its own dependencies (e.g.commander).Changes Overview
Key Changes
packages/cli/package — contains CLI entry point, executor, list command, argument parser, and cli-docs registrybinfield,commanderdependency,./cli-docsexport, and CLI source/test files from SDKcreateSDKfrom@eventcatalog/sdkinstead of relative../indexverify-build.ymlnow packages and uploads the CLI artifact;turbo.jsonaddsdependsOn: ["^build:bin"]to ensure correct build orderingPackages affected
@eventcatalog/cli(new,minor)@eventcatalog/sdk(patch— removes CLI, no API changes)How It Works
The CLI package depends on
@eventcatalog/sdkviaworkspace:*and re-exports the sameeventcatalogbinary. All CLI source files were moved with imports updated from relative SDK paths to the@eventcatalog/sdkpackage import. Tests were moved alongside and mock paths updated accordingly.Turbo's
build:bintask now usesdependsOn: ["^build:bin"]so workspace dependencies (SDK) always build before dependents (CLI).Breaking Changes
@eventcatalog/sdkno longer provides theeventcatalogbinary — users should install@eventcatalog/cliinstead@eventcatalog/sdk/cli-docsexport has moved to@eventcatalog/cli/cli-docsTest Plan
pnpm run build:bin— all 5 packages build successfullynode packages/cli/dist/cli/index.js --help— shows helpnode packages/cli/dist/cli/index.js list— lists SDK functions@eventcatalog/cli@0.1.0published to npm🤖 Generated with Claude Code