Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doesdev/ngo
Run Go commands from Node or CLI, Go env not required
https://github.com/doesdev/ngo
Last synced: about 20 hours ago
JSON representation
Run Go commands from Node or CLI, Go env not required
- Host: GitHub
- URL: https://github.com/doesdev/ngo
- Owner: doesdev
- License: mit
- Created: 2016-11-13T04:15:38.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-29T10:49:47.000Z (over 1 year ago)
- Last Synced: 2024-09-21T12:25:15.852Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 165 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ngo [](https://npmjs.org/package/ngo) [](https://github.com/feross/standard) [](https://dependencyci.com/github/doesdev/ngo) [](https://ci.appveyor.com/project/doesdev/ngo) [](https://travis-ci.org/doesdev/ngo)
> Run Go commands from Node or CLI, Go env not required
Will download latest binaries locally if Go isn't already in PATH
### BONUS
If you run a command and it fails with "cannot find package..." we'll try to install
said package(s). YAYS. :relieved:
## local install
```sh
$ npm install --save ngo
```
## cli install
```sh
$ npm install --global ngo
```
## usage
#### cli usage
```sh
$ ngo version
# go version go1.8.3 windows/amd64
# to update the `ngo` install of Go (won't update system version)
$ ngo-update
# go version go1.9.4 windows/amd64
# to set the `ngo` install of Go to a specific version (won't update system version)
$ ngo-version 1.12.0
# go version go1.12.0 windows/amd64
# to run a `go get` installed binary use this bs
$ ngo-binary golint test/fixtures/errors.go
# test\fixtures\errors.go:13:5: error var unexp should have name of the form errFoo
```
#### programmatic usage
returns promise that resolves to `execa` style object without the `child_process` goodies
```js
const goOpts = {}
const ngo = require('ngo')(goOpts)
const golint = ngo.bin('golint')
ngo('version').then(console.log).catch(console.error)
/* {
stdout: 'go version go1.8.3 windows/amd64',
stderr: '',
code: 0,
failed: false,
killed: false,
signal: null,
cmd: 'C:\\Go\\bin\\go version'
} */
golint('main.go').then(console.log).catch(console.error)
```
## api
### const ngo = require('ngo')(`options`)
- **Purpose:** initialize `ngo`
- **Arguments:**
- **options** *[`Object` - optional]*
- **useLocal** *[`Boolean` `false`] - use locally downloaded Go binaries)*
- **update** *[`Boolean` `false`] - update local install to latest*
- **installDeps** *[`Boolean` `true`] - attempt to install missing packages*
- **env** *[`Object`] - environment vars to set for the Go command*
- **goRoot** *[`String`] - Go root path (ex. `/usr/local/go`)*
- **goPath** *[`String`] - Go workspace path (ex. `~/work`)*
- **Returns:** `Function` (`ngo`) which executes Go commands
### ngo(`commandArgs`, `options`)
- **Purpose:** - execute `go` commands
- **Arguments:**
- **commandArgs** *[`Array` | `String` - required] - argument(s) to call with `go` command*
- **options** *[`Object` - optional]*
- same options as [`child_process.spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)
- additonal options available same as [`execa`](https://github.com/sindresorhus/execa#options)
- **Returns:** `Promise` which resolves to [`execa`](https://github.com/sindresorhus/execa) styled object
### ngo.bin(`binary`)
- **Purpose:** - execute commands on binaries in the `GOBIN` directory
- **Arguments:**
- **binary** [`String`] - name of binary file to be executed in returned function
- **Returns:** `Function` (identical to `ngo`, but runs specified binary instead of `go`)
### ngo.env
this is a copy of ngo's `process.env` with the Go environment variables added to it
## License
MIT © [Andrew Carpenter](https://github.com/doesdev)