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

docs: update installation.md #955

Merged
merged 5 commits into from
Dec 19, 2024
Merged

docs: update installation.md #955

merged 5 commits into from
Dec 19, 2024

Conversation

s0h311
Copy link
Contributor

@s0h311 s0h311 commented Dec 8, 2024

… as regular dep

@sidebase/nuxt-auth should be installed as a regular dependency instead of a dev dependency. Also added additional scripts for yarn and pnpm

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

@sidebase/nuxt-auth should be installed as a regular dependecy instead of dev dependency. Also added pnpm and yarn script variants of npx nuxi@latest module add sidebase-auth

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

… as regular dep

@sidebase/nuxt-auth should be installed as a regular dependency instead of a dev dependency. Also added additional scripts for yarn and pnpm
@zoey-kaiser
Copy link
Member

@sidebase/nuxt-auth should be installed as a regular dependecy instead of dev dependency. Also added pnpm and yarn script variants of npx nuxi@latest module add sidebase-auth

This should not be the case. Any Nuxt module can be installed as a Dev Dependency. NextAuth needs to be installed as a regular dependency.

Did you have issues installing it as a dev dependency? If so could you please share some more information on this please? 😊

@zoey-kaiser zoey-kaiser added the documentation A change to the documentation label Dec 12, 2024
Comment on lines 26 to 34
npm i @sidebase/nuxt-auth
```

```bash [pnpm]
pnpm i -D @sidebase/nuxt-auth
pnpm i @sidebase/nuxt-auth
```

```bash [yarn]
yarn add --dev @sidebase/nuxt-auth
yarn add @sidebase/nuxt-auth
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please revert to the dev dependency so we can accept your other adjustment :)

Additionally - does the nuxi module add command work for you? There's #932 which reported it not functioning

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I reverted to dev dep. The nuxi module add sidebase-auth command works fine, although it installed an RC Version of @sidebase/nuxt-auth for me. I could submit an PR regarding that. It also installs it as a regular dependency, and it installs next-auth too. Which is not mentioned in the docs. Do we want to include it in the docs too?

Copy link
Collaborator

Choose a reason for hiding this comment

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

The rc installation was a small hiccup from our side which we fixed today, it should no longer be installed as latest, thanks for noticing it as well!
next-auth is a peer dep, it would very much depend on your package manager

Copy link
Contributor Author

@s0h311 s0h311 Dec 25, 2024

Choose a reason for hiding this comment

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

I use pnpm, and it did not install next-auth and I ran into some issues. Don't you think that it should be included in the docs anyway?

phoenix-ru
phoenix-ru previously approved these changes Dec 19, 2024
@phoenix-ru phoenix-ru changed the title docs: update installation.md, @sidebase/nuxt-auth should be installed… docs: update installation.md Dec 19, 2024
Copy link

pkg-pr-new bot commented Dec 19, 2024

Open in Stackblitz

npm i https://pkg.pr.new/@sidebase/nuxt-auth@955

commit: a498537

@phoenix-ru phoenix-ru merged commit 0d9ae7a into sidebase:main Dec 19, 2024
6 checks passed
@phoenix-ru
Copy link
Collaborator

Thanks for the PR :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants