node

package
v0.17.1 Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultCRAOutputDirectory = "build"
	DefaultCRAStartCommand    = "react-scripts start"
)
View Source 
const (
	DEFAULT_NODE_VERSION = "22"
	DEFAULT_BUN_VERSION  = "latest"

	COREPACK_HOME = "/opt/corepack"

	// not used by npm, but many other tools: next, jest, webpack, etc
	NODE_MODULES_CACHE = "/app/node_modules/.cache"
)
View Source 
const (
	DefaultReactRouterOutputDirectory = "build/client/"
	ReactRouterConfigJS               = "react-router.config.js"
	ReactRouterConfigTS               = "react-router.config.ts"
)
View Source 
const (
	DefaultCaddyfilePath = "/Caddyfile"
	OUTPUT_DIR_VAR       = "SPA_OUTPUT_DIR"
)
View Source 
const (
	DefaultAngularStartCommand = "ng serve"
)
View Source 
const (
	DefaultAstroOutputDirectory = "dist"
)
View Source 
const (
	DefaultViteOutputDirectory = "dist"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AngularConfig added in v0.0.31 

type AngularConfig struct {
	Projects map[string]struct {
		Architect struct {
			Build struct {
				Builder string `json:"builder"`
				Options struct {
					OutputPath string `json:"outputPath"`
					Browser    string `json:"browser,omitempty"`
				} `json:"options"`
			} `json:"build"`
		} `json:"architect"`
	} `json:"projects"`
}

type NodeProvider 

type NodeProvider struct {
	// contains filtered or unexported fields
}

func (*NodeProvider) Build 

func (p *NodeProvider) Build(ctx *generate.GenerateContext, build *generate.CommandStepBuilder)

func (*NodeProvider) CleansePlan added in v0.13.0 

func (p *NodeProvider) CleansePlan(buildPlan *plan.BuildPlan)

func (*NodeProvider) DeploySPA added in v0.0.28 

func (p *NodeProvider) DeploySPA(ctx *generate.GenerateContext, build *generate.CommandStepBuilder) error

func (*NodeProvider) Detect 

func (p *NodeProvider) Detect(ctx *generate.GenerateContext) (bool, error)

func (*NodeProvider) GetNodeEnvVars 

func (p *NodeProvider) GetNodeEnvVars(ctx *generate.GenerateContext) map[string]string

func (*NodeProvider) GetPackageJson 

func (p *NodeProvider) GetPackageJson(app *app.App) (*PackageJson, error)

func (*NodeProvider) GetStartCommand added in v0.0.23 

func (p *NodeProvider) GetStartCommand(ctx *generate.GenerateContext) string

func (*NodeProvider) Initialize added in v0.0.23 

func (p *NodeProvider) Initialize(ctx *generate.GenerateContext) error

func (*NodeProvider) InstallMisePackages added in v0.0.23 

func (p *NodeProvider) InstallMisePackages(ctx *generate.GenerateContext, miseStep *generate.MiseStepBuilder)

func (*NodeProvider) InstallNodeDeps added in v0.0.23 

func (p *NodeProvider) InstallNodeDeps(ctx *generate.GenerateContext, install *generate.CommandStepBuilder)

func (*NodeProvider) Name 

func (p *NodeProvider) Name() string

func (*NodeProvider) Plan 

func (p *NodeProvider) Plan(ctx *generate.GenerateContext) error

func (*NodeProvider) PruneNodeDeps added in v0.0.23 

func (p *NodeProvider) PruneNodeDeps(ctx *generate.GenerateContext, prune *generate.CommandStepBuilder)

func (*NodeProvider) SetNodeMetadata added in v0.0.28 

func (p *NodeProvider) SetNodeMetadata(ctx *generate.GenerateContext)

func (*NodeProvider) StartCommandHelp added in v0.0.28 

func (p *NodeProvider) StartCommandHelp() string

type PackageJson 

type PackageJson struct {
	Name            string            `json:"name"`
	Version         string            `json:"version"`
	Scripts         map[string]string `json:"scripts"`
	PackageManager  *string           `json:"packageManager"`
	Dependencies    map[string]string `json:"dependencies"`
	DevDependencies map[string]string `json:"devDependencies"`
	Engines         map[string]string `json:"engines"`
	Main            string            `json:"main"`
	Workspaces      []string          `json:"-"`
}

func NewPackageJson 

func NewPackageJson() *PackageJson

func (*PackageJson) GetPackageManagerInfo added in v0.0.70 

func (p *PackageJson) GetPackageManagerInfo() (string, string)

parse a packageManager string in the format "name@version" or "name@version+extra". Returns the package manager name and version as separate strings. returns empty strings for both name and version if it can't be parsed

func (*PackageJson) GetScript added in v0.0.28 

func (p *PackageJson) GetScript(name string) string

func (*PackageJson) HasScript 

func (p *PackageJson) HasScript(name string) bool

func (*PackageJson) UnmarshalJSON added in v0.0.41 

func (p *PackageJson) UnmarshalJSON(data []byte) error

type PackageManager 

type PackageManager string
const (
	PackageManagerNpm       PackageManager = "npm"
	PackageManagerPnpm      PackageManager = "pnpm"
	PackageManagerBun       PackageManager = "bun"
	PackageManagerYarn1     PackageManager = "yarn1"
	PackageManagerYarnBerry PackageManager = "yarnberry"

	DEFAULT_PNPM_VERSION = "9"
)

func (PackageManager) GetInstallCache added in v0.0.23 

func (p PackageManager) GetInstallCache(ctx *generate.GenerateContext) string

GetCache returns the cache for the package manager

func (PackageManager) GetInstallFolder added in v0.0.35 

func (p PackageManager) GetInstallFolder(ctx *generate.GenerateContext) []string

func (PackageManager) GetPackageManagerPackages 

func (p PackageManager) GetPackageManagerPackages(ctx *generate.GenerateContext, packageJson *PackageJson, packages *generate.MiseStepBuilder)

GetPackageManagerPackages installs specific versions of package managers by analyzing the users code

func (PackageManager) Name 

func (p PackageManager) Name() string

func (PackageManager) PruneDeps added in v0.0.23 

func (p PackageManager) PruneDeps(ctx *generate.GenerateContext, prune *generate.CommandStepBuilder)

func (PackageManager) RunCmd 

func (p PackageManager) RunCmd(cmd string) string

func (PackageManager) RunScriptCommand 

func (p PackageManager) RunScriptCommand(cmd string) string

func (PackageManager) SupportingInstallFiles 

func (p PackageManager) SupportingInstallFiles(ctx *generate.GenerateContext) []string

SupportingInstallFiles returns a list of files that are needed to install dependencies

type PnpmWorkspace 

type PnpmWorkspace struct {
	Packages []string `yaml:"packages"`
}

type Workspace 

type Workspace struct {
	Root     *WorkspacePackage
	Packages []*WorkspacePackage
}

func NewWorkspace 

func NewWorkspace(app *app.App) (*Workspace, error)

NewWorkspace creates a new workspace from a package.json file

func (*Workspace) AllPackageJson added in v0.0.66 

func (w *Workspace) AllPackageJson() []*PackageJson

func (*Workspace) GetPackage 

func (w *Workspace) GetPackage(path string) *WorkspacePackage

GetPackage returns a workspace package by path

func (*Workspace) HasDependency added in v0.0.56 

func (w *Workspace) HasDependency(dependency string) bool

func (*Workspace) HasWorkspaces 

func (w *Workspace) HasWorkspaces() bool

HasWorkspaces returns true if this is a workspace root

type WorkspacePackage 

type WorkspacePackage struct {
	Path        string
	PackageJson *PackageJson
}

type WorkspacesConfig added in v0.0.41 

type WorkspacesConfig struct {
	Packages []string `json:"packages"`
}

type YarnRc added in v0.0.35 

type YarnRc struct {
	GlobalFolder string `yaml:"globalFolder"`
	NodeLinker   string `yaml:"nodeLinker"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.