node

package

v0.0.5 Latest Latest Go to latest Published: Feb 13, 2025 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/railwayapp/railpack

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type NodeProvider
type PackageJson
- func NewPackageJson() *PackageJson
- func (p *PackageJson) HasScript(name string) bool
type PackageManager
type PnpmWorkspace
type Workspace
- func NewWorkspace(app *app.App) (*Workspace, error)
- func (w *Workspace) GetPackage(path string) *WorkspacePackage
- func (w *Workspace) HasWorkspaces() bool
type WorkspacePackage

Constants ¶

View Source

const (
	DEFAULT_NODE_VERSION = "22"
	DEFAULT_BUN_VERSION  = "latest"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type NodeProvider ¶

type NodeProvider struct{}

func (*NodeProvider) Build ¶

func (p *NodeProvider) Build(ctx *generate.GenerateContext, install *generate.CommandStepBuilder, packageJson *PackageJson) (*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) Install ¶

func (p *NodeProvider) Install(ctx *generate.GenerateContext, packages *generate.MiseStepBuilder, packageJson *PackageJson) (*generate.CommandStepBuilder, error)

func (*NodeProvider) Name ¶

func (p *NodeProvider) Name() string

func (*NodeProvider) Packages ¶

func (p *NodeProvider) Packages(ctx *generate.GenerateContext, packageJson *PackageJson) (*generate.MiseStepBuilder, error)

func (*NodeProvider) Plan ¶

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

func (*NodeProvider) Setup ¶

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

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:"workspaces"`
}

func NewPackageJson ¶

func NewPackageJson() *PackageJson

func (*PackageJson) HasScript ¶

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

type PackageManager ¶

type PackageManager string

const (
	PackageManagerNpm   PackageManager = "npm"
	PackageManagerPnpm  PackageManager = "pnpm"
	PackageManagerBun   PackageManager = "bun"
	PackageManagerYarn1 PackageManager = "yarn1"
	PackageManagerYarn2 PackageManager = "yarn2"
)

func (PackageManager) GetPackageManagerPackages ¶

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

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

func (PackageManager) InstallDeps ¶

func (p PackageManager) InstallDeps(ctx *generate.GenerateContext, install *generate.CommandStepBuilder)

func (PackageManager) Name ¶

func (p PackageManager) Name() string

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(app *a.App) []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        *PackageJson
	Packages    []*WorkspacePackage
	PackageJson *PackageJson
}

func NewWorkspace ¶

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

NewWorkspace creates a new workspace from a package.json file

func (*Workspace) GetPackage ¶

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

GetPackage returns a workspace package by path

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
}

Source Files ¶

View all Source files

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