shellgen

package

v0.0.0-...-0d3f7f9 Latest Latest Go to latest Published: Apr 27, 2024 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jetify-com/devbox

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func FlakePath(d devboxer) string
func GenerateForPrintEnv(ctx context.Context, devbox devboxer) error
func ScriptBody(d devboxer, body string) (string, error)
func ScriptPath(projectDir, scriptName string) string
func WriteScriptFile(devbox devboxer, name, body string) (err error)
func WriteScriptsToFiles(devbox devboxer) error
type NixpkgsInfo
type SymlinkJoin

Constants ¶

View Source

const (
	HooksFilename = ".hooks"
)

HooksFilename is the name of the file that contains a wrapper of the project's init-hooks and plugin hooks

Variables ¶

This section is empty.

Functions ¶

func FlakePath ¶

func FlakePath(d devboxer) string

func GenerateForPrintEnv ¶

func GenerateForPrintEnv(ctx context.Context, devbox devboxer) error

GenerateForPrintEnv will create all the files necessary for processing devbox.PrintEnv, which is the core function from which devbox shell/run/direnv functionality is derived.

func ScriptBody ¶

func ScriptBody(d devboxer, body string) (string, error)

func ScriptPath ¶

func ScriptPath(projectDir, scriptName string) string

func WriteScriptFile ¶

func WriteScriptFile(devbox devboxer, name, body string) (err error)

func WriteScriptsToFiles ¶

func WriteScriptsToFiles(devbox devboxer) error

WriteScriptsToFiles writes scripts defined in devbox.json into files inside .devbox/gen/scripts. Scripts (and hooks) are persisted so that we can easily call them from devbox run (inside or outside shell).

Types ¶

type NixpkgsInfo ¶

type NixpkgsInfo struct {
	URL    string
	TarURL string
}

Contains default nixpkgs used for mkShell

type SymlinkJoin ¶

type SymlinkJoin struct {
	Name  string
	Paths []string
}

Source Files ¶

View all Source files

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