Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
03012e8
WIP
jabrena Jun 29, 2025
db4fd3d
WIP
jabrena Jun 29, 2025
c0e5f7b
Merge branch 'main' into feature/spml
jabrena Jun 30, 2025
56c4c88
Initial works with the generator
jabrena Jun 30, 2025
9acfb05
Remove example system prompt XML file (#112)
jabrena Jun 30, 2025
873c1a2
Create test and review xml requirements (#113)
jabrena Jul 1, 2025
85ddcc1
Improving the solution
jabrena Jul 1, 2025
f31ea6a
Moving to spml
jabrena Jul 1, 2025
e868d72
Moving to spml
jabrena Jul 1, 2025
12584c2
New progress
jabrena Jul 2, 2025
f212f0e
Improved solution
jabrena Jul 2, 2025
59e2bbc
Adding a new rule
jabrena Jul 2, 2025
d12d817
new upgrade
jabrena Jul 2, 2025
86ff442
Nice modelling for 100-java-checklist-guide
jabrena Jul 2, 2025
87670db
Tested improvement from spml generation
jabrena Jul 2, 2025
516014c
Not required
jabrena Jul 2, 2025
0387543
Minor change in changelog
jabrena Jul 2, 2025
61ccfc4
Create XSD and update validation processes (#118)
jabrena Jul 3, 2025
a6b0235
Improving syntax
jabrena Jul 3, 2025
2172ece
Develop XML for cursor rules and tests (#123)
jabrena Jul 3, 2025
b83ed4d
Minor change
jabrena Jul 3, 2025
00d9649
Adding new files to generate the XML
jabrena Jul 3, 2025
916a817
Upgrade Java and create strict tests (#126)
jabrena Jul 3, 2025
9a3a873
Adding new rules to generate the associated xml
jabrena Jul 3, 2025
49680da
Add XML rules and strict tests (#127)
jabrena Jul 3, 2025
18ec740
Minor changes
jabrena Jul 3, 2025
87ced2d
New improvement
jabrena Jul 3, 2025
7b5d640
New progress
jabrena Jul 3, 2025
f1cf12a
New file converted
jabrena Jul 4, 2025
afaefe4
Improved generation
jabrena Jul 5, 2025
c14746a
Improved generation
jabrena Jul 5, 2025
b1310c1
Improving tests
jabrena Jul 5, 2025
e00f170
Renaming schema and xslt
jabrena Jul 5, 2025
89725d2
Adding the behaviour to migrate rules from spml to ./cursor/rules
jabrena Jul 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 14 additions & 35 deletions .cursor/rules/100-java-checklist-guide.mdc
Original file line number Diff line number Diff line change
@@ -1,57 +1,36 @@
---
description: Create a Checklist with all Java steps to use with cursor rules for Java
globs:
description:
globs:
alwaysApply: false
---
# Create a Checklist with all Java steps to use with cursor rules for Java

You are an expert in Java programming language and technical documentation. Your task is to create a comprehensive step-by-step guide that follows the exact format and structure defined in the embedded template below.
## System prompt characterization

## Context
You have access to a set of cursor rules that java development. You need to create a structured guide that helps new users navigate through the entire set of java cursor rules.
Role definition: You are a Senior software engineer with extensive experience in Java programming language and technical documentation

## Description

Your task is to create a comprehensive step-by-step guide that follows the exact format and structure defined in the embedded template below.

## Instructions for AI

## Template Structure (Self-Contained)
Create a markdown file named `JAVA-DEVELOPMENT-GUIDE.md` with the following exact structure: [java-checklist-template.md](mdc:.cursor/rules/templates/java-checklist-template.md)

## CRITICAL: Strict Template Adherence
**MANDATORY REQUIREMENT**: Follow the embedded template EXACTLY - do not add, remove, or modify any steps, sections, or cursor rules that are not explicitly shown in the template.
### Restrictions

**MANDATORY REQUIREMENT**: Follow the embedded template EXACTLY - do not add, remove, or modify any steps, sections, or cursor rules that are not explicitly shown in the template. ### What NOT to Include:

### What NOT to Include:
- **DO NOT** add framework-specific rules (Spring Boot @301, REST API @304, Quarkus @401, etc.) unless they appear in the template
- **DO NOT** create additional steps beyond what's shown in the template
- **DO NOT** modify the numbering system or step structure from the template
- **DO NOT** add cursor rules that are not explicitly listed in the embedded template
- **DO NOT** expand or elaborate on sections beyond what the template shows

### Template Boundaries:
- **ONLY** use cursor rules that appear in the embedded template
- **ONLY** create the exact number of steps shown in the template (should be 6 steps, not more)
- **ONLY** use the exact wording and structure from the template
- **ONLY** include cursor rules explicitly present in the template reference table
- If a cursor rule exists in the workspace but is not in the template, **DO NOT** include it

## Instructions for AI
1. **Follow the exact format** shown in the template above
2. **Use the specific numbering system** (1.1, 1.2, etc.) as shown
3. **Include all the bash commands exactly** as specified in the template
4. **Maintain the checkbox structure** for progress tracking
5. **Keep all notes and warnings** from the original PROMPTS.md format
6. **Add the reference table and best practices** as shown in the template
7. **Make it self-contained** - no external references needed

## Pre-Generation Validation Checklist
Before generating the guide, verify:
- [ ] All steps match the template exactly (no more, no less)
- [ ] All cursor rules included are present in the template's reference table
- [ ] No additional framework-specific rules added beyond template scope
- [ ] Step numbering system matches template structure
- [ ] Progress tracking section mirrors template format
- [ ] Tips & Best Practices section uses template content only

## Output Requirements

- Generate the complete markdown file following the embedded template exactly
- Include all sections: Prerequisites, Process Overview, Reference Table, Tips, Progress Tracking
- Use proper markdown formatting with headers, code blocks, tables, and checklists
- Ensure the guide is beginner-friendly but comprehensive
- Make it portable to any repository without dependencies
- **VERIFY**: Final output contains ONLY what appears in the embedded template
36 changes: 36 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# EditorConfig is awesome: https://EditorConfig.org

# File generated by jbang setup@jabrena

# top-most EditorConfig file
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.html]
indent_style = space
indent_size = 4

[*.json]
indent_style = space
indent_size = 4

[*.xml]
indent_style = space
indent_size = 4

[*.java]
indent_style = space
indent_size = 4

[*.yml,*.yaml]
indent_style = space
indent_size = 2

[*.dsl]
indent_style = space
indent_size = 4
2 changes: 0 additions & 2 deletions .gitattributes

This file was deleted.

2 changes: 2 additions & 0 deletions .github/workflows/maven.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ jobs:
with:
distribution: 'graalvm' # See 'Supported distributions' for available options
java-version: '24'
- name: Generate Cursor Rules
run: cd spml && ./mvnw --batch-mode --no-transfer-progress verify --file pom.xml
- name: Maven build
run: cd examples/maven-demo && ./mvnw --batch-mode --no-transfer-progress verify --file pom.xml
- name: Spring Boot build
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
.DS_Store
tmp
target/
.idea/
.vscode/
*.log
.classpath
2 changes: 2 additions & 0 deletions .sdkmanrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
java=24.0.1-graalce
maven=3.9.10
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.7.0] - 2025-06-30
## [0.7.0] 2025-06-30

### Added

- **Java Profiling Support**: Added comprehensive profiling cursor rules (#81, #88, #91)
- `@161-java-profiling-detect` for detecting performance issues
- `@162-java-profiling-analyze` for analyzing profiling results
- `@162-java-profiling-analyze` for analyzing profiling results
- `@164-java-profiling-compare` for comparing profiling data
- **Java Checklist Guide**: Added `@100-java-checklist-guide` cursor rule to help developers use cursor rules effectively (#59)
- **Maven Documentation**: Added `@112-java-maven-documentation` cursor rule to generate README-DEV.md from existing pom.xml files
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ If you have new ideas to improve any of the current Cursor rules or add a new on
## Cursor rules ecosystem

- https://github.com/jabrena/101-cursor
- https://github.com/jabrena/spml
- https://github.com/jabrena/cursor-rules-methodology
- https://github.com/jabrena/cursor-rules-agile
- https://github.com/jabrena/cursor-rules-java
Expand Down
33 changes: 33 additions & 0 deletions examples/quarkus-demo/README-DEV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Essential Maven Goals:

```bash
# Analyze dependencies
./mvnw dependency:tree
./mvnw dependency:analyze
./mvnw dependency:resolve

./mvnw clean validate -U
./mvnw buildplan:list-plugin
./mvnw buildplan:list-phase
./mvnw help:all-profiles
./mvnw help:active-profiles
./mvnw license:third-party-report

# Clean the project
./mvnw clean

# Clean and package in one command
./mvnw clean package

# Run integration tests
./mvnw verify

# Check for dependency updates
./mvnw versions:display-property-updates
./mvnw versions:display-dependency-updates
./mvnw versions:display-plugin-updates

# Generate project reports
./mvnw site
jwebserver -p 8005 -d "$(pwd)/target/site/"
```
Empty file added spml/.mvn/jvm.config
Empty file.
Empty file added spml/.mvn/maven.config
Empty file.
19 changes: 19 additions & 0 deletions spml/.mvn/wrapper/maven-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
wrapperVersion=3.3.2
distributionType=only-script
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.10/apache-maven-3.9.10-bin.zip
Loading
Loading