Skip to content

feat: add nuxt-keycloak-oidc module#1443

Open
Nessiahs wants to merge 7 commits intonuxt:mainfrom
Nessiahs:feat/nuxt-keycloak-oidc
Open

feat: add nuxt-keycloak-oidc module#1443
Nessiahs wants to merge 7 commits intonuxt:mainfrom
Nessiahs:feat/nuxt-keycloak-oidc

Conversation

@Nessiahs
Copy link
Copy Markdown

@Nessiahs Nessiahs commented Apr 7, 2026

🚀 New module: nuxt-keycloak-oidc

Adds a focused Keycloak integration for Nuxt with full SSR support.

✨ Features

  • Keycloak authentication via OpenID Connect (OIDC)
  • SSR-first design
  • Automatic Keycloak discovery
  • Global middleware integration (no custom middleware required)
  • Built-in debugging support

🎯 Motivation

Most existing OIDC solutions are generic and require custom middleware or complex setup.

This module focuses specifically on:

➡️ Keycloak + Nuxt + SSR
➡️ minimal configuration
➡️ no custom middleware required

🧩 Why this module?

Keycloak integration in Nuxt often requires manual middleware and custom setup.

This module simplifies the process by handling authentication automatically using Nuxt's middleware system.

📦 Links

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: aad0deae-86f9-4490-abc4-0eb9c95d6048

📥 Commits

Reviewing files that changed from the base of the PR and between b28db0d and e768d98.

📒 Files selected for processing (1)
  • modules/nuxt-keycloak-oidc.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • modules/nuxt-keycloak-oidc.yml

📝 Walkthrough

Walkthrough

Added a new manifest file modules/nuxt-keycloak-oidc.yml containing static metadata for the nuxt-keycloak-oidc Nuxt module. The YAML records the module name, SSR-first Keycloak authentication description, repository and npm identifiers, empty icon, project links (GitHub, website, learn_more), category (Security), type (3rd-party), a single maintainer (Konstantin Kroner, GitHub: Nessiahs), and compatibility requiring Nuxt >=4.0.0 with an empty requires object. No executable code or public API declarations were changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: add nuxt-keycloak-oidc module' accurately describes the main change: adding a new module metadata file for nuxt-keycloak-oidc.
Description check ✅ Passed The description is directly related to the changeset, providing features, motivation, and links for the nuxt-keycloak-oidc module being added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@modules/nuxt-keycloak-oidc.yml`:
- Line 6: The YAML `category` value is using wrong casing; update the `category`
field in modules/nuxt-keycloak-oidc.yml from `security` to the allowed
`Security` value to match the enum in lib/categories.ts, and verify there are no
other category entries in this file using incorrect casing.
- Around line 1-6: The manifest is missing required ModuleInfo fields; update
the YAML (module name nuxt-keycloak-oidc) to include at minimum the keys github,
website, learn_more, type, maintainers, and compatibility to satisfy the
ModuleInfo contract (lib/types.ts:30-53); set github to the repo URL
(Nessiahs/nuxt-keycloak-oidc), provide a website/learn_more URL, specify type
(e.g., "module"), add a maintainers array with at least one maintainer object,
and fill compatibility/requires with Nuxt/bridge compatibility metadata (note:
requires is for Nuxt compatibility, not npm deps).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 92c6e523-274d-433d-826e-120a395ba462

📥 Commits

Reviewing files that changed from the base of the PR and between da52820 and 19e7b9d.

📒 Files selected for processing (1)
  • modules/nuxt-keycloak-oidc.yml

Comment thread modules/nuxt-keycloak-oidc.yml Outdated
Comment thread modules/nuxt-keycloak-oidc.yml Outdated
@Nessiahs
Copy link
Copy Markdown
Author

Nessiahs commented Apr 7, 2026

It looks like the CI failure is unrelated to this module (global sync issue).
Happy to adjust anything if needed 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant