jhelm CLAUDE.md

CLAUDE.md - jhelm Project Guide

Project Overview

jhelm is a Java implementation of the Helm package manager for Kubernetes. It provides native Java libraries and tools to work with Helm charts without requiring the Go-based Helm CLI.

Tech Stack: Java 21, Spring Boot 4.0.5, Kubernetes Client 25.0.0, Picocli 4.7.7, Jackson YAML, Lombok

Project Structure

jhelm (parent)
├── jhelm-gotemplate/       — Go template engine (standalone, no Spring)
├── jhelm-gotemplate-sprig/ — Sprig function implementations (ServiceLoader, priority 100)
├── jhelm-gotemplate-helm/  — Helm function implementations (ServiceLoader, priority 200)
├── jhelm-core/             — Helm logic, charts, actions (depends on: gotemplate)
├── jhelm-kube/             — Kubernetes client integration (depends on: core)
├── jhelm-rest/             — REST API module
├── jhelm-plugin/           — Maven plugin for packaging
├── jhelm-cli/              — CLI entry point, Spring Boot + Picocli (depends on: core, kube)
├── jhelm-sample/           — Sample application
├── jhelm-rest-sample/      — REST sample application
└── docs/                   — Antora documentation (AsciiDoc)

Build & Test Commands

# Build the project
./mvnw clean install

# Run all tests
./mvnw test

# Run tests for a specific module
./mvnw test -pl jhelm-core

# Run a specific test class
./mvnw test -Dtest=KpsComparisonTest -pl jhelm-core

# Run a specific test method
./mvnw test -Dtest=KpsComparisonTest#testSimpleRendering -pl jhelm-core

Always run relevant tests after making code changes. Fix any test failures before committing.

Coding Standards

Style

• Indentation: Tabs (enforced by spring-javaformat-maven-plugin)
• Formatter: spring-javaformat runs on every validate phase — run ./mvnw spring-javaformat:apply to auto-format
• Naming: Classes PascalCase, methods/variables camelCase, constants UPPER_SNAKE_CASE
• Imports: Always use import statements — never use fully qualified class names inline in code (e.g., use Locale.ROOT not java.util.Locale.ROOT). Enforced by PMD UnnecessaryFullyQualifiedName rule. Fix script: python3 .claude/scripts/fix_fqn.py .
• Javadoc: Use HTML tags for links, {@code true}/{@code false} for booleans, accurate @param/@return tags