Skip to content

Add Quarkus framework rules#19

Open
pjgg wants to merge 1 commit into
sanjeed5:mainfrom
pjgg:chore/quarkus
Open

Add Quarkus framework rules#19
pjgg wants to merge 1 commit into
sanjeed5:mainfrom
pjgg:chore/quarkus

Conversation

@pjgg

@pjgg pjgg commented Oct 15, 2025

Copy link
Copy Markdown
  • Adding support for Quarkus Java Framework

Summary by CodeRabbit

  • New Features
    • Added Quarkus to the libraries catalog, enabling discovery and filtering under backend, framework, and Java categories.
  • Documentation
    • Introduced a comprehensive Quarkus best-practices guide covering project structure, dependency injection, configuration, data access, REST API design, security, testing, performance, and deployment.
  • Chores
    • Updated progress tracker to mark Quarkus as completed.
    • No changes to existing entries; this release is additive and non-breaking.

@coderabbitai

coderabbitai Bot commented Oct 15, 2025

Copy link
Copy Markdown

Walkthrough

Adds Quarkus as a new library in two rules JSON registries, introduces a new Quarkus MDC guidance document, and marks Quarkus as completed in the MDC generation progress JSON. No modifications to existing entries beyond these additions.

Changes

Cohort / File(s) Summary
Library registry updates
cursor-rules-cli/rules.json, rules.json
Added a new library entry: name "quarkus" with tags ["backend", "framework", "java"] to the libraries arrays.
MDC documentation
rules-mdc/quarkus.mdc
Added a new Quarkus best-practices document covering project structure, CDI, config, data access, REST, security, testing, performance, and deployment.
MDC progress tracking
src/mdc_generation_progress.json
Added top-level property "quarkus": "completed".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A twitch of ears, I flip a page—
Quarkus hops into our sage.
JSON fields all neatly seeded,
Docs abound where patterns’re needed.
Progress carrot: “completed,” gleamed—
A tidy burrow, as I dreamed.
Boing! New paths are cleanly streamed. 🥕📝

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title precisely describes the main change, which is adding Quarkus framework rules to the repository, and is concise and specific without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (4)
src/mdc_generation_progress.json (1)

242-244: Progress entries valid

JSON is valid (no trailing comma on last key). Suggest keeping future additions alphabetically grouped for readability, but not required.

rules-mdc/quarkus.mdc (3)

3-3: Tighten file globs

Consider removing clojure if unintended and include .yml variant.

-globs: **/*.java,**/*.kt,**/*.groovy,**/*.clj,**/application.properties,**/application.yaml,**/pom.xml,**/build.gradle
+globs: **/*.java,**/*.kt,**/*.groovy,**/application.properties,**/application.yaml,**/application.yml,**/pom.xml,**/build.gradle

183-186: Update observability guidance: prefer OpenTelemetry and Micrometer

OpenTracing is deprecated. Recommend OpenTelemetry for tracing and Micrometer for metrics; keep SmallRye Health.

-*   **MicroProfile Health, Metrics, and OpenTracing:** Implement MicroProfile Health, Metrics, and OpenTracing for monitoring and diagnostics.
+*   **Health, Metrics, and Tracing:** Use SmallRye Health for liveness/readiness, Micrometer for metrics, and OpenTelemetry for tracing (with the Quarkus OpenTelemetry extensions).

50-56: Enhance config guidance with @ConfigMapping

Add @ConfigMapping for structured, type-safe config groups (alongside @ConfigProperty).

 *   **Type-Safe Configuration:** Use `@ConfigProperty` for type-safe configuration injection.
+*   **Structured Config:** Prefer `@ConfigMapping` for grouping related properties into typed interfaces/records.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9983c8b and 1d60f89.

📒 Files selected for processing (4)
  • cursor-rules-cli/rules.json (1 hunks)
  • rules-mdc/quarkus.mdc (1 hunks)
  • rules.json (1 hunks)
  • src/mdc_generation_progress.json (1 hunks)
🔇 Additional comments (2)
rules.json (1)

1493-1500: Quarkus entry looks good and correctly tagged

Alphabetical placement between pytorch and qwik is correct; tags align with Spring/SpringBoot entries.

cursor-rules-cli/rules.json (1)

1493-1500: Public registry entry for Quarkus is consistent

Name/tags mirror root rules.json and ordering is correct.

Comment thread rules-mdc/quarkus.mdc
Comment on lines +112 to +113
* **Principle Propagation:** Ensure principle propagation across services when using microservices architecture.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Typo: “Principle” → “Principal” propagation

Security term is “principal propagation”.

-*   **Principle Propagation:** Ensure principle propagation across services when using microservices architecture.
+*   **Principal Propagation:** Ensure principal propagation across services when using microservices architecture.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* **Principle Propagation:** Ensure principle propagation across services when using microservices architecture.
* **Principal Propagation:** Ensure principal propagation across services when using microservices architecture.
🤖 Prompt for AI Agents
In rules-mdc/quarkus.mdc around lines 112 to 113, the term "Principle
Propagation" is a typo; replace "Principle" with the correct security term
"Principal" so the line reads "Principal Propagation: Ensure principal
propagation across services when using microservices architecture." Ensure
casing and punctuation remain consistent with surrounding entries.

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