Documentation
¶
Overview ¶
Package project models the GoForj project facts Atlas needs to guide agents.
Index ¶
Constants ¶
View Source
const DefaultAppName = "app"
DefaultAppName is the conventional name for the default GoForj app.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
Name string `json:"name"`
Default bool `json:"default"`
Runtimes []string `json:"runtimes,omitempty"`
}
App describes one runnable GoForj app boundary.
type Project ¶
type Project struct {
Root string `json:"root"`
Name string `json:"name"`
GoVersion string `json:"go_version"`
GoForjVersion string `json:"goforj_version"`
DocsRevision string `json:"docs_revision,omitempty"`
Components []string `json:"components,omitempty"`
Apps []App `json:"apps,omitempty"`
FrontendKit string `json:"frontend_kit,omitempty"`
DatabaseDriver string `json:"database_driver,omitempty"`
QueueDriver string `json:"queue_driver,omitempty"`
}
Project contains the project facts Atlas needs without importing GoForj.
func (Project) DefaultApp ¶
DefaultApp returns the default app, synthesizing one when discovery has not provided explicit app metadata.
func (Project) WithDiscoveredDefaults ¶
WithDiscoveredDefaults normalizes default app metadata and runtime lists.
Click to show internal directories.
Click to hide internal directories.