pom-ordering

Maven POM Dependency Ordering

Running the check

Check the pom.xml files with local modifications (git status --porcelain -- '*pom.xml'), or all of them when none are modified. Report every violation, naming the file and the out-of-place dependency.

Ordering Rules

Group dependencies by scope (compile, runtime, test), then within each scope by groupId in this order, top to bottom:

• First-party (${project.groupId} or modules within the project)
• cool.klass
• io.liftwizard
• org.eclipse.collections
• io.dropwizard
• Other third-party libraries
• Jakarta

Region Comment Structure

Use region comments for each groupId+scope combination:

• <!--region Project compile dependencies -->
• <!--region Project runtime dependencies -->
• <!--region Klass compile dependencies -->
• <!--region Klass runtime dependencies -->
• <!--region Liftwizard compile dependencies -->
• <!--region Liftwizard runtime dependencies -->
• <!--region Compile dependencies --> (for other dependencies)
• <!--region Runtime dependencies -->
• <!--region Test dependencies -->

Close each region with <!--endregion [name] -->

Nested regions within some groups:

• For io.liftwizard runtime: <!--region Liftwizard bundles --> then <!--region Liftwizard config-->
• For io.dropwizard: core modules first, then specialized modules

Example Structure

<dependencies>

    <!--region Project compile dependencies -->
    <dependency>
        <groupId>${project.groupId}</groupId>
        <artifactId>example-services</artifactId>
        <version>${project.version}</version>
    </dependency>
    <!--endregion-->

    <!--region Project runtime dependencies -->
    <dependency>
        <groupId>${project.groupId}</groupId>
        <artifactId>example-domain-model</artifactId>
        <version>${project.version}</version>
        <scope>runtime</scope>
    </dependency>
    <!--endregion-->

    <!--region Liftwizard runtime dependencies -->
    <dependency>
        <groupId>io.liftwizard</groupId>
        <artifactId>liftwizard-graphql-reladomo-meta</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!--region Liftwizard bundles -->
    <dependency>
        <groupId>io.liftwizard</groupId>
        <artifactId>liftwizard-bundle-cors</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!--endregion-->

    <!--region Liftwizard config-->
    <dependency>
        <groupId>io.liftwizard</groupId>
        <artifactId>liftwizard-config-logging-logstash-console</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!--endregion-->
    <!--endregion-->

    <!--region Test dependencies -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter</artifactId>
        <scope>test</scope>
    </dependency>
    <!--endregion-->

</dependencies>