Repository navigation
feat: add nuxt-neon module - #1712
AloisSeckar wants to merge 2 commits into
Conversation
|
No actionable comments were generated in the recent review.
 |
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title clearly identifies the main change: adding the nuxt-neon module. |
| Description check | |
The description explains the module, its main APIs, security controls, optional features, documentation, and demo. The optional linked issue section is absent, but no issue is required. |
| Docstring Coverage | |
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Finishing Touches
-
Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
📚 Description
Nuxt Neon is a wrapper around
@neondatabase/serverlessconnector to https://neon.com/ PostgreSQL database.In its core, it takes provided Nuxt runtime config variables to establish an instance of
neondriver and make it available viauseNeonDriver()driver server-side composable. The sensitive connection info is sealed on Nitro server.In additon, it is possible to utilize set of SQL wrappers instead of having to type each SQL query manually. For convenient client-side access without having to write your own server-side logic, it is also possible to enable Nitro server endpoint for each SQL wrapping operation and construct the queries on client side. Inputs are runtime checked and sanitized on the server before actually being sent do the database via the
neondriver. Parametrized queries are used to avoid malicious inputs. However, those client-side endpoints are disabled by default as a security measure and must be opted-in. It is even possible to send RAW sql queries to overcome possible gaps in custom wrappers, but it is again an opt-in and only explicitly set whitelisted queries are allowed.The module is deployed i.e. HERE
The API is more or less stable now, the custom wrappers may choke on more complicated SQL queries. I am also still not 100% happy with the client side security. But I feel like I reached the limit where I can develop on my own and I am seeking for feedback from potential real users. Any suggestions, feature requests or even roasting critics would be appreciated.
I am willing and ready to address any concerns before the module is worth being officially listed on Nuxt Module page.
Docs: https://nuxt-neon.netlify.app/