Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
46 lines (35 loc) · 2.17 KB

DEVELOPMENT.md

File metadata and controls

46 lines (35 loc) · 2.17 KB
Raw

Development Notes

Local Build Commands

./mvnw -q -DskipTests compile
./mvnw -q test
./mvnw -B -ntp -Pintegration-tests verify
./mvnw -B -ntp -Pplatform-acceptance verify
./mvnw -B -ntp -DskipTests checkstyle:check

The Maven Wrapper is the supported build entry point. The platform acceptance command needs Docker and boots the generated Paper and Velocity artifacts. Use it for changes to platform startup, shading, configuration reload, backend registration, or resource recovery.

Typical Workflow

  1. Create a branch from main.
  2. Make focused changes.
  3. Run compile + tests locally.
  4. Run the applicable integration or platform-acceptance gate, then Checkstyle, before opening a PR.
  5. Open a pull request using the repository template.

Project Structure

  • dataprovider-api: public contracts and API-facing dependency types only; it must never depend on core, platforms, or storage drivers.
  • dataprovider-core: registry/factory/configuration, database drivers, and the Hibernate implementation behind api.orm.
  • dataprovider-platform-common: shared lifecycle, commands, and platform logger adapters.
  • dataprovider-platform-paper / dataprovider-platform-velocity: host adapters and shaded server artifacts.
  • Every module keeps tests in its own src/test/java tree.

Coding Guidelines

  • Use registerDatabaseOrThrow and cast only after selecting the expected backend type.
  • Keep connection registration in startup lifecycle paths, not request hot paths.
  • Handle external IO failures as non-fatal where possible and log actionable context.
  • Keep platform-specific integration (platform.bukkit, platform.velocity) thin and isolated.
  • Put cross-platform wrapper behavior in platform.common before adding platform-local duplication.
  • Avoid leaking plugin context across module boundaries.

Manual Validation Checklist

  • Plugin starts cleanly on both Velocity and Bukkit/Paper.
  • DB config defaults generate as expected.
  • Register/unregister lifecycle leaves no leaked connections.
  • Messaging subscriptions are unsubscribed during shutdown.
  • Run the bundled acceptance gate for changes that affect shaded artifacts, startup, reload, or a backend driver.