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

Specify pnpm build in CONTRIBUTING.md? #5078

Closed
sato11 opened this issue Aug 3, 2022 · 1 comment
Closed

Specify pnpm build in CONTRIBUTING.md? #5078

sato11 opened this issue Aug 3, 2022 · 1 comment
Labels
documentation Relates to documentation fauna @auth/fauna-adapter prisma @auth/prisma-adapter triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime. typeorm-legacy

Comments

@sato11
Copy link
Contributor

sato11 commented Aug 3, 2022

What is the improvement or update you wish to see?

I'd like to propose that we specify pnpm build step in CONTRIBUTING.md.

Is there any context that might help us understand?

In the current version of the doc (v4.10.3, to be precise), it tells that pnpm dev starts the server and makes localhost:3000 available right away. However, /api/auth/[...nextauth] fails to compile on access, saying what I attach below:

./pages/api/auth/[...nextauth].ts:41:0
Module not found: Can't resolve '@next-auth/prisma-adapter'
  39 | // Adapters
  40 | import { PrismaClient } from "@prisma/client"
> 41 | import { PrismaAdapter } from "@next-auth/prisma-adapter"
  42 | import { Client as FaunaClient } from "faunadb"
  43 | import { FaunaAdapter } from "@next-auth/fauna-adapter"
  44 | import { TypeORMLegacyAdapter } from "@next-auth/typeorm-legacy-adapter"

https://nextjs.org/docs/messages/module-not-found

Just running pnpm build fixed it for me (which I hope is what you are expecting), but the answer wasn't pretty easy for me to find. Partly that's only because I'm not used to using pnpm and the overall mono-repo concept of the "workspace", but I'm sure just adding one line in local setup section can be a great help to those who wish to try out the latest version of this project.

So I'm glad to see the change and would like to know what you think of it. Let me know if I'm missing or misunderstanding anything 🙂

Does the docs page already exist? Please link to it.

https://github.com/nextauthjs/next-auth/blob/next-auth%40v4.10.3/CONTRIBUTING.md

@sato11 sato11 added documentation Relates to documentation triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime. labels Aug 3, 2022
@github-actions github-actions bot added fauna @auth/fauna-adapter prisma @auth/prisma-adapter typeorm-legacy labels Aug 3, 2022
@balazsorban44
Copy link
Member

Thanks, but there is already a PR in the works for this: #4951 Ideally we would like to rebuild any packages in development, instead of relying on pnpm build on each change. As this is not related to the usage of the package, there is no need to open an issue about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation fauna @auth/fauna-adapter prisma @auth/prisma-adapter triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime. typeorm-legacy
Projects
None yet
Development

No branches or pull requests

2 participants