cui-project-setup

What problem does it solve?

Inconsistent project initialization, varying build configurations, and neglected quality tool setup can lead to technical debt, integration headaches, and delayed development. This Skill provides a standardized, repeatable process for setting up new CUI projects, ensuring a robust, high-quality, and maintainable foundation from day one, saving significant setup time.

Core Features & Use Cases

• Standardized Maven Setup: Guides the creation of pom.xml with parent POMs, semantic versioning, and essential build plugins (compiler, surefire, failsafe).
• Quality Tool Integration: Configures JaCoCo for code coverage (80% minimum), Spotbugs for static analysis, and Checkstyle for code style enforcement.
• Multi-Module Project Organization: Provides patterns for parent POMs, module aggregation, and shared dependency management.
• Initial Project Files: Ensures README.adoc, LICENSE, .gitignore, and package-info.java files are correctly set up.
• Use Case: When starting any new Java project (library, Quarkus app, or multi-module system), use this skill to automatically generate the correct Maven structure, integrate all quality gates, and set up initial documentation, allowing you to focus on core development.

Quick Start

Initialize New Java Library

1. Create directory structure
2. Create pom.xml with cui-parent
3. Set up package structure
4. Create package-info.java with @NullMarked
5. Add .gitignore
6. Create README.adoc
7. Add LICENSE file
8. Initialize Git repository
9. Verify build: mvn clean install

Set Up Quality Tools

1. Add jacoco-maven-plugin
2. Configure coverage thresholds (80%)
3. Add spotbugs-maven-plugin
4. Add maven-checkstyle-plugin
5. Create pre-commit profile
6. Verify: mvn clean verify -Ppre-commit,coverage