README
¶
gode
gode runs a sandboxed node installation to run node code and install npm packages.
Usage
Gode will autoinstall Node and npm if it's not in the specified working directory.
To use gode, first give it a working directory. In this case, ~/.gode. You would need to already have a homeDir variable for this to work.
c := NewClient(filepath.Join(homeDir, ".gode"))
Next, call c.Setup() to ensure that gode is setup properly in that working directory.
err := c.Setup()
if err != nil {
panic(err)
}
Finally, execute a node script. This returns an *os/exec.Cmd:
output, err := c.RunScript(`console.log("hello world!")`).CombinedOutput()
if err != nil {
panic(err)
}
fmt.Println(string(output))
Or install packages:
err := c.InstallPackages("request")
if err != nil {
panic(err)
}
Meta
Documentation
¶
Overview ¶
Package gode runs a sandboxed node installation to run node code and install npm packages.
Index ¶
- Constants
- func ClearCache() error
- func DebugScript(script string) *exec.Cmd
- func InstallPackages(packages ...string) error
- func IsSetup() (bool, error)
- func NeedsUpdate() (bool, error)
- func OutdatedPackages(names ...string) (map[string]string, error)
- func RebuildPackages() error
- func RemovePackages(packages ...string) error
- func RunScript(script string) *exec.Cmd
- func SetRootPath(root string)
- func Setup() error
- type Package
- type Target
Examples ¶
Constants ¶
const NpmVersion = "6.13.7"
NpmVersion is the requested npm version
const Version = "12.16.1"
Version is the requested node version
Variables ¶
This section is empty.
Functions ¶
func DebugScript ¶
DebugScript is the same as RunScript except it launches with node-inspector
func InstallPackages ¶
InstallPackages installs a npm packages.
func NeedsUpdate ¶
NeedsUpdate returns true if it is using a node that isn't the latest version
func OutdatedPackages ¶
OutdatedPackages returns a map of packages and their latest version
func RebuildPackages ¶ added in v1.0.0
func RebuildPackages() error
RebuildPackages rebuilds installed npm packages.
func RemovePackages ¶
RemovePackages removes a npm packages.
func RunScript ¶
RunScript runs a given script in node Returns an *os/exec.Cmd instance
Example ¶
SetRootPath(os.TempDir())
err := Setup()
if err != nil {
panic(err)
}
cmd := RunScript(`console.log("hello world!")`)
output, err := cmd.CombinedOutput()
if err != nil {
panic(err)
}
fmt.Println(string(output))
Output: hello world!
Source Files