cursor-rules-java/spml/src/main/resources/112-java-maven-documentation.xml at c8c603aa313472dfacba5529bfc4bcd3082f2a49 · jabrena/cursor-rules-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?xml version="1.0" encoding="UTF-8"?>
<system-prompt xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:noNamespaceSchemaLocation="system-prompt.xsd"
               id="112-java-maven-documentation" version="1.0">
    <metadata>
        <description>Create README-DEV.md with information about how to use the Maven project</description>
        <globs>pom.xml</globs>
        <always-apply>false</always-apply>
        <tags>
            <tag>maven</tag>
            <tag>java</tag>
            <tag>documentation</tag>
        </tags>
        <version>0.8.0</version>
    </metadata>

    <header>
        <title>Create README-DEV.md with information about how to use the Maven project</title>
    </header>

    <system-characterization>
        <role-definition>You are a Senior software engineer with extensive experience in Java software development</role-definition>
    </system-characterization>

    <description>
        When creating a README-DEV.md file for a Maven project, include ONLY the following sections with the specified Maven goals. Do NOT add any additional sections, explanations, or content beyond what is explicitly listed below.
    </description>

    <content-sections>
        <template-section type="configuration">
            <template-header>
                <template-title>STRICT Structure for README-DEV.md (Template)</template-title>
            </template-header>
            <template-description>
                **IMPORTANT: Include ONLY the content specified below.**
            </template-description>
            <template-content>
                <code-block language="markdown">
# 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/"
```

**END OF TEMPLATE - DO NOT ADD ANYTHING BEYOND THIS POINT**
                </code-block>
            </template-content>
        </template-section>
    </content-sections>
</system-prompt>