Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Scaffold plugin in create-medusa-app #10908

Merged
merged 16 commits into from
Jan 13, 2025
Merged

Conversation

adrien2p
Copy link
Member

@adrien2p adrien2p commented Jan 10, 2025

RESOLVES FRMW-2862

What
This PR enable the create-medusa-app CLI to accept a new --plugin option to scaffold a plugin. This is complementary to all the plugin commands being created/adjusted separately to that pr.
Also, this pr brings a little refactoring around resource scaffolding, the idea was to contain the refactoring to a little area and not expend it to the entire create-medusa-app package to not disrupt and expand the scope for which the purpose was to introduce the plugin scaffolding capabilities

Addition

  • medusa project will get their package.json name changed to the project name
  • Remove build step from medusa project creation

Plugin flow

  • in the plugin
    • npx create-medsa-app --plugin
    • yarn dev
  • in the project
    • yalc add plugin-name
    • yarn dev

Any changes on the plugin will publish, push in the local registry which will fire the hot reload of the app and include the new changes from the plugin

Copy link

changeset-bot bot commented Jan 10, 2025

🦋 Changeset detected

Latest commit: 11cd58d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 65 packages
Name Type
create-medusa-app Patch
@medusajs/medusa Patch
@medusajs/test-utils Patch
@medusajs/api-key Patch
@medusajs/auth Patch
@medusajs/cache-inmemory Patch
@medusajs/cache-redis Patch
@medusajs/cart Patch
@medusajs/currency Patch
@medusajs/customer Patch
@medusajs/event-bus-local Patch
@medusajs/event-bus-redis Patch
@medusajs/file Patch
@medusajs/fulfillment Patch
@medusajs/index Patch
@medusajs/inventory Patch
@medusajs/link-modules Patch
@medusajs/locking Patch
@medusajs/notification Patch
@medusajs/order Patch
@medusajs/payment Patch
@medusajs/pricing Patch
@medusajs/product Patch
@medusajs/promotion Patch
@medusajs/region Patch
@medusajs/sales-channel Patch
@medusajs/stock-location Patch
@medusajs/store Patch
@medusajs/tax Patch
@medusajs/user Patch
@medusajs/workflow-engine-inmemory Patch
@medusajs/workflow-engine-redis Patch
@medusajs/auth-emailpass Patch
@medusajs/auth-github Patch
@medusajs/auth-google Patch
@medusajs/file-local Patch
@medusajs/file-s3 Patch
@medusajs/fulfillment-manual Patch
@medusajs/locking-postgres Patch
@medusajs/locking-redis Patch
@medusajs/notification-local Patch
@medusajs/notification-sendgrid Patch
@medusajs/payment-stripe Patch
@medusajs/core-flows Patch
@medusajs/framework Patch
@medusajs/js-sdk Patch
@medusajs/modules-sdk Patch
@medusajs/orchestration Patch
@medusajs/types Patch
@medusajs/utils Patch
@medusajs/workflows-sdk Patch
@medusajs/cli Patch
@medusajs/medusa-oas-cli Patch
@medusajs/oas-github-ci Patch
@medusajs/telemetry Patch
@medusajs/admin-bundler Patch
@medusajs/admin-sdk Patch
@medusajs/admin-shared Patch
@medusajs/admin-vite-plugin Patch
@medusajs/dashboard Patch
@medusajs/icons Patch
@medusajs/toolbox Patch
@medusajs/ui-preset Patch
medusa-dev-cli Patch
integration-tests-http Patch

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

Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 13, 2025 2:05pm
6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Jan 13, 2025 2:05pm
api-reference-v2 ⬜️ Ignored (Inspect) Visit Preview Jan 13, 2025 2:05pm
docs-ui ⬜️ Ignored (Inspect) Visit Preview Jan 13, 2025 2:05pm
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Jan 13, 2025 2:05pm
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Jan 13, 2025 2:05pm
resources-docs ⬜️ Ignored (Inspect) Visit Preview Jan 13, 2025 2:05pm

@adrien2p
Copy link
Member Author

/snapshot-this

@adrien2p
Copy link
Member Author

/snapshot-this

@adrien2p adrien2p marked this pull request as ready for review January 13, 2025 09:32
@adrien2p adrien2p requested a review from a team as a code owner January 13, 2025 09:32
@adrien2p adrien2p requested review from sgirones and riqwan January 13, 2025 09:32
Copy link
Contributor

@thetutlage thetutlage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

Copy link
Member

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really cool 🚀

@olivermrbl olivermrbl changed the title Feat/plugin scaffolding feat: Scaffold plugin in create-medusa-app Jan 13, 2025
Copy link
Contributor

@carlos-r-l-rodrigues carlos-r-l-rodrigues left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 🏅

@kodiakhq kodiakhq bot merged commit c895ed8 into develop Jan 13, 2025
23 checks passed
@kodiakhq kodiakhq bot deleted the feat/plugin-scaffolding branch January 13, 2025 14:18
noubase pushed a commit to noubase/medusa that referenced this pull request Jan 22, 2025
RESOLVES FRMW-2862

**What**
This PR enable the `create-medusa-app` CLI to accept a new `--plugin` option to scaffold a plugin. This is complementary to all the plugin commands being created/adjusted separately to that pr.
Also, this pr brings a little refactoring around resource scaffolding, the idea was to contain the refactoring to a little area and not expend it to the entire create-medusa-app package to not disrupt and expand the scope for which the purpose was to introduce the plugin scaffolding capabilities

**Addition**
- medusa project will get their package.json name changed to the project name
- Remove build step from medusa project creation

**Plugin flow**

- in the plugin
  - `npx create-medsa-app --plugin`
  - `yarn dev`
- in the project
  - `yalc add plugin-name`
  - `yarn dev`

Any changes on the plugin will publish, push in the local registry which will fire the hot reload of the app and include the new changes from the plugin
jimrarras pushed a commit to jimrarras/medusa that referenced this pull request Jan 28, 2025
RESOLVES FRMW-2862

**What**
This PR enable the `create-medusa-app` CLI to accept a new `--plugin` option to scaffold a plugin. This is complementary to all the plugin commands being created/adjusted separately to that pr.
Also, this pr brings a little refactoring around resource scaffolding, the idea was to contain the refactoring to a little area and not expend it to the entire create-medusa-app package to not disrupt and expand the scope for which the purpose was to introduce the plugin scaffolding capabilities

**Addition**
- medusa project will get their package.json name changed to the project name
- Remove build step from medusa project creation

**Plugin flow**

- in the plugin
  - `npx create-medsa-app --plugin`
  - `yarn dev`
- in the project
  - `yalc add plugin-name`
  - `yarn dev`

Any changes on the plugin will publish, push in the local registry which will fire the hot reload of the app and include the new changes from the plugin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants