Démarrage rapide

# Cloner uniquement le dossier examples/sample-basic
git clone --depth 1 --filter=blob:none --sparse \
  https://github.com/hexaglue/hexaglue.git hexaglue-sample
cd hexaglue-sample
git sparse-checkout set examples/sample-basic
cd examples/sample-basic

# Lancer le build
mvn clean verify

mon-projet/
├── pom.xml
└── src/main/java/com/example/
    ├── domain/
    │   ├── Task.java
    │   └── TaskId.java
    └── ports/
        ├── in/
        │   └── TaskUseCases.java
        └── out/
            └── TaskRepository.java

package com.example.domain;

import java.time.Instant;

/**
 * Task aggregate root.
 * Represents a task in a simple task management system.
 */
public class Task {

    private final TaskId id;
    private String title;
    private String description;
    private boolean completed;
    private final Instant createdAt;

    public Task(TaskId id, String title, String description) {
        this.id = id;
        this.title = title;
        this.description = description;
        this.completed = false;
        this.createdAt = Instant.now();
    }

    public TaskId getId() { return id; }
    public String getTitle() { return title; }
    public String getDescription() { return description; }
    public boolean isCompleted() { return completed; }
    public Instant getCreatedAt() { return createdAt; }

    /** Marks the task as completed. */
    public void complete() {
        this.completed = true;
    }

    /** Reopens a completed task. */
    public void reopen() {
        this.completed = false;
    }
}

package com.example.domain;

import java.util.UUID;

/**
 * Task identifier.
 * This is a value object wrapping the task's unique identifier.
 */
public record TaskId(UUID value) {

    public static TaskId generate() {
        return new TaskId(UUID.randomUUID());
    }

    public static TaskId fromString(String id) {
        return new TaskId(UUID.fromString(id));
    }
}

package com.example.ports.in;

import com.example.domain.Task;
import com.example.domain.TaskId;
import java.util.List;
import java.util.Optional;

/**
 * Primary port for task management use cases.
 * This is a driving port that defines the operations
 * available to external actors (UI, API, etc.).
 */
public interface TaskUseCases {

    Task createTask(String title, String description);

    Optional<Task> getTask(TaskId id);

    List<Task> listAllTasks();

    void completeTask(TaskId id);

    void deleteTask(TaskId id);
}

package com.example.ports.out;

import com.example.domain.Task;
import com.example.domain.TaskId;
import java.util.List;
import java.util.Optional;

/**
 * Secondary port for task persistence.
 * This is a driven port that defines the operations
 * the domain needs from the persistence layer.
 */
public interface TaskRepository {

    Task save(Task task);

    Optional<Task> findById(TaskId id);

    List<Task> findAll();

    void delete(Task task);
}

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                           http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>mon-projet</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <properties>
      <java.version>17</java.version>
      <maven.compiler.release>17</maven.compiler.release>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <build>
      <plugins>
          <!-- HexaGlue Maven Plugin -->
          <plugin>
              <groupId>io.hexaglue</groupId>
              <artifactId>hexaglue-maven-plugin</artifactId>
              <version>4.0.0</version>
              <extensions>true</extensions>
              <configuration>
                  <basePackage>com.example</basePackage>
              </configuration>
              <dependencies>
                  <!-- Plugin Living Documentation -->
                  <dependency>
                      <groupId>io.hexaglue.plugins</groupId>
                      <artifactId>hexaglue-plugin-living-doc</artifactId>
                      <version>2.0.0</version>
                  </dependency>
                  <!-- Plugin Audit DDD -->
                  <dependency>
                      <groupId>io.hexaglue.plugins</groupId>
                      <artifactId>hexaglue-plugin-audit</artifactId>
                      <version>2.0.0</version>
                  </dependency>
              </dependencies>
          </plugin>
      </plugins>
  </build>

</project>

mvn clean compile

target/hexaglue/reports/living-doc/
├── README.md       # Vue d'ensemble de l'architecture
├── domain.md       # Modèle du domaine (agrégats, entités, value objects)
├── ports.md        # Documentation des ports (driving et driven)
└── diagrams.md     # Diagrammes d'architecture (Mermaid)

mvn verify

target/hexaglue/reports/
├── living-doc/
│   ├── README.md         # Vue d'ensemble de l'architecture
│   ├── domain.md         # Modèle du domaine
│   ├── ports.md          # Documentation des ports
│   └── diagrams.md       # Diagrammes d'architecture
└── audit/
    ├── audit-report.json      # Format JSON pour CI/CD
    ├── audit-report.html      # Rapport HTML navigable
    └── AUDIT-REPORT.md        # Format Markdown

<dependency>
  <groupId>io.hexaglue.plugins</groupId>
  <artifactId>hexaglue-plugin-jpa</artifactId>
  <version>2.0.0</version>
</dependency>

<configuration>
    <basePackage>com.example</basePackage>
    <failOnUnclassified>true</failOnUnclassified>
</configuration>