Documentation previewThese docs are actively being built. Some pages may change as the framework and examples are finalized.
Skip to content

Generated Files

Generated files are not all owned the same way.

Check file headers and local package READMEs before editing.

Common Files and Directories

PathPurpose
.goforj.ymlProject render and development contract.
.envLocal runtime environment defaults.
wire/wire.goWire injector definitions.
wire/wire_gen.goGenerated Wire output. Do not edit by hand.
internal/app/lifecycle_registry.goApp-owned lifecycle extension point.
internal/router/routes_registry.goApp route composition.
internal/schedules/scheduler_registry.goApp-owned schedule registration.
internal/caches/*_gen.goGenerated cache accessors and config.
internal/storages/*_gen.goGenerated storage accessors and config.
internal/queues/*_gen.goGenerated queue accessors and config.
internal/events/*_gen.goGenerated event bus accessors and config.
internal/database/*_gen.goGenerated DB accessors and config.
build/api_index.jsonGenerated API index output.
build/api_index.diagnostics.jsonGenerated API index diagnostics.
build/openapi.jsonGenerated OpenAPI output.

Ownership Rules

  • Files marked DO NOT EDIT should be regenerated.
  • Render-once files can be App-owned extension points.
  • Generated component READMEs explain local generated package ownership.
  • Framework-wide changes belong in GoForj templates or generators, not only in a rendered App.