refactor: Have all styleframe packages as peerDependencies #55
Conversation
🦋 Changeset detectedLatest commit: 504a21c The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Styleframe monorepo to use peer dependencies instead of direct dependencies for internal packages, improving modularity and allowing consumers to have better control over package versions. The changes ensure that all Styleframe packages are explicitly installed by consumers rather than being bundled transitively.
Key Changes:
- Moved internal Styleframe package dependencies to
peerDependenciesin@styleframe/core,@styleframe/loader,@styleframe/transpiler, and@styleframe/cli, while maintaining them indevDependenciesfor local development - Updated all installation documentation to list all nine Styleframe packages (
styleframe,@styleframe/cli,@styleframe/core,@styleframe/license,@styleframe/loader,@styleframe/plugin,@styleframe/pro,@styleframe/theme,@styleframe/transpiler) - Modified the CLI init command to add all Styleframe packages as development dependencies with consistent
^2.0.0version ranges
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| engine/core/package.json | Moved @styleframe/license from dependencies to peerDependencies, added to devDependencies |
| engine/loader/package.json | Moved @styleframe/core, @styleframe/license, and @styleframe/transpiler to peerDependencies, kept c12 in dependencies |
| engine/transpiler/package.json | Moved @styleframe/core and @styleframe/license to peerDependencies, kept scule in dependencies |
| tooling/cli/package.json | Moved @styleframe/loader to peerDependencies while keeping in devDependencies |
| tooling/cli/src/commands/init.ts | Expanded package installation to include all nine Styleframe packages in alphabetical order |
| apps/docs/.../vite.md | Updated installation instructions to list all Styleframe packages with explanatory text |
| apps/docs/.../nuxt.md | Updated installation instructions to list all Styleframe packages |
| apps/docs/.../custom.md | Updated installation instructions to list all Styleframe packages with explanatory text |
| .changeset/famous-feet-look.md | Added changeset documenting the peer dependency refactor for affected packages |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Install styleframe in your project | ||
|
|
||
| Install `styleframe`, `@styleframe/theme`, and `@styleframe/pro` as development dependencies to your project. | ||
| Install `styleframe`, `@styleframe/cli`, `@styleframe/core`, `@styleframe/license`, `@styleframe/loader`, `@styleframe/plugin`, `@styleframe/pro`, `@styleframe/theme`, and `@styleframe/transpiler` as development dependencies to your project. |
There was a problem hiding this comment.
The installation instruction text is inconsistent with the other documentation files (vite.md and custom.md). Consider using the same wording for consistency:
"Install all styleframe packages as development dependencies to your project. We've released each package separately to allow for better tree-shaking and version control."
This matches the description in the Vite and custom setup documentation.
| Install `styleframe`, `@styleframe/cli`, `@styleframe/core`, `@styleframe/license`, `@styleframe/loader`, `@styleframe/plugin`, `@styleframe/pro`, `@styleframe/theme`, and `@styleframe/transpiler` as development dependencies to your project. | |
| Install all styleframe packages as development dependencies to your project. We've released each package separately to allow for better tree-shaking and version control. |
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
This pull request refactors the dependency management across all Styleframe packages to use peer dependencies instead of direct dependencies, and updates documentation and tooling to reflect these changes. The goal is to improve tree-shaking, version control, and modularity for consumers of the Styleframe ecosystem.
Dependency management refactor:
package.jsonfiles for@styleframe/core,@styleframe/loader,@styleframe/transpiler, and@styleframe/clito move internal Styleframe packages fromdependenciestopeerDependencies, ensuring that consumers explicitly install required packages and improving compatibility. [1] [2] [3] [4] [5]Documentation updates:
Tooling update:
addPackageJsonDependenciesfunction intooling/cli/src/commands/init.tsto add all Styleframe packages as development dependencies during project initialization, matching the new peer dependency structure.These changes collectively streamline how Styleframe packages are consumed and managed, making the ecosystem more flexible and maintainable.