demo

package

v0.7.1 Latest Latest Go to latest Published: Jul 25, 2026 License: MIT Imports: 7 Imported by: 0

Details

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

Repository

github.com/jongio/grut

Links

Open Source Insights

Documentation ¶

Index ¶

func FormatScenarioList() string
func IsScenarioListName(name string) bool
func SetupProject() (string, func(), error)
type Scenario
- func LookupScenario(name string) (Scenario, bool)
- func Scenarios() []Scenario
type ScenarioSetup
- func SetupProjectWithOptions(opts SetupOptions) (*ScenarioSetup, func(), error)
type SetupOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatScenarioList ¶ added in v0.7.0

func FormatScenarioList() string

FormatScenarioList renders all scenarios with one-line descriptions.

func IsScenarioListName ¶ added in v0.7.0

func IsScenarioListName(name string) bool

IsScenarioListName reports whether name requests scenario listing.

func SetupProject ¶

func SetupProject() (string, func(), error)

SetupProject creates a temporary directory with a realistic Go project and git history for exploring grut without needing your own repository. Returns the project path and a cleanup function that removes the temporary directory.

Types ¶

type Scenario ¶ added in v0.7.0

type Scenario struct {
	Name        string
	Description string
	Layout      string
	FocusPanel  string
	Guide       []string
	// contains filtered or unexported fields
}

Scenario describes a guided demo walkthrough and its initial UI state.

func LookupScenario ¶ added in v0.7.0

func LookupScenario(name string) (Scenario, bool)

LookupScenario returns a scenario by name.

func Scenarios ¶ added in v0.7.0

func Scenarios() []Scenario

Scenarios returns the guided demo scenarios in CLI display order.

type ScenarioSetup ¶ added in v0.7.0

type ScenarioSetup struct {
	Dir       string
	Scenario  *Scenario
	GuidePath string
}

ScenarioSetup describes the project path and selected scenario returned by SetupProjectWithOptions.

func SetupProjectWithOptions ¶ added in v0.7.0

func SetupProjectWithOptions(opts SetupOptions) (*ScenarioSetup, func(), error)

SetupProjectWithOptions creates a demo project and optionally applies a guided scenario.

type SetupOptions ¶ added in v0.7.0

type SetupOptions struct {
	Scenario string
	Keep     bool
}

SetupOptions controls demo project creation.

Source Files ¶

View all Source files

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