Skip to content

CLAUDE.md

Latest commit

 

History

History
122 lines (95 loc) · 5.91 KB

CLAUDE.md

File metadata and controls

122 lines (95 loc) · 5.91 KB

dotCMS Development Guide

Project Structure

core/
├── dotCMS/                          # Main backend Java code
│   └── src/main/java/com/          # Java source files
├── core-web/                        # Frontend (Angular/Nx monorepo) → see core-web/CLAUDE.md
├── dotcms-integration/              # Integration tests
├── dotcms-postman/                  # Postman API tests
├── bom/application/pom.xml          # Dependency versions (ONLY place for versions)
├── parent/pom.xml                   # Plugin management
└── .github/workflows/               # CI/CD pipelines

Build & Test Commands

# Build (choose based on scope)
./mvnw install -pl :dotcms-core -DskipTests              # Simple core changes (~2-3 min)
./mvnw install -pl :dotcms-core --am -DskipTests          # Core + dependencies (~3-5 min)
./mvnw clean install -DskipTests                           # Full rebuild (~8-15 min)

# Test (⚠️ NEVER run full integration suite — 60+ min)
./mvnw verify -pl :dotcms-integration -Dcoreit.test.skip=false -Dit.test=MyTestClass        # Specific class
./mvnw verify -pl :dotcms-integration -Dcoreit.test.skip=false -Dit.test=MyTest#testMethod  # Specific method
./mvnw verify -pl :dotcms-postman -Dpostman.test.skip=false -Dpostman.collections=all       # Postman

# IDE Testing (fastest iteration)
just test-integration-ide     # Start PostgreSQL + Elasticsearch + dotCMS
just test-integration-stop    # Stop services when done

# Run
just dev-run                  # Start dotCMS in Docker with Glowroot
cd core-web && nx run dotcms-ui:serve   # Frontend dev server only

All test modules need explicit skip=false flags or tests are silently skipped.

Essential Java Patterns

import com.dotmarketing.util.Config;        // Config.getStringProperty("key", "default")
import com.dotmarketing.util.Logger;        // Logger.info(this, "message")
import com.dotmarketing.util.UtilMethods;   // UtilMethods.isSet(value)
UserAPI userAPI = APILocator.getUserAPI();   // Service access pattern

Critical Rules

  • Config/Logger only: Never System.out, System.getProperty, or System.getenv
  • Maven versions: Add to bom/application/pom.xml ONLY, never dotCMS/pom.xml
  • Java syntax: Java 11 compatible in core modules (Java 21 runtime, CLI exception)
  • Security: No hardcoded secrets, validate all input, never log sensitive data
  • REST @Schema: Must match actual return type — see REST API Guide
  • Frontend: See core-web/CLAUDE.md for Angular/TypeScript standards

Progressive Enhancement

When editing ANY code, improve incrementally:

  • Add missing generics: List<String> not List
  • Replace legacy: Logger.info() not System.out.println()
  • Modern Angular: @if not *ngIf, input() not @Input()
  • Add missing annotations: @Override, @Nullable

Tech Stack

  • Backend: Java 21 runtime, Java 11 syntax (core), Maven, Spring/CDI
  • Frontend: Angular 19+, Nx, PrimeNG, Tailwind CSS, Jest/Spectator — core-web/CLAUDE.md
  • Infrastructure: Docker, PostgreSQL, Elasticsearch, GitHub Actions

Documentation (Load On-Demand)

Core Architecture & Workflows

Backend Development (Java/Maven)

Frontend Development (Angular/TypeScript)

Testing

Infrastructure

Context Management

For Claude

  • Use this guide for always-available context
  • Load /docs/ files on-demand with Read tool
  • Use /clear between different work contexts

For Cursor

  • Project rules: .cursor/rules/ (.mdc files with globs); see .cursor/rules/README.md
  • Use @docs/path/file.md syntax for detailed patterns
  • Domain-specific rules load by file pattern (Java, Angular, tests, docs)

Documentation Maintenance

  • CLAUDE.md: Navigation hub + essential quick-reference only
  • /docs/: Full patterns by domain — single source of truth
  • .cursor/rules/: Short reminders with globs, link to /docs/
  • When patterns are missing: update the relevant /docs/{domain}/ file, not this file