JBCT Maven Plugin

Build integration for Java Backend Coding Technology - automated formatting and linting in your Maven build.

Overview

The JBCT Maven Plugin provides:

Installation

Add to your pom.xml:

<build>
    <plugins>
        <plugin>
            <groupId>org.pragmatica-lite</groupId>
            <artifactId>jbct-maven-plugin</artifactId>
            <version>0.4.6</version>
        </plugin>
    </plugins>
</build>

Goals

jbct:format

Format Java source files in-place to JBCT style.

mvn jbct:format

Behavior:

• Processes all Java files in src/main/java
• Modifies files in-place
• Reports files that were formatted

Example output:

[INFO] Formatting src/main/java/com/example/Email.java
[INFO] Formatting src/main/java/com/example/Password.java
[INFO] Formatted 2 files

jbct:format-check

Check formatting without modifying files. Fails if any file needs formatting.

mvn jbct:format-check

Behavior:

• Checks all Java files in src/main/java
• Does not modify files
• Exits with error if files need formatting
• Ideal for CI/CD pipelines

Example output (success):

[INFO] All 47 files are properly formatted

Example output (failure):

[ERROR] 3 files need formatting:
[ERROR]   src/main/java/com/example/Email.java
[ERROR]   src/main/java/com/example/Password.java
[ERROR]   src/main/java/com/example/User.java

jbct:lint

Run JBCT lint rules (37 rules) against source files.

mvn jbct:lint

Behavior:

• Checks all Java files against JBCT rules
• Reports violations with severity levels
• Exits with error if ERROR-level violations found

Example output:

[INFO] Linting src/main/java...
[ERROR] src/main/java/com/example/User.java:15
        JBCT-RET-04: Use Unit instead of Void
[WARNING] src/main/java/com/example/Email.java:23
          JBCT-STY-01: Prefer fluent failure: cause.result() not Result.failure(cause)
[INFO] 1 error, 1 warning

jbct:check

Combined format-check and lint (recommended for CI).

mvn jbct:check

Behavior:

• Runs format-check first
• Then runs lint
• Fails if either reports issues
• Single goal for complete JBCT compliance

Example output:

[INFO] --- jbct:check ---
[INFO] Checking formatting...
[INFO] All 47 files are properly formatted
[INFO] Running lint rules...
[INFO] All checks passed

jbct:collect-slice-deps

Collect API dependencies for Aether slice projects.

mvn jbct:collect-slice-deps

Behavior:

• Scans slice dependencies
• Collects API interfaces
• Prepares for slice compilation

jbct:verify-slice

Validate Aether slice project configuration.

mvn jbct:verify-slice

Behavior:

• Checks pom.xml for required properties
• Verifies slice API properties exist
• Validates manifest entries

Binding to Build Lifecycle

Recommended Setup

Bind the check goal to automatically run during mvn verify:

<plugin>
    <groupId>org.pragmatica-lite</groupId>
    <artifactId>jbct-maven-plugin</artifactId>
    <version>0.4.6</version>
    <executions>
        <execution>
            <id>check</id>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Now mvn verify (and mvn install, mvn deploy) automatically runs JBCT checks.

Format on Build

Auto-format during compilation:

<executions>
    <execution>
        <id>format</id>
        <phase>process-sources</phase>
        <goals>
            <goal>format</goal>
        </goals>
    </execution>
</executions>

Multiple Goals

Combine formatting and checking:

<executions>
    <execution>
        <id>format</id>
        <phase>process-sources</phase>
        <goals>
            <goal>format</goal>
        </goals>
    </execution>
    <execution>
        <id>check</id>
        <phase>verify</phase>
        <goals>
            <goal>check</goal>
        </goals>
    </execution>
</executions>

Configuration

Plugin Configuration

<plugin>
    <groupId>org.pragmatica-lite</groupId>
    <artifactId>jbct-maven-plugin</artifactId>
    <version>0.4.6</version>
    <configuration>
        <!-- Skip JBCT processing -->
        <skip>false</skip>

        <!-- Include test sources -->
        <includeTests>false</includeTests>
    </configuration>
</plugin>

Configuration Options

Skipping via Command Line

# Skip JBCT for single run
mvn verify -Djbct.skip=true

jbct.toml Configuration

The Maven plugin reads configuration from jbct.toml in your project root. All formatting and linting settings are shared between CLI and Maven plugin.

Create jbct.toml:

[format]
maxLineLength = 120
indentSize = 4
alignChainedCalls = true

[lint]
failOnWarning = false
businessPackages = ["**.usecase.**", "**.domain.**"]
slicePackages = ["**.usecase.**"]  # Required for JBCT-SLICE-01

[lint.rules]
JBCT-RET-01 = "error"
JBCT-STY-01 = "warning"
JBCT-LOG-01 = "off"

CI Integration

GitHub Actions

name: Build

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          java-version: '25'
          distribution: 'temurin'
          cache: maven

      - name: Build and Verify
        run: mvn verify -B

With the plugin bound to the verify phase, mvn verify automatically runs all JBCT checks.

GitLab CI

build:
  image: maven:3.9-eclipse-temurin-25
  script:
    - mvn verify -B
  cache:
    paths:
      - .m2/repository

Jenkins Pipeline

pipeline {
    agent {
        docker { image 'maven:3.9-eclipse-temurin-25' }
    }
    stages {
        stage('Build') {
            steps {
                sh 'mvn verify -B'
            }
        }
    }
}

Common Patterns

Development Workflow

# Format code before commit
mvn jbct:format

# Check everything
mvn verify

Pre-commit Hook

Create .git/hooks/pre-commit:

#!/bin/bash
mvn jbct:format-check -q
if [ $? -ne 0 ]; then
    echo "JBCT format check failed. Run 'mvn jbct:format' to fix."
    exit 1
fi

IDE Integration

Configure your IDE to run mvn jbct:format on save or use the JBCT CLI directly:

jbct format src/main/java

Lint Rules Reference

The Maven plugin uses the same 37 lint rules as the CLI. See CLI Tooling for the complete reference.

Rule Categories

Suppressing Rules with @SuppressWarnings

Use standard Java @SuppressWarnings annotation to suppress JBCT rules:

// Suppress single rule
@SuppressWarnings("JBCT-RET-01")
public void legacyMethod() {
    // This method won't trigger JBCT-RET-01
}

// Suppress multiple rules
@SuppressWarnings({"JBCT-RET-01", "JBCT-LAM-02"})
public void anotherMethod() {
    // Won't trigger either rule
}

// Suppress all JBCT rules
@SuppressWarnings("all")
public class LegacyAdapter {
    // No JBCT rules checked in this class
}

Scope: Suppression applies to the annotated element and its children:

• On class → suppresses for entire class (all methods)
• On method → suppresses for that method only

Troubleshooting

Plugin Not Found

Ensure you have access to Maven Central:

<pluginRepositories>
    <pluginRepository>
        <id>central</id>
        <url>https://repo.maven.apache.org/maven2</url>
    </pluginRepository>
</pluginRepositories>

Java Version Issues

JBCT requires Java 25+:

<properties>
    <maven.compiler.source>25</maven.compiler.source>
    <maven.compiler.target>25</maven.compiler.target>
</properties>

Format vs Check Mismatch

If format-check fails but format shows no changes, ensure:

• Same Java version in CLI and Maven
• Same jbct.toml configuration
• No IDE auto-formatting conflicts

Requirements

• Java 25+
• Maven 3.9+

Resources

• AI Tools - Claude Code integration
• CLI Tools - Command-line usage
• JBCT Coding Guide - Complete technical reference
• GitHub Repository

Support

If you find this useful, consider sponsoring.

License

Apache 2.0