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

Modified the code so it follows the latest official Nuxt's Module Author Guide and bumped the medusa package version #32

Merged
merged 2 commits into from
Oct 25, 2023

Conversation

dimitrio-m
Copy link
Contributor

Modified the code so it follows the latest official Nuxt's Module Author Guide and bumped the medusa package version.

  • Updated the packages to recent versions recommended by the guide.
  • Updated the npm scripts accordingly.
  • Added a default tsconfig.json file for the playground client code.
  • Added a default tsconfig.json file for the playground server code.
  • Updated app.vue to follow linting rules.
  • Updated module.ts to use the import type declaration.
  • Added yarn run dev:prepare as a pre step to the prepack operation in the release script.
  • Bumped @medusajs/medusa-js to the latest version.

Types of changes

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

Hello @Baroshem as I said in the issue #31, I had a problem that seemed related to the npm package release. I tried to execute the module locally and it worked great, but I couldn't get it to work when importing the module as an npm package. I started to investigate and noticed that the module was not following the latest Nuxt Module Author Guide, so I updated the packages, added some default configuration to TypeScript that the builder needed and finally tested the module by uploading it to an npm registry (it was my first time doing that) and it worked. I imported the test package in the project that I had the issue with in the first place, and it was a success.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes (if not applicable, please state why)

I don't know if this changes are ok, or if we need to change another thing or do further testing (first time contributor here 😃 ). I tried executing the tests and they passed. I also tried to execute the playground example and it worked great. I also tried the package in the project that I had the problem in the first place and it worked there too.

…hor Guide.

- Updated the packages to recent versions recommended by the guide.
- Updated the npm scripts accordingly.
- Added a default tsconfig.json file for the playground client code.
- Added a default tsconfig.json file for the playground server code.
- Updated app.vue to follow linting rules.
- Updated module.ts to use the import type declaration.
- Added yarn run dev:prepare as a pre step to the prepack operation in the release script.
@vercel
Copy link

vercel bot commented Oct 24, 2023

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

Name Status Preview Comments Updated (UTC)
nuxt-medusa ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 24, 2023 11:52am

@Baroshem
Copy link
Collaborator

Baroshem commented Oct 24, 2023

Hey,

Thanks for this PR! I will review it and give you some hints :)

And I am pretty happy that you are contributing. Keep it going!

Copy link
Collaborator

@Baroshem Baroshem left a comment

Choose a reason for hiding this comment

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

One small comment to resolve :)

package.json Outdated
Comment on lines 2 to 3
"name": "@idealcodeio/nuxt-medusa-test",
"version": "0.4.6",
Copy link
Collaborator

Choose a reason for hiding this comment

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

issue: These changes are not needed, you can revert them :)

@dimitrio-m
Copy link
Contributor Author

One small comment to resolve :)

That's right! That was an oopsie, I forgot to change back the name when I uploaded it to the npm registry for testing. Let me do a commit to fix it.

@dimitrio-m dimitrio-m force-pushed the fix/follow-nuxt-author-guide branch from d50c133 to 1fcee89 Compare October 24, 2023 11:50
@dimitrio-m
Copy link
Contributor Author

Sorry I made a typo on the last commit

@Baroshem
Copy link
Collaborator

No worries Buddy. I am merging this PR and will release a new version soon! :)

@Baroshem Baroshem merged commit fe8d7c4 into nuxt-modules:main Oct 25, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants