inspection

package

v0.3.2 Latest Latest Go to latest Published: Oct 31, 2026 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/weiloon1234/Foundry-Go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package inspection collects feature-owned declarations and configuration provenance. It never resolves services, starts kernels or reads setting values.

Index ¶

func Command(name cli.Name, collect func(context.Context) (Report, error)) (cli.Declaration, error)
func Write(ctx context.Context, output io.Writer, report Report, arguments Arguments) error
type Arguments
- func (a Arguments) Validate() error
type Format
type Report
- func Collect(ctx context.Context, sources Sources) (Report, error)
- func (Report) Format(state fmt.State, _ rune)
type Section
type Sources

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Command ¶

func Command(name cli.Name, collect func(context.Context) (Report, error)) (cli.Declaration, error)

Command supplies an explicit metadata-only CLI declaration. Parse and run this declaration before application Build/Run when inspecting without service startup. The pure collector can capture the final command registry, avoiding a second declaration list. It must not construct or start services.

func Write ¶

func Write(ctx context.Context, output io.Writer, report Report, arguments Arguments) error

Write selects an existing owned metadata section. Text uses indented JSON so typed policy details remain visible; JSON uses compact machine-readable JSON. Configuration sections contain provenance names and secret markers, no values.

Types ¶

type Arguments ¶

type Arguments struct {
	Section Section
	Format  Format
}

func (Arguments) Validate ¶

func (a Arguments) Validate() error

type Format ¶

type Format string

const (
	JSON Format = "json"
	Text Format = "text"
)

type Report ¶

type Report struct {
	Assembly      foundation.Inspection   `json:"assembly"`
	Routes        []foundryhttp.RouteInfo `json:"routes"`
	Jobs          []jobs.Description      `json:"jobs"`
	Schedules     []schedule.Description  `json:"schedules"`
	Commands      []cli.Description       `json:"commands"`
	Configuration []config.Entry          `json:"configuration"`
	Contracts     *manifest.Document      `json:"contracts,omitempty"`
	Extensions    []slots.Description     `json:"extensions"`
}

func Collect ¶

func Collect(ctx context.Context, sources Sources) (Report, error)

Collect returns owned snapshots using each feature's existing metadata API. It performs no database, queue, lease, HTTP or credential issuance operation.

func (Report) Format ¶

func (Report) Format(state fmt.State, _ rune)

type Section ¶

type Section string

const (
	All           Section = "all"
	Routes        Section = "routes"
	Jobs          Section = "jobs"
	Schedules     Section = "schedules"
	Plugins       Section = "plugins"
	Commands      Section = "commands"
	Configuration Section = "configuration"
	Contracts     Section = "contracts"
	Extensions    Section = "extensions"
)

type Sources ¶

type Sources struct {
	Builder       *foundation.Builder
	HTTP          *foundryhttp.Router
	Jobs          *jobs.Registry
	Dispatcher    *jobs.Dispatcher
	Schedules     *schedule.Registry
	Commands      *cli.Registry
	Contracts     *manifest.Manifest
	Configuration []config.Report
	// Models lists generated model extension declarations, such as a model
	// package's FoundryExtensions().
	Models []slots.Declaration
}

Sources borrows actual assembled registries or pure declarations. Builder inspection runs repeatable Register callbacks, never constructors or Boot. Supply either a job registry or its already assembled dispatcher, not both.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL