feat: add environment variables validation

[piotrski]

Add runtime environment variables validation

• I reviewed linter warnings + errors, resolved formatting, types and other issues related to my work
• The PR title follows the convention we established conventional-commit
• I performed a functional test on my final commit

---

In #140 @KATT suggested adding runtime environment variables validation using zod. Since env.js is imported inside next.config.js it can't ba a typescript file. There are two templates for env.js, one for just prisma env-prisma.js and another one for prisma + next-auth env-prisma-auth.js

---

Screenshots

💯

[KATT]

On my phone, but think you should add something to the tsconfig too in order to get the file validated with ts ☺

[Fedeorlandau]

Hi there! Please remember to update the PR title so we get it on the changelog.

feat: add environment variables validation

Cheers!

[piotrski]

On my phone, but think you should add something to the tsconfig too in order to get the file validated with ts ☺

I've added **/*.js to tsconfig.

[piotrski]

Hi there! Please remember to update the PR title so we get it on the changelog.

feat: add environment variables validation

Cheers!

Should I change it to something else?

[Fedeorlandau]

Hi there! Please remember to update the PR title so we get it on the changelog.
feat: add environment variables validation
Cheers!

Should I change it to something else?

It's perfect now! Thanks

Quick question, what happens when just "next-auth + trpc" or just "next-auth" is enabled?

[piotrski]

Hi there! Please remember to update the PR title so we get it on the changelog.
feat: add environment variables validation
Cheers!

Should I change it to something else?

It's perfect now! Thanks

Quick question, what happens when just "next-auth + trpc" or just "next-auth" is enabled?

I am thinking of adding the boilerplate env.js to the base and overwriting when installing more packages this way we can just import it into the base next.config.js

[t3dotgg]

I do really like this

[juliusmarminge]

The only problem with this as it stands, is that it would make the initial app fail to build because of the example .env not following this validation-schema.

I just added a CI step that builds the default t3-app and this would fail if we do not include a better .env by default that can be parsed with this validation.

[juliusmarminge]

There are two templates for env.js, one for just prisma env-prisma.js and another one for prisma + next-auth env-prisma-auth.js

Also include one for just NextAuth.js env-auth.js to cover all the cases.

[piotrski]

I've moved schema to env-schema.js to keep the code DRY and added env validation to the base template. Now addons are just need to override env-schema.js. I've tested base config, prisma, prisma + auth, auth, auth + trpc

[juliusmarminge]

I like this. Left some comments. As for the concern in my comment previously, would this prevent the app from building if the .env schema is not valid or is it just runtime?

EDIT: looks like the CI answered my question. Should we also include a .env that can be validated or what are your thoughts on this?

> [email protected] build /home/runner/work/create-t3-app/ci-test-app
[8](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:9)
> next build
[9](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:10)
[10](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:11)
❌ Invalid environment variables:
[11](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:12)
 DATABASE_URL: Required
[12](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:13)
 NEXTAUTH_SECRET: Required
[13](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:14)
 NEXTAUTH_URL: Required
[14](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:15)
 GITHUB_ID: Required
[15](https://github.com/t3-oss/create-t3-app/runs/7252027908?check_suite_focus=true#step:8:16)
 GITHUB_SECRET: Required

[juliusmarminge]

Looks good! Update the branch and I'll merge

[piotrski]

Looks good! Update the branch and I'll merge

Updated 👍

[juliusmarminge]

Thank you 🙏!