Dev-Tools for Java Projects

Development tooling for Java projects, including Checkstyle linting, Java method and REST API inventories, test-coverage analysis, and Maven dependency inventory.

Contents

• Requirements
• Setup
• Changed-Line Java Linter
• Using pre-commit
• Java Method Inventory
• REST API Inventory
• Test Coverage Analysis
• Maven Dependency Inventory
• Command Reference
• Checkstyle
• Development & Contribution
• Packaging

Requirements

• Python 3
• Git
• JDK (java, javac, and jar)
• Maven (mvn)

Setup

Initialize the project dependencies and build the inventory components:

python java_inventory.py setup

Run setup before using the analysis and linting commands.

---

1. Changed-Line Java Linter

The lint command runs Checkstyle against Java code changed in Git.

For modified files, only violations on changed lines are reported. Newly added files are checked as a whole.

Basic usage

Check unstaged working-tree changes:

python java_inventory.py lint .

Check staged changes:

python java_inventory.py lint . --cached

Include untracked Java files:

python java_inventory.py lint . --include-untracked

Show the changed Java files and lines without running Checkstyle:

python java_inventory.py lint . --no-checkstyle

Enable debug logging:

python java_inventory.py --debug lint .

How changes are handled

Change	Lint behavior
Modified Java file	Check only violations on changed lines
Added Java file	Check the entire file
Untracked Java file with --include-untracked	Check the entire file
Non-Java file	Ignored

For example:

warning: src/main/java/example/Foo.java:15:5: Missing a Javadoc comment. [MissingJavadocMethod]
warning: src/main/java/example/Foo.java:17:5: 'isValid' has incorrect indentation level 4, expected level should be 12. [Indentation]
error: src/main/java/example/Bar.java:8:48: java.lang.IllegalStateException: mismatched input '{' expecting ')'

info: checkstyle summary: 1 error(s), 2 warning(s).

Lint options

Option	Description
--cached	Analyze staged changes instead of unstaged working-tree changes
--include-untracked	Include untracked Java files and check them as whole files
--no-checkstyle	Print changed Java files and lines without running Checkstyle
--debug	Show internal commands and debug logging

--debug is a global option and must appear before the subcommand:

python java_inventory.py --debug lint .

Using lint as a Git pre-commit hook

For a normal Git hook, lint the staged snapshot.

Create .git/hooks/pre-commit:

#!/bin/sh

python java_inventory.py lint . --cached

Make it executable:

chmod +x .git/hooks/pre-commit

The --cached flag is important because a commit contains the staged version of the files, not arbitrary unstaged working-tree changes.

To bypass the hook for a commit:

git commit --no-verify

---

2. Using pre-commit

The same lint command can be integrated with the Python pre-commit framework.

Install pre-commit:

python -m pip install pre-commit

Add the following to .pre-commit-config.yaml:

repos:
  - repo: local
    hooks:
      - id: java-inventory-lint
        name: Java Inventory Checkstyle
        entry: python java_inventory.py lint . --cached
        language: unsupported
        pass_filenames: false
        always_run: true

Install the Git hook:

pre-commit install

Or install the hook and its environments:

pre-commit install --install-hooks

Run the lint hook manually:

pre-commit run java-inventory-lint

Run it against all files known to pre-commit:

pre-commit run java-inventory-lint --all-files

The hook uses pass_filenames: false because java_inventory.py determines the changed files itself from Git.

---

3. Java Method Inventory

Generate an inventory of Java methods:

python java_inventory.py inventory-method dev-test/src/main

Write the inventory to a specific file:

python java_inventory.py inventory-method dev-test/src/main \
    --output build/methods.csv

---

4. REST API Inventory

Generate a CSV inventory of REST APIs:

python java_inventory.py inventory-rest-api dev-test/src/main

By default, the report is written to:

rest_apis.csv

Specify a different output file:

python java_inventory.py inventory-rest-api dev-test/src/main \
    --output build/rest_apis.csv

---

5. Test Coverage Analysis

Generate the test-coverage report:

python java_inventory.py test-coverage \
    dev-test/src/main \
    dev-test/src/test

By default, the report is written to:

test_coverage_report.html

Specify a different output file:

python java_inventory.py test-coverage \
    dev-test/src/main \
    dev-test/src/test \
    --output build/test_coverage_report.html

---

6. Maven Dependency Inventory

Generate an inventory of Maven dependencies:

python java_inventory.py inventory path/to/project

The inventory includes:

• Module
• Group ID
• Artifact ID
• Declared version
• Resolved version
• Scope
• Direct/transitive dependency
• Optional dependency

By default, dependency information is printed to the terminal.

Write a CSV report:

python java_inventory.py inventory path/to/project \
    --output build/dependencies.csv

Write a JSON report:

python java_inventory.py inventory path/to/project \
    --output build/dependencies.json \
    --format json

Maven projects are currently supported. Gradle projects are detected but are not supported yet.

The Maven dependency graph is resolved by the Java Maven resolver. Python handles the CLI integration and report formatting.

---

Command Reference

python java_inventory.py [--debug] <command>

Commands

Command	Purpose
setup	Initialize dependencies and build inventory components
lint	Run Checkstyle on changed Java code
inventory-method	Generate a Java method inventory
inventory-rest-api	Generate a REST API inventory CSV
test-coverage	Generate the test-coverage report
inventory	Generate a Maven dependency inventory

Show command help:

python java_inventory.py --help

Show help for a specific command:

python java_inventory.py lint --help

python java_inventory.py inventory-method --help

python java_inventory.py inventory-rest-api --help

python java_inventory.py test-coverage --help

python java_inventory.py inventory --help

Checkstyle

The linter uses the project's Checkstyle configuration and custom Checkstyle checks:

resources/style_guide.xml
resources/checkstyle-12.3.0-all.jar
checkstyle/target/checkstyle-inventory-0.1.0-SNAPSHOT.jar

Run setup first if the Checkstyle or Maven inventory components have not been built.

Development & Contribution

See CONTRIBUTING.md for development workflow and contribution guidelines.

Packaging

See PACKAGING.md for standalone builds, platform packaging, and release details