chore: align project formatting and config with HMCTS standards

- Refactor all Java files to comply with HMCTS checkstyle rules
- Expand wildcard imports and fix indentation/line-length violations
- Add .editorconfig using HMCTS formatting conventions
- Update .gitignore to include HMCTS-relevant patterns
- Remove Spotless plugin from build.gradle (not used in HMCTS projects)
- Ensure Checkstyle uses HMCTS-provided configuration files

This brings the project into alignment with the HMCTS engineering
standards and eliminates conflicting or redundant formatting tools.

Author: codesungrape

.editorconfig

@@ -0,0 +1,20 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+
+[*.java]
+indent_size = 4
+ij_continuation_indent_size = 4
+ij_java_align_multiline_parameters = true
+ij_java_align_multiline_parameters_in_calls = true
+ij_java_call_parameters_new_line_after_left_paren = true
+ij_java_call_parameters_right_paren_on_new_line = true
+ij_java_call_parameters_wrap = on_every_item

.gitignore

@@ -1,9 +1,13 @@
 HELP.md
 .gradle
 build/
+**/build/
+*.class
 !gradle/wrapper/gradle-wrapper.jar
 !**/src/main/**/build/
 !**/src/test/**/build/
+bin/main/application.yaml
+**/target
 
 
 ### STS ###
@@ -26,6 +30,12 @@ bin/
 out/
 !**/src/main/**/out/
 !**/src/test/**/out/
+.mirrord
+.DS_Store
+
+# node_modules
+package-lock.json
+node_modules/
 
 ### NetBeans ###
 /nbproject/private/
@@ -53,4 +63,5 @@ out/
 *.pem
 
 # Environment variables
-.env
+.env
+

build.gradle

@@ -7,7 +7,6 @@ plugins {
     id 'jacoco' // Code coverage
     id 'checkstyle' // Style rule enforcement
     id 'com.github.spotbugs' version '6.0.7' // Static analysis for bugs
-    id 'com.diffplug.spotless' version '6.25.0' // Code formatting
 }
 
 group = 'com.codesungrape.hmcts'
@@ -112,19 +111,10 @@ jacocoTestCoverageVerification {
 
 // ===== CODE QUALITY & STYLE CONFIGURATION =====
 
-spotless {
-    java {
-        googleJavaFormat('1.17.0').aosp() // A popular, opinionated style
-        removeUnusedImports()
-        trimTrailingWhitespace()
-        endWithNewline()
-    }
-}
-
 checkstyle {
-    toolVersion = '12.1.2'
-    maxWarnings = 0 // Fail build on any warning
-    configFile = file("${rootDir}/config/checkstyle/checkstyle.xml")
+    maxWarnings = 0
+    toolVersion = '10.26.1'
+    getConfigDirectory().set(new File(rootDir, 'config/checkstyle'))
 }
 
 spotbugs {

config/checkstyle/checkstyle.xml

@@ -4,24 +4,13 @@
 import jakarta.validation.constraints.NotBlank;
 
 /**
- * DTO representing the required input for creating or replacing a Book resource.
- * This class mirrors the OpenAPI 'BookInput' schema.
- *
- * @Value: Makes fields final, adds constructor, getters, equals, hashCode, toString.
- * @NotBlank: Field required; empty/missing value returns 400 Bad Request in Spring.
- * @JsonProperty: Maps snake_case JSON to camelCase Java using Jackson.
+ * DTO representing the required input for creating or replacing a Book resource. This class mirrors
+ * the OpenAPI 'BookInput' schema. @Value: Makes fields final, adds constructor, getters, equals,
+ * hashCode, toString. @NotBlank: Field required; empty/missing value returns 400 Bad Request in
+ * Spring. @JsonProperty: Maps snake_case JSON to camelCase Java using Jackson.
  */
 public record BookRequest(
-    @JsonProperty("title")
-    @NotBlank(message = "Title is required")
-    String title,
-
-    @JsonProperty("synopsis")
-    @NotBlank(message = "Synopsis is required")
-    String synopsis,
-
-    @JsonProperty("author")
-    @NotBlank(message = "Author is required")
-    String author
-) {
-}
+    @JsonProperty("title") @NotBlank(message = "Title is required") String title,
+    @JsonProperty("synopsis") @NotBlank(message = "Synopsis is required") String synopsis,
+    @JsonProperty("author") @NotBlank(message = "Author is required") String author) {
+}

src/main/java/com/codesungrape/hmcts/bookapi/dto/BookRequest.java

@@ -8,8 +8,10 @@
 import jakarta.persistence.PrePersist;
 import jakarta.persistence.PreUpdate;
 import jakarta.persistence.Table;
+
 import java.time.Instant;
 import java.util.UUID;
+
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -18,22 +20,14 @@
 import lombok.Setter;
 
 /**
- * Represents the Book table in PostgreSQL as a JPA entity.
- * Stores the persisted state of a Book resource.
- * HMCTS Rule: IDs must be opaque; using UUID for distributed ID generation.
- *
- * @Entity: Marks the class as a JPA entity for Hibernate table mapping.
- * @Table: Specifies the database table; HMCTS: lowercase, singular table name.
- *     Lombok Annotations:
- * @Getter: Generates getters for all fields.
- * @Setter: Generates setters for all fields.
- * @NoArgsConstructor: Protected no-arg constructor for JPA instantiation.
- * @AllArgsConstructor: Constructor with all fields for test convenience.
- * @Builder: Adds builder pattern for easy object creation.
- *     Example: Book.builder()
- *     .title("A")
- *     .author("B")
- *     .build();
+ * Represents the Book table in PostgreSQL as a JPA entity. Stores the persisted state of a Book
+ * resource. HMCTS Rule: IDs must be opaque; using UUID for distributed ID generation. @Entity:
+ * Marks the class as a JPA entity for Hibernate table mapping. @Table: Specifies the database
+ * table; HMCTS: lowercase, singular table name. Lombok Annotations: @Getter: Generates getters for
+ * all fields. @Setter: Generates setters for all fields. @NoArgsConstructor: Protected no-arg
+ * constructor for JPA instantiation. @AllArgsConstructor: Constructor with all fields for test
+ * convenience. @Builder: Adds builder pattern for easy object creation. Example: Book.builder()
+ * .title("A") .author("B") .build();
  */
 @Entity
 @Table(name = "book")
@@ -44,53 +38,54 @@
 @Builder // For convenience in creating instances
 public class Book {
 
-  @Id // Primary key of the table
-  @GeneratedValue(strategy = GenerationType.UUID)
-  @Column(name = "id", nullable = false)
-  private UUID id;
+    @Id // Primary key of the table
+    @GeneratedValue(strategy = GenerationType.UUID)
+    @Column(name = "id", nullable = false)
+    private UUID id;
+
+    @Column(name = "title", nullable = false)
+    private String title;
 
-  @Column(name = "title", nullable = false)
-  private String title;
+    @Column(name = "synopsis", nullable = false, columnDefinition = "TEXT")
+    private String synopsis;
 
-  @Column(name = "synopsis", nullable = false, columnDefinition = "TEXT")
-  private String synopsis;
+    @Column(name = "author", nullable = false)
+    private String author;
 
-  @Column(name = "author", nullable = false)
-  private String author;
+    // Soft delete - makes DELETE operations idempotent (safe to repeat)
+    // Using @Builder.Default to ensure the builder respects this initialization
+    // if the field is not set explicitly.
+    @Column(name = "deleted", nullable = false)
+    @Builder.Default
+    private boolean deleted = false;
 
-  // Soft delete - makes DELETE operations idempotent (safe to repeat)
-  // Using @Builder.Default to ensure the builder respects this initialization
-  // if the field is not set explicitly.
-  @Column(name = "deleted", nullable = false)
-  @Builder.Default
-  private boolean deleted = false;
+    // `createdAt` is null upon object creation.
+    // It will be set by the `onCreate()` method right before persistence.
+    @Column(name = "created_at", nullable = false, updatable = false)
+    private Instant createdAt;
 
-  // `createdAt` is null upon object creation.
-  // It will be set by the `onCreate()` method right before persistence.
-  @Column(name = "created_at", nullable = false, updatable = false)
-  private Instant createdAt;
+    @Column(name = "modified_at")
+    private Instant modifiedAt;
 
-  @Column(name = "modified_at")
-  private Instant modifiedAt;
+    // --- JPA lifecycle callbacks ---
 
-  // --- JPA lifecycle callbacks ---
-  /**
-   * Sets createdAt before persisting a new Book record.
-   */
-  @PrePersist
-  protected void onCreate() {
-    this.createdAt = Instant.now();
-  }
+    /**
+     * Sets createdAt before persisting a new Book record.
+     */
+    @PrePersist
+    protected void onCreate() {
+        this.createdAt = Instant.now();
+    }
 
-  // --- Business Logic Helper ---
-  // HMCTS requires business logic to live in services; setter hooks are allowed.
-  // Lifecycle callback: runs automatically before Hibernate updates a database record.
+    // --- Business Logic Helper ---
+    // HMCTS requires business logic to live in services; setter hooks are allowed.
+    // Lifecycle callback: runs automatically before Hibernate updates a database record.
 
-  /**
-   * Updates modifiedAt before updating an existing Book record.
-   */
-  @PreUpdate
-  protected void onUpdate() {
-    this.modifiedAt = Instant.now();
-  }
+    /**
+     * Updates modifiedAt before updating an existing Book record.
+     */
+    @PreUpdate
+    protected void onUpdate() {
+        this.modifiedAt = Instant.now();
+    }
 }

src/main/java/com/codesungrape/hmcts/bookapi/entity/Book.java

@@ -1,28 +1,27 @@
 package com.codesungrape.hmcts.bookapi.repository;
 
 import com.codesungrape.hmcts.bookapi.entity.Book;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
 import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
-import org.springframework.data.jpa.repository.JpaRepository;
-import org.springframework.stereotype.Repository;
 
 /**
- * Repository interface for Book entities.
- * Provides CRUD operations and custom queries for non-deleted books.
- * Spring Data JPA automatically implements this interface at runtime.
+ * Repository interface for Book entities. Provides CRUD operations and custom queries for
+ * non-deleted books. Spring Data JPA automatically implements this interface at runtime.
  */
 @Repository
 public interface BookRepository extends JpaRepository<Book, UUID> {
 
-  /**
-   * Custom query retrieves all Book records that have not been soft-deleted.
-   */
-  List<Book> findAllByDeletedFalse();
-
-  /**
-   * Retrieves a single Book by ID, if it exists and has not been soft-deleted.
-   */
-  Optional<Book> findByIdAndDeletedFalse(UUID id);
+    /**
+     * Custom query retrieves all Book records that have not been soft-deleted.
+     */
+    List<Book> findAllByDeletedFalse();
 
-}
+    /**
+     * Retrieves a single Book by ID, if it exists and has not been soft-deleted.
+     */
+    Optional<Book> findByIdAndDeletedFalse(UUID id);
+}

src/main/java/com/codesungrape/hmcts/bookapi/repository/BookRepository.java

@@ -13,47 +13,46 @@
 @RequiredArgsConstructor // Lombok creates constructor for dependency injection
 public class BookService {
 
-  // Create a field to store the repo
-  private final BookRepository bookRepository;
-
-  /**
-   * Creates a new Book entity from the given BookRequest DTO and persists it.
-   *
-   * @param request DTO containing book details (title, author, synopsis)
-   * @return The saved Book entity
-   * @throws NullPointerException if request is null
-   * @throws IllegalArgumentException if title is null or blank
-   * @throws IllegalStateException if the repository fails to save the book
-   */
-
-  public Book createBook(BookRequest request) {
-    // Validation check for business rules (e.g., uniqueness, if required)
-    if (request == null) {
-      throw new NullPointerException("BookRequest cannot be null");
+    // Create a field to store the repo
+    private final BookRepository bookRepository;
+
+    /**
+     * Creates a new Book entity from the given BookRequest DTO and persists it.
+     *
+     * @param request DTO containing book details (title, author, synopsis)
+     * @return The saved Book entity
+     * @throws NullPointerException     if request is null
+     * @throws IllegalArgumentException if title is null or blank
+     * @throws IllegalStateException    if the repository fails to save the book
+     */
+    public Book createBook(BookRequest request) {
+        // Validation check for business rules (e.g., uniqueness, if required)
+        if (request == null) {
+            throw new NullPointerException("BookRequest cannot be null");
+        }
+
+        // TODO: Leaving this here for now as i haven't implemented the Controller Layer yet
+        // The service layer is duplicating validation that already exists in the
+        // BookRequest DTO with @notblank annotations. Since the DTO has validation
+        // constraints, this manual check is redundant when Spring's validation
+        // framework is properly configured in the controller layer.
+        // Consider removing this duplication or adding a comment explaining
+        // why service-level validation is necessary in addition to DTO validation.
+        if (request.title() == null || request.title().isBlank()) {
+            throw new IllegalArgumentException("Book title cannot be null or blank");
+        }
+
+        // Map DTO to Entity
+        Book newBook =
+            Book.builder()
+                .title(request.title())
+                .author(request.author())
+                .synopsis(request.synopsis())
+                // ID and created_at are auto-generated by JPA/DB
+                .build();
+
+        Book savedBook = bookRepository.save(newBook);
+
+        return savedBook;
     }
-
-
-    // TODO: Leaving this here for now as i haven't implemented the Controller Layer yet
-    // The service layer is duplicating validation that already exists in the
-    // BookRequest DTO with @notblank annotations. Since the DTO has validation
-    // constraints, this manual check is redundant when Spring's validation
-    // framework is properly configured in the controller layer.
-    // Consider removing this duplication or adding a comment explaining
-    // why service-level validation is necessary in addition to DTO validation.
-    if (request.title() == null || request.title().isBlank()) {
-      throw new IllegalArgumentException("Book title cannot be null or blank");
-    }
-
-    // Map DTO to Entity
-    Book newBook = Book.builder()
-        .title(request.title())
-        .author(request.author())
-        .synopsis(request.synopsis())
-        // ID and created_at are auto-generated by JPA/DB
-        .build();
-
-    Book savedBook = bookRepository.save(newBook);
-
-    return savedBook;
-  }
-}
+}