mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-06-12 11:13:11 +08:00
feat: expand Kiro adapter to full language coverage (#2101)
* feat: expand Kiro adapter to full language coverage - Add 17 new agents (typescript, rust, kotlin, java, cpp, django, swift, fsharp, pytorch, mle, performance-optimizer) in both .md and .json formats - Add 25 new skills (rust, kotlin, java/spring, django, fastapi, nestjs, react, nextjs, cpp, swift, mle/pytorch, deep-research, strategic-compact, autonomous-loops, content-hash-cache-pattern) - Add 6 new language-specific steering files (rust, kotlin, java, cpp, php, ruby) - Add 3 new hooks (rust-check-on-edit, python-lint-on-edit, security-check-on-create) - Update README with expanded component inventory and documentation - Fix install.sh line endings for macOS compatibility Total Kiro components: 33 agents, 43 skills, 22 steering files, 13 hooks * fix: resolve P1/P2 violations in Kiro agents, skills, and steering - java-patterns.md: remove reference to non-existent quarkus-patterns skill - kotlin-patterns.md: fix insecure BuildConfig recommendation for secrets - swift-actor-persistence: fix Swift version claim (5.9+) and Dictionary crash - java-reviewer.md: add recursive framework detection + robust diff chain - kotlin-reviewer.md: replace unreliable diff detection with fallback chain - rust-reviewer.md: add diff fallback + make CI gating mandatory - jpa-patterns: add DISTINCT to fetch-join query to prevent duplicates - django-reviewer.md: add migration safety check, narrow save() rule, fix pytest-django behavior description * fix: resolve remaining violations in Kiro agents, skills, and docs Agents: - java-build-resolver.md: remove quarkus-patterns ref, fix 'Initialise' spelling - java-reviewer.json: remove quarkus-patterns ref from prompt - mle-reviewer.md, cpp-build-resolver.md, java-build-resolver.md, performance-optimizer.md: fix allowedTools 'read' -> 'fs_read' Hooks: - rust-check-on-edit: fix description to match askAgent behavior Skills: - content-hash-cache-pattern: hyphenate 'Content-Hash-Based' - cpp-testing: hyphenate 'real-time' - django-security: use placeholder secrets, fix CSRF_COOKIE_HTTPONLY=False - nestjs-patterns: add Logger to HttpExceptionFilter for non-Http errors - react-patterns: add React 19 compatibility note for useActionState - rust-patterns: remove edition-specific 'Rust 2024+' reference - springboot-patterns: cap exponential backoff, recommend Resilience4j - springboot-security: fix invalid @Query SQL injection example - swift-protocol-di-testing: add thread-safety doc comment to mock Docs: - README.md: fix Project Structure counts (33/43/22/13) * fix: sync README tree with counts, restore local diff in kotlin-reviewer, correct django FK index guidance - README.md: Project Structure tree now lists all 33 agents, 43 skills, 22 steering files, and 13 hooks (was showing old subset) - kotlin-reviewer.md: restore git diff --staged / git diff for local pre-commit review before falling back to HEAD~1 - django-reviewer.md: clarify that ForeignKey fields are indexed by default; only flag missing db_index on non-FK filter columns
This commit is contained in:
383
.kiro/skills/java-coding-standards/SKILL.md
Normal file
383
.kiro/skills/java-coding-standards/SKILL.md
Normal file
@@ -0,0 +1,383 @@
|
||||
---
|
||||
name: java-coding-standards
|
||||
description: "Java coding standards for Spring Boot and Quarkus services: naming, immutability, Optional usage, streams, exceptions, generics, CDI, reactive patterns, and project layout. Automatically applies framework-specific conventions."
|
||||
origin: ECC
|
||||
---
|
||||
|
||||
# Java Coding Standards
|
||||
|
||||
Standards for readable, maintainable Java (17+) code in Spring Boot and Quarkus services.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Writing or reviewing Java code in Spring Boot or Quarkus projects
|
||||
- Enforcing naming, immutability, or exception handling conventions
|
||||
- Working with records, sealed classes, or pattern matching (Java 17+)
|
||||
- Reviewing use of Optional, streams, or generics
|
||||
- Structuring packages and project layout
|
||||
- **[QUARKUS]**: Working with CDI scopes, Panache entities, or reactive pipelines
|
||||
|
||||
## How It Works
|
||||
|
||||
### Framework Detection
|
||||
|
||||
Before applying standards, determine the framework from the build file:
|
||||
|
||||
- Build file contains `quarkus` → apply **[QUARKUS]** conventions
|
||||
- Build file contains `spring-boot` → apply **[SPRING]** conventions
|
||||
- Neither detected → apply shared conventions only
|
||||
|
||||
## Core Principles
|
||||
|
||||
- Prefer clarity over cleverness
|
||||
- Immutable by default; minimize shared mutable state
|
||||
- Fail fast with meaningful exceptions
|
||||
- Consistent naming and package structure
|
||||
- **[QUARKUS]**: Favor build-time over runtime processing; avoid runtime reflection where possible
|
||||
|
||||
## Examples
|
||||
|
||||
The sections below show concrete Spring Boot, Quarkus, and shared Java examples
|
||||
for naming, immutability, dependency injection, reactive code, exceptions,
|
||||
project layout, logging, configuration, and tests.
|
||||
|
||||
## Naming
|
||||
|
||||
```java
|
||||
// PASS: Classes/Records: PascalCase
|
||||
public class MarketService {}
|
||||
public record Money(BigDecimal amount, Currency currency) {}
|
||||
|
||||
// PASS: Methods/fields: camelCase
|
||||
private final MarketRepository marketRepository;
|
||||
public Market findBySlug(String slug) {}
|
||||
|
||||
// PASS: Constants: UPPER_SNAKE_CASE
|
||||
private static final int MAX_PAGE_SIZE = 100;
|
||||
|
||||
// PASS: [QUARKUS] JAX-RS resources named as *Resource, not *Controller
|
||||
public class MarketResource {}
|
||||
|
||||
// PASS: [SPRING] REST controllers named as *Controller
|
||||
public class MarketController {}
|
||||
```
|
||||
|
||||
## Immutability
|
||||
|
||||
```java
|
||||
// PASS: Favor records and final fields
|
||||
public record MarketDto(Long id, String name, MarketStatus status) {}
|
||||
|
||||
public class Market {
|
||||
private final Long id;
|
||||
private final String name;
|
||||
// getters only, no setters
|
||||
}
|
||||
|
||||
// PASS: [QUARKUS] Panache active-record entities use public fields (Quarkus convention)
|
||||
@Entity
|
||||
public class Market extends PanacheEntity {
|
||||
public String name;
|
||||
public MarketStatus status;
|
||||
// Panache generates accessors at build time; public fields are idiomatic here
|
||||
}
|
||||
|
||||
// PASS: [QUARKUS] Panache MongoDB entities
|
||||
@MongoEntity(collection = "markets")
|
||||
public class Market extends PanacheMongoEntity {
|
||||
public String name;
|
||||
public MarketStatus status;
|
||||
}
|
||||
```
|
||||
|
||||
## Optional Usage
|
||||
|
||||
```java
|
||||
// PASS: Return Optional from find* methods
|
||||
// [SPRING]
|
||||
Optional<Market> market = marketRepository.findBySlug(slug);
|
||||
|
||||
// [QUARKUS] Panache
|
||||
Optional<Market> market = Market.find("slug", slug).firstResultOptional();
|
||||
|
||||
// PASS: Map/flatMap instead of get()
|
||||
return market
|
||||
.map(MarketResponse::from)
|
||||
.orElseThrow(() -> new EntityNotFoundException("Market not found"));
|
||||
```
|
||||
|
||||
## Streams Best Practices
|
||||
|
||||
```java
|
||||
// PASS: Use streams for transformations, keep pipelines short
|
||||
List<String> names = markets.stream()
|
||||
.map(Market::name)
|
||||
.filter(Objects::nonNull)
|
||||
.toList();
|
||||
|
||||
// FAIL: Avoid complex nested streams; prefer loops for clarity
|
||||
```
|
||||
|
||||
## Dependency Injection
|
||||
|
||||
```java
|
||||
// PASS: [SPRING] Constructor injection (preferred over @Autowired on fields)
|
||||
@Service
|
||||
public class MarketService {
|
||||
private final MarketRepository marketRepository;
|
||||
|
||||
public MarketService(MarketRepository marketRepository) {
|
||||
this.marketRepository = marketRepository;
|
||||
}
|
||||
}
|
||||
|
||||
// PASS: [QUARKUS] Constructor injection
|
||||
@ApplicationScoped
|
||||
public class MarketService {
|
||||
private final MarketRepository marketRepository;
|
||||
|
||||
@Inject
|
||||
public MarketService(MarketRepository marketRepository) {
|
||||
this.marketRepository = marketRepository;
|
||||
}
|
||||
}
|
||||
|
||||
// PASS: [QUARKUS] Package-private field injection (acceptable in Quarkus — avoids proxy issues)
|
||||
@ApplicationScoped
|
||||
public class MarketService {
|
||||
@Inject
|
||||
MarketRepository marketRepository;
|
||||
}
|
||||
|
||||
// FAIL: [SPRING] Field injection with @Autowired
|
||||
@Autowired
|
||||
private MarketRepository marketRepository; // use constructor injection
|
||||
|
||||
// FAIL: [QUARKUS] @Singleton when interception or lazy init is needed
|
||||
@Singleton // non-proxyable — use @ApplicationScoped instead
|
||||
public class MarketService {}
|
||||
```
|
||||
|
||||
## Reactive Patterns [QUARKUS]
|
||||
|
||||
```java
|
||||
// PASS: Return Uni/Multi from reactive endpoints
|
||||
@GET
|
||||
@Path("/{slug}")
|
||||
public Uni<Market> findBySlug(@PathParam("slug") String slug) {
|
||||
return Market.find("slug", slug)
|
||||
.<Market>firstResult()
|
||||
.onItem().ifNull().failWith(() -> new MarketNotFoundException(slug));
|
||||
}
|
||||
|
||||
// PASS: Non-blocking pipeline composition
|
||||
public Uni<OrderConfirmation> placeOrder(OrderRequest req) {
|
||||
return validateOrder(req)
|
||||
.chain(valid -> persistOrder(valid))
|
||||
.chain(order -> notifyFulfillment(order));
|
||||
}
|
||||
|
||||
// FAIL: Blocking call inside a Uni/Multi pipeline
|
||||
public Uni<Market> find(String slug) {
|
||||
Market m = Market.find("slug", slug).firstResult(); // BLOCKING — breaks event loop
|
||||
return Uni.createFrom().item(m);
|
||||
}
|
||||
|
||||
// FAIL: Subscribing more than once to a shared Uni
|
||||
Uni<Market> shared = fetchMarket(slug);
|
||||
shared.subscribe().with(m -> log(m));
|
||||
shared.subscribe().with(m -> cache(m)); // double subscribe — use Uni.memoize()
|
||||
```
|
||||
|
||||
## Exceptions
|
||||
|
||||
- Use unchecked exceptions for domain errors; wrap technical exceptions with context
|
||||
- Create domain-specific exceptions (e.g., `MarketNotFoundException`)
|
||||
- Avoid broad `catch (Exception ex)` unless rethrowing/logging centrally
|
||||
|
||||
```java
|
||||
throw new MarketNotFoundException(slug);
|
||||
```
|
||||
|
||||
### Centralised Exception Handling
|
||||
|
||||
```java
|
||||
// [SPRING]
|
||||
@RestControllerAdvice
|
||||
public class GlobalExceptionHandler {
|
||||
@ExceptionHandler(MarketNotFoundException.class)
|
||||
public ResponseEntity<ErrorResponse> handle(MarketNotFoundException ex) {
|
||||
return ResponseEntity.status(404).body(ErrorResponse.from(ex));
|
||||
}
|
||||
}
|
||||
|
||||
// [QUARKUS] Option A: ExceptionMapper
|
||||
@Provider
|
||||
public class MarketNotFoundMapper implements ExceptionMapper<MarketNotFoundException> {
|
||||
@Override
|
||||
public Response toResponse(MarketNotFoundException ex) {
|
||||
return Response.status(404).entity(ErrorResponse.from(ex)).build();
|
||||
}
|
||||
}
|
||||
|
||||
// [QUARKUS] Option B: @ServerExceptionMapper (RESTEasy Reactive)
|
||||
@ServerExceptionMapper
|
||||
public RestResponse<ErrorResponse> handle(MarketNotFoundException ex) {
|
||||
return RestResponse.status(Status.NOT_FOUND, ErrorResponse.from(ex));
|
||||
}
|
||||
```
|
||||
|
||||
## Generics and Type Safety
|
||||
|
||||
- Avoid raw types; declare generic parameters
|
||||
- Prefer bounded generics for reusable utilities
|
||||
|
||||
```java
|
||||
public <T extends Identifiable> Map<Long, T> indexById(Collection<T> items) { ... }
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
### [SPRING] Maven/Gradle
|
||||
|
||||
```
|
||||
src/main/java/com/example/app/
|
||||
config/
|
||||
controller/
|
||||
service/
|
||||
repository/
|
||||
domain/
|
||||
dto/
|
||||
util/
|
||||
src/main/resources/
|
||||
application.yml
|
||||
src/test/java/... (mirrors main)
|
||||
```
|
||||
|
||||
### [QUARKUS] Maven/Gradle
|
||||
|
||||
```
|
||||
src/main/java/com/example/app/
|
||||
config/ # @ConfigMapping, @ConfigProperty beans, Producers
|
||||
resource/ # JAX-RS resources (not "controller")
|
||||
service/
|
||||
repository/ # PanacheRepository implementations (if not using active record)
|
||||
domain/ # JPA/Panache entities, MongoDB entities
|
||||
dto/
|
||||
util/
|
||||
mapper/ # MapStruct mappers (if used)
|
||||
src/main/resources/
|
||||
application.properties # Quarkus convention (YAML supported with quarkus-config-yaml)
|
||||
import.sql # Hibernate auto-import for dev/test
|
||||
src/test/java/... (mirrors main)
|
||||
```
|
||||
|
||||
## Formatting and Style
|
||||
|
||||
- Use 2 or 4 spaces consistently (project standard)
|
||||
- One public top-level type per file
|
||||
- Keep methods short and focused; extract helpers
|
||||
- Order members: constants, fields, constructors, public methods, protected, private
|
||||
|
||||
## Code Smells to Avoid
|
||||
|
||||
- Long parameter lists → use DTO/builders
|
||||
- Deep nesting → early returns
|
||||
- Magic numbers → named constants
|
||||
- Static mutable state → prefer dependency injection
|
||||
- Silent catch blocks → log and act or rethrow
|
||||
- **[QUARKUS]**: `@Singleton` where `@ApplicationScoped` is intended — breaks proxying and interception
|
||||
- **[QUARKUS]**: Mixing `quarkus-resteasy-reactive` and `quarkus-resteasy` (classic) — pick one stack
|
||||
- **[QUARKUS]**: Panache active-record + repository pattern in the same bounded context — pick one
|
||||
|
||||
## Logging
|
||||
|
||||
```java
|
||||
// [SPRING] SLF4J
|
||||
private static final Logger log = LoggerFactory.getLogger(MarketService.class);
|
||||
log.info("fetch_market slug={}", slug);
|
||||
log.error("failed_fetch_market slug={}", slug, ex);
|
||||
|
||||
// [QUARKUS] JBoss Logging (default, zero-cost at build time)
|
||||
private static final Logger log = Logger.getLogger(MarketService.class);
|
||||
log.infof("fetch_market slug=%s", slug);
|
||||
log.errorf(ex, "failed_fetch_market slug=%s", slug);
|
||||
|
||||
// [QUARKUS] Alternative: simplified logging with @Inject
|
||||
@Inject
|
||||
Logger log; // CDI-injected, scoped to declaring class
|
||||
```
|
||||
|
||||
## Null Handling
|
||||
|
||||
- Accept `@Nullable` only when unavoidable; otherwise use `@NonNull`
|
||||
- Use Bean Validation (`@NotNull`, `@NotBlank`) on inputs
|
||||
- **[QUARKUS]**: Apply `@Valid` on `@BeanParam`, `@RestForm`, and request body parameters
|
||||
|
||||
## Configuration
|
||||
|
||||
```java
|
||||
// [SPRING] @ConfigurationProperties
|
||||
@ConfigurationProperties(prefix = "market")
|
||||
public record MarketProperties(int maxPageSize, Duration cacheTtl) {}
|
||||
|
||||
// [QUARKUS] @ConfigMapping (type-safe, build-time validated)
|
||||
@ConfigMapping(prefix = "market")
|
||||
public interface MarketConfig {
|
||||
int maxPageSize();
|
||||
Duration cacheTtl();
|
||||
}
|
||||
|
||||
// [QUARKUS] Simple values with @ConfigProperty
|
||||
@ConfigProperty(name = "market.max-page-size", defaultValue = "100")
|
||||
int maxPageSize;
|
||||
```
|
||||
|
||||
## Testing Expectations
|
||||
|
||||
### Shared
|
||||
- JUnit 5 + AssertJ for fluent assertions
|
||||
- Mockito for mocking; avoid partial mocks where possible
|
||||
- Favor deterministic tests; no hidden sleeps
|
||||
|
||||
### [SPRING]
|
||||
- `@WebMvcTest` for controller slices, `@DataJpaTest` for repository slices
|
||||
- `@SpringBootTest` reserved for full integration tests
|
||||
- `@MockBean` for replacing beans in Spring context
|
||||
|
||||
### [QUARKUS]
|
||||
- Plain JUnit 5 + Mockito for unit tests (no `@QuarkusTest`)
|
||||
- `@QuarkusTest` reserved for CDI integration tests
|
||||
- `@InjectMock` for replacing CDI beans in integration tests
|
||||
- Dev Services for database/Kafka/Redis — avoid manual Testcontainers setup when Dev Services suffice
|
||||
- `@QuarkusTestResource` for custom external service lifecycle
|
||||
|
||||
```java
|
||||
// [SPRING] Controller test
|
||||
@WebMvcTest(MarketController.class)
|
||||
class MarketControllerTest {
|
||||
@Autowired MockMvc mockMvc;
|
||||
@MockBean MarketService marketService;
|
||||
}
|
||||
|
||||
// [QUARKUS] Integration test
|
||||
@QuarkusTest
|
||||
class MarketResourceTest {
|
||||
@InjectMock
|
||||
MarketService marketService;
|
||||
|
||||
@Test
|
||||
void should_return_404_when_market_not_found() {
|
||||
given().when().get("/markets/unknown").then().statusCode(404);
|
||||
}
|
||||
}
|
||||
|
||||
// [QUARKUS] Unit test (no CDI, no @QuarkusTest)
|
||||
@ExtendWith(MockitoExtension.class)
|
||||
class MarketServiceTest {
|
||||
@Mock MarketRepository marketRepository;
|
||||
@InjectMocks MarketService marketService;
|
||||
}
|
||||
```
|
||||
|
||||
**Remember**: Keep code intentional, typed, and observable. Optimize for maintainability over micro-optimizations unless proven necessary.
|
||||
Reference in New Issue
Block a user