bootstrap

package
v0.85.0-pre.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 3, 2026 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Overview

This package is not meant to be called directly by users. If you are looking to bootstrap a new Vorma app, please run `npm create vorma@latest` in your terminal instead.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MustInit

func MustInit(o Options)

Types

type Options

type Options struct {
	// e.g., "appname" or "modroot/apps/appname"
	GoImportBase string
	// "react", "preact", or "solid"
	UIVariant string
	// "npm", "pnpm", "yarn", or "bun"
	JSPackageManager string
	// "docker", "vercel", or "none"
	DeploymentTarget string
	IncludeTailwind  bool
	CreatedInDir     string // Empty if not created in a new directory
	NodeMajorVersion string // Example: "22"
	GoVersion        string // Example: "go1.24.0"

	// Monorepo support fields
	ModuleRoot      string // Absolute path to go.mod location
	CurrentDir      string // Absolute path where Vorma app is being created
	HasParentModule bool   // True if using a parent go.mod

	// SkipJavaScriptDependencyInstall avoids running package-manager install
	// commands for generated package dependencies.
	SkipJavaScriptDependencyInstall bool
	// SkipGoModTidy avoids running `go mod tidy` after scaffold generation.
	SkipGoModTidy bool
	// SkipInitialProjectBuild avoids running the first `go run ./backend/cmd/build`.
	SkipInitialProjectBuild bool
	// SuppressSuccessOutput avoids printing the interactive success banner.
	SuppressSuccessOutput bool
}

Jump to

Keyboard shortcuts

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