mongo-java-driver / buildSrc

# AGENTS.md - buildSrc

Gradle build infrastructure providing convention plugins and shared configuration for all modules.

## Key Directories

- `src/main/kotlin/conventions/` — Convention plugins applied by modules (formatting, testing, publishing, static
  analysis)
- `src/main/kotlin/project/` — Base project plugins for Java, Kotlin, and Scala modules
- `src/main/kotlin/ProjectExtensions.kt` — Shared Gradle extension utilities

## Convention Plugins

| Plugin | Purpose |
| --- | --- |
| `spotless` | Code formatting (Kotlin: ktfmt dropbox, max 120; Scala: scalafmt; KotlinGradle: ktfmt; XML/YML/MD: whitespace). Note: Java uses Palantir Java Format via Checkstyle, not Spotless |
| `codenarc` | Groovy static analysis |
| `detekt` | Kotlin static analysis |
| `spotbugs` | Java bug detection |
| `bnd` | OSGi bundle metadata |
| `dokka` | Kotlin documentation generation |
| `javadoc` | Java documentation generation |
| `scaladoc` | Scala documentation generation |
| `publishing` | Maven Central publishing configuration |
| `git-version` | Version derivation from git tags |
| `optional` | Optional dependency support (`optionalImplementation`) |
| `testing-base` | Shared test configuration |
| `testing-integration` | Integration test source set and tasks |
| `testing-junit` | JUnit 5 test setup |
| `testing-junit-vintage` | JUnit 4 compatibility |
| `testing-spock` | Spock framework setup |
| `testing-spock-exclude-slow` | Spock with slow test exclusion |
| `testing-mockito` | Mockito setup |
| `test-artifacts` | Test artifact sharing between modules |
| `test-artifacts-runtime-dependencies` | Runtime dependency sharing for tests |
| `test-include-optionals` | Include optional dependencies in tests |

## Project Plugins

| Plugin | Purpose |
| --- | --- |
| `project/base` | Common settings for all modules |
| `project/java` | Java module conventions (source compatibility, checkstyle) |
| `project/kotlin` | Kotlin module conventions |
| `project/scala` | Scala module conventions (multi-version support) |

## Notes

- Formatting: ktfmt dropbox style, max width 120 (for buildSrc’s own code)
- `check` depends on `spotlessCheck` in buildSrc itself
- Java toolchain is set to Java 17

After modifying buildSrc, run the [`sync-agents-docs`](../.agents/skills/sync-agents-docs/SKILL.md) skill to update
AGENTS.md files and skills that may be affected.