Allow configuring module at runtime using environment variables

michael-bouvy commented 1 year ago

Allow configuring Nuxt Prismic module at runtime using environment variables, i.e. NUXT_PUBLIC_PRISMIC_ENDPOINT=my-repository-name.

⚠️ In src/module.ts line 156, endpoint is fetched from non-resolved config. Not sure about how to workaround this.

Types of changes

[ ] Chore (a non-breaking change which is related to package maintenance)
[ ] Bug fix (a non-breaking change which fixes an issue)
[ ] New feature (a non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to change)

Resolves: #183

[x] My change requires an update to the official documentation.
[ ] All TSDoc comments are up-to-date and new ones have been added where necessary.
[ ] All new and existing tests are passing.

lihbr commented 1 year ago

OK, I made some minor tweaks:

Explicitly declared defu as a dependency
Fixed a typo on the type declaration: @nuxt/schema
Moved the script injection to the plugin so that it can be reactive to the env variable change
Updated tests

I tested the script injection part with a bit of everything (SSR/no SSR, dev, build, and generate), I think it should be good(?)

May I ask you to double-check/review changes on your end too? If everything's good I'm happy to merge and release today 🎉

michael-bouvy commented 1 year ago

Looks great to me, thanks @lihbr !

lihbr commented 1 year ago

Thank you so much again for your contribution!