objectExtends the require capabilities to allow loading of google go script files as JS files.
String
* [#runGopherJS(goFile, gopherjs, [minify])](#GoLoader+runGopherJS) ⇒ Object
* [#runGoScript2JS(goFile, [options])](#GoLoader+runGoScript2JS) ⇒ String
* [#loadGoScript(goFile, goModule, [options])](#GoLoader+loadGoScript) ⇒ Object
### new GoLoader()
The GoLoader enables to load google go script files and to load them into the
node runtime as JS files.
### GoLoader#createGopherJSCommandArgs(goFile, [minify]) ⇒ String
Returns the gopher js command arguments.
**Returns**: String - The command arguments
**Access**: public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| goFile | String | | The google go script file path |
| [minify] | Boolean | false | True to minify the generated code |
### GoLoader#runGopherJS(goFile, gopherjs, [minify]) ⇒ Object
Runs the gopherjs converter process.
**Returns**: Object - The process execution output (see shelljs for more information)
**Access**: public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| goFile | String | | The google go script file path |
| gopherjs | String | | The gopherjs executable file location |
| [minify] | Boolean | false | True to minify the generated code |
### GoLoader#runGoScript2JS(goFile, [options]) ⇒ String
Converts the provided go file into JS script text.
**Returns**: String - The JS string of the converted go script
**Access**: public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| goFile | String | | The google go script file path |
| [options] | Object | | Optional runtime options |
| [options.minify] | Boolean | process.env.NODE_GO_REQUIRE_MINIFY | True to minify the generated code |
### GoLoader#loadGoScript(goFile, goModule, [options]) ⇒ Object
Converts the provided google go file into JS script and loads it into
the node runtime.
**Returns**: Object - The JS module
**Access**: public
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| goFile | String | | The go script file path |
| goModule | Object | | The module for the go script |
| [options] | Object | | Optional runtime options |
| [options.minify] | Boolean | process.env.NODE_GO_REQUIRE_MINIFY | True to minify the generated code |
## NodeGoRequire : object
Extends the require capabilities to allow loading of google go
script files as JS files.
**Kind**: global namespace
**Author**: Sagie Gur-Ari
**Example**
In order to use google go scripts under node, you need to first require this library as follows
```js
require('node-go-require');
```
Now you can require your google go files like any other javascript files, for example:
```js
const petGo = require('./pet.go');
const pet = petGo.pet.New('my pet');
console.log(pet.Name());
pet.SetName('new name...');
console.log(pet.Name());
```
Go source:
```go
package main
import "github.com/gopherjs/gopherjs/js"
type Pet struct {
name string
}
func New(name string) *js.Object {
return js.MakeWrapper(&Pet{name})
}
func (p *Pet) Name() string {
return p.name
}
func (p *Pet) SetName(name string) {
p.name = name
}
func main() {
js.Module.Get("exports").Set("pet", map[string]interface{}{
"New": New,
})
}
```
* [NodeGoRequire](#NodeGoRequire) : object
* [.goLoader](#NodeGoRequire.goLoader) : [GoLoader](#GoLoader)
* [.requireGo(goModule, fileName)](#NodeGoRequire.requireGo)
### NodeGoRequire.goLoader : [GoLoader](#GoLoader)
The GO loader instance.
**Access**: public
### NodeGoRequire.requireGo(goModule, fileName)
The node require implementation for google go scripts.
**Access**: public
| Param | Type | Description |
| --- | --- | --- |
| goModule | Object | The module for the go script |
| fileName | String | The go script file name |
================================================
FILE: inch.json
================================================
{
"files": {
"included": [
"*.js",
"lib/**/*.js",
"tasks/**/*.js"
],
"excluded": [
"**/Gruntfile.js",
"**/.eslintrc.js",
"**/stylelint.config.js"
]
}
}
================================================
FILE: index.js
================================================
'use strict';
module.exports = require('./lib/node-go-require');
================================================
FILE: lib/go-loader.js
================================================
'use strict';
const fs = require('fs');
const path = require('path');
const childProcess = require('child_process');
const vm = require('vm');
const extend = require('node.extend');
/*jslint debug: true*/
/*eslint-disable no-empty-function*/
/**
* The GoLoader enables to load google go script files and to load them into the
* node runtime as JS files.
*
* @author Sagie Gur-Ari
* @class GoLoader
* @public
*/
function GoLoader() {}
/*eslint-enable no-empty-function*/
/*jslint debug: false*/
/**
* Returns the gopher js command arguments.
*
* @function
* @memberof! GoLoader
* @public
* @param {String} goFile - The google go script file path
* @param {Boolean} [minify=false] - True to minify the generated code
* @returns {String} The command arguments
*/
GoLoader.prototype.createGopherJSCommandArgs = function (goFile, minify) {
const args = [
'build'
];
if (minify) {
args.push('-m');
}
args.push(goFile);
return args;
};
/**
* Runs the gopherjs converter process.
*
* @function
* @memberof! GoLoader
* @public
* @param {String} goFile - The google go script file path
* @param {String} gopherjs - The gopherjs executable file location
* @param {Boolean} [minify=false] - True to minify the generated code
* @returns {Object} The process execution output (see shelljs for more information)
*/
GoLoader.prototype.runGopherJS = function (goFile, gopherjs, minify) {
const args = this.createGopherJSCommandArgs(goFile, minify);
/*eslint-disable no-sync*/
/*jslint stupid: true*/
return childProcess.spawnSync(gopherjs, args, {
windowsHide: true
});
};
/*jslint stupid: false*/
/*eslint-enable no-sync*/
/**
* Converts the provided go file into JS script text.
*
* @function
* @memberof! GoLoader
* @public
* @param {String} goFile - The google go script file path
* @param {Object} [options] - Optional runtime options
* @param {Boolean} [options.minify=process.env.NODE_GO_REQUIRE_MINIFY] - True to minify the generated code
* @returns {String} The JS string of the converted go script
*/
GoLoader.prototype.runGoScript2JS = function (goFile, options) {
options = options || {};
if (options.minify === undefined) {
options.minify = (String(process.env.NODE_GO_REQUIRE_MINIFY).toLowerCase() === 'true');
}
//get current working directory
const cwd = process.cwd();
/*jslint nomen: true*/
const tempPath = path.join(__dirname, '../.temp');
/*jslint nomen: false*/
//get output JS file
let jsFile = goFile.substring(0, goFile.length - 'go'.length) + 'js';
jsFile = path.basename(jsFile);
const jsPath = path.join(tempPath, jsFile);
/*eslint-disable no-sync*/
/*jslint stupid: true*/
//set to a temp folder
if (!fs.existsSync(tempPath)) {
fs.mkdirSync(tempPath);
} else if (fs.existsSync(jsPath)) {
fs.unlinkSync(jsPath);
}
process.chdir(tempPath);
let gopherjs = 'gopherjs';
/*istanbul ignore next*/
if (process.env.GOPATH) {
gopherjs = path.join(process.env.GOPATH, 'bin', gopherjs);
}
const output = this.runGopherJS(goFile, gopherjs, options.minify);
process.chdir(cwd);
if (output.status !== 0) {
throw new Error('Failed to convert Go file to JS\n' + output.stdout + '\n' + output.stderr);
}
//read JS file
return fs.readFileSync(jsPath, {
encoding: 'utf8'
});
};
/*jslint stupid: false*/
/*eslint-enable no-sync*/
/**
* Converts the provided google go file into JS script and loads it into
* the node runtime.
*
* @function
* @memberof! GoLoader
* @public
* @param {String} goFile - The go script file path
* @param {Object} goModule - The module for the go script
* @param {Object} [options] - Optional runtime options
* @param {Boolean} [options.minify=process.env.NODE_GO_REQUIRE_MINIFY] - True to minify the generated code
* @returns {Object} The JS module
*/
GoLoader.prototype.loadGoScript = function (goFile, goModule, options) {
const jsString = this.runGoScript2JS(goFile, options);
/*jslint nomen: true*/
const context = extend({}, global, {
root: global.root,
module: goModule,
require: goModule.require.bind(goModule),
exports: goModule.exports,
__filename: goFile + '.js',
__dirname: path.resolve(goFile, '..')
});
/*jslint nomen: false*/
context.global = context;
return vm.runInNewContext(jsString, context, {
filename: goFile + '.js'
});
};
const goLoader = new GoLoader(); //singleton
module.exports = goLoader;
================================================
FILE: lib/node-go-require.js
================================================
'use strict';
/**
* Extends the require capabilities to allow loading of google go
* script files as JS files.
*
* @author Sagie Gur-Ari
* @namespace NodeGoRequire
* @example
* In order to use google go scripts under node, you need to first require this library as follows
* ```js
* require('node-go-require');
* ```
* Now you can require your google go files like any other javascript files, for example:
* ```js
* const petGo = require('./pet.go');
*
* const pet = petGo.pet.New('my pet');
* console.log(pet.Name());
* pet.SetName('new name...');
* console.log(pet.Name());
* ```
* Go source:
* ```go
* package main
*
* import "github.com/gopherjs/gopherjs/js"
*
* type Pet struct {
* name string
* }
*
* func New(name string) *js.Object {
* return js.MakeWrapper(&Pet{name})
* }
*
* func (p *Pet) Name() string {
* return p.name
* }
*
* func (p *Pet) SetName(name string) {
* p.name = name
* }
*
* func main() {
* js.Module.Get("exports").Set("pet", map[string]interface{}{
* "New": New,
* })
* }
* ```
*/
const goLoader = require('./go-loader');
/**
* The node require implementation for google go scripts.
*
* @function
* @alias NodeGoRequire.requireGo
* @memberof! NodeGoRequire
* @public
* @param {Object} goModule - The module for the go script
* @param {String} fileName - The go script file name
*/
const requireGo = function (goModule, fileName) {
goLoader.loadGoScript(fileName, goModule);
};
//use go loader to return a JS module
require.extensions['.go'] = requireGo;
module.exports = {
requireGo,
/**
* The GO loader instance.
*
* @member {GoLoader}
* @alias NodeGoRequire.goLoader
* @memberof! NodeGoRequire
* @public
*/
goLoader
};
================================================
FILE: package.json
================================================
{
"name": "node-go-require",
"version": "2.0.0",
"description": "Load Google GO files as any javascript modules under nodeJS runtime.",
"author": {
"name": "Sagie Gur-Ari",
"email": "sagiegurari@gmail.com"
},
"license": "Apache-2.0",
"homepage": "http://github.com/sagiegurari/node-go-require",
"repository": {
"type": "git",
"url": "http://github.com/sagiegurari/node-go-require.git"
},
"bugs": {
"url": "http://github.com/sagiegurari/node-go-require/issues"
},
"keywords": [
"go",
"require"
],
"main": "index.js",
"directories": {
"lib": "lib",
"test": "test/spec"
},
"scripts": {
"clean": "rm -Rf ./.nyc_output ./coverage",
"format": "js-beautify --config ./.jsbeautifyrc --file ./*.js ./lib/**/*.js ./test/**/*.js",
"lint-js": "eslint ./*.js ./lib/**/*.js ./test/**/*.js",
"lint-css": "stylelint --allow-empty-input ./docs/**/*.css",
"lint": "npm run lint-js && npm run lint-css",
"jstest": "mocha --exit ./test/spec/**/*.js",
"coverage": "nyc --reporter=html --reporter=text --reporter=lcovonly --check-coverage=true mocha --exit ./test/spec/**/*.js",
"docs": "jsdoc2md lib/**/*.js > ./docs/api.md",
"test": "npm run clean && npm run format && npm run lint && npm run docs && npm run coverage",
"postpublish": "git fetch && git pull"
},
"dependencies": {
"node.extend": "^2"
},
"devDependencies": {
"chai": "^4",
"eslint": "^8",
"js-beautify": "^1",
"jsdoc-to-markdown": "^8",
"mocha": "^10",
"nyc": "^15",
"rimraf": "^4",
"stylelint": "^13",
"stylelint-config-standard": "^22"
}
}
================================================
FILE: test/helpers/helper.js
================================================
'use strict';
const fs = require('fs');
const path = require('path');
const childProcess = require('child_process');
const chai = require('chai');
const assert = chai.assert;
module.exports = {
modifyTestLoader() {
let gopherjs = 'gopherjs';
const isWin = (/^win/).test(process.platform);
if (isWin) {
gopherjs = `${gopherjs}.exe`;
}
if (process.env.GOPATH) {
const goPath = process.env.GOPATH || '';
gopherjs = path.join(goPath, 'bin', gopherjs);
} else {
process.env.GOPATH = '';
}
/*jslint stupid: true */
if ((!gopherjs) || (!fs.existsSync(gopherjs))) {
console.log('Running tests without GO/gopherjs installed.');
childProcess.spawnSync = function (cmd, args) {
assert.isTrue(cmd.indexOf('gopherjs') !== -1);
const goFile = args[args.length - 1];
if (goFile.indexOf('error.go') !== -1) {
return {
status: 1,
stdio: 'mock error'
};
}
/*jslint nomen: true */
let jsPath = path.join(__dirname, 'pet-helper.js');
/*jslint nomen: false */
let jsString = fs.readFileSync(jsPath, {
encoding: 'utf8'
});
//get output JS file
const tempPath = '.';
let jsFile = goFile.substring(0, goFile.length - 'go'.length) + 'js';
jsFile = path.basename(jsFile);
jsPath = path.join(tempPath, jsFile);
if (args[1] === '-m') {
jsString = jsString.split('\n').join('');
}
fs.writeFileSync(jsPath, jsString, {
encoding: 'utf8'
});
return {
status: 0
};
};
}
/*jslint stupid: false */
}
};
================================================
FILE: test/helpers/main/error.go
================================================
package main
import (
"github.com/gopherjs/gopherjs/js"
)
type Pet struct {
name string
}
func (p *Pet) Name() string {
return p.name
}
func (p *Pet) SetName(newName string) {
p.name = newName
}
func New(name string) *Pet {
return &Pet{name}
}
func main() {
error error error....
js.Module.Get("exports").Set("pet", map[string]interface{}{
"New": New,
})
}
================================================
FILE: test/helpers/main/main.go
================================================
package main
import "github.com/gopherjs/gopherjs/js"
type Pet struct {
name string
}
func New(name string) *js.Object {
return js.MakeWrapper(&Pet{name})
}
func (p *Pet) Name() string {
return p.name
}
func (p *Pet) SetName(name string) {
p.name = name
}
func main() {
js.Module.Get("exports").Set("pet", map[string]interface{}{
"New": New,
})
}
================================================
FILE: test/helpers/main/pet.go
================================================
package main
import "github.com/gopherjs/gopherjs/js"
type Pet struct {
name string
}
func New(name string) *js.Object {
return js.MakeWrapper(&Pet{name})
}
func (p *Pet) Name() string {
return p.name
}
func (p *Pet) SetName(name string) {
p.name = name
}
func main() {
js.Module.Get("exports").Set("pet", map[string]interface{}{
"New": New,
})
}
================================================
FILE: test/helpers/main/vertex.go
================================================
package main
import (
"github.com/gopherjs/gopherjs/js"
"math"
)
type Vertex struct {
X, Y float64
}
func (v *Vertex) Abs() float64 {
return math.Sqrt(v.X*v.X + v.Y*v.Y)
}
func New(x float64, y float64) *Vertex {
return &Vertex{x, y}
}
func NewJS(x float64, y float64) *js.Object {
return js.MakeWrapper(New(x, y))
}
func main() {
js.Module.Get("exports").Set("vertex", map[string]interface{}{
"New": NewJS,
})
}
================================================
FILE: test/helpers/pet-helper.js
================================================
'use strict';
function Pet(name) {
this.name = name;
}
Pet.prototype.Name = function () {
return this.name;
};
Pet.prototype.SetName = function (name) {
this.name = name;
};
module.exports = {
pet: {
New(name) {
return new Pet(name);
}
}
};
================================================
FILE: test/helpers/pet.js
================================================
'use strict';
require('../..');
const mainGo = require('./main/pet.go');
const pet = mainGo.pet.New('my pet');
console.log(pet.Name());
pet.SetName('new name...');
console.log(pet.Name());
================================================
FILE: test/helpers/vertex.js
================================================
'use strict';
require('../..');
const jsModule = require('./main/vertex.go');
const vertex = jsModule.vertex.New(2, 6);
console.log(vertex.Abs());
================================================
FILE: test/spec/go-loader-spec.js
================================================
'use strict';
/*jslint stupid: true, nomen: true*/
const path = require('path');
const chai = require('chai');
const assert = chai.assert;
const rimraf = require('rimraf');
const goLoader = require('../../lib/go-loader');
require('../helpers/helper').modifyTestLoader();
describe('Go Loader', function () {
const tempPath = path.join(__dirname, '../../.temp');
rimraf.sync(tempPath);
describe('runGoScript2JS', function () {
it('simple', function () {
this.timeout(90000);
delete process.env.NODE_GO_REQUIRE_MINIFY;
const goFile = path.resolve(__dirname, '../helpers/main/main.go');
const js = goLoader.runGoScript2JS(goFile);
assert.isString(js);
assert.isTrue(js.length > 0);
});
it('minified', function () {
this.timeout(180000);
const goFile = path.resolve(__dirname, '../helpers/main/main.go');
process.env.NODE_GO_REQUIRE_MINIFY = 'FALSE';
const unminified = goLoader.runGoScript2JS(goFile);
assert.isString(unminified);
assert.isTrue(unminified.length > 0);
process.env.NODE_GO_REQUIRE_MINIFY = 'TRUE';
const minified = goLoader.runGoScript2JS(goFile);
assert.isString(minified);
assert.isTrue(minified.length > 0);
assert.isTrue(minified.length < unminified.length);
});
it('options', function () {
this.timeout(180000);
const goFile = path.resolve(__dirname, '../helpers/main/main.go');
process.env.NODE_GO_REQUIRE_MINIFY = 'FALSE';
const minified = goLoader.runGoScript2JS(goFile, {
minify: true //opposite of env
});
assert.isString(minified);
assert.isTrue(minified.length > 0);
process.env.NODE_GO_REQUIRE_MINIFY = 'TRUE';
const unminified = goLoader.runGoScript2JS(goFile, {
minify: false //opposite of env
});
assert.isString(unminified);
assert.isTrue(unminified.length > 0);
assert.isTrue(minified.length < unminified.length);
});
it('error', function () {
this.timeout(90000);
const goFile = path.resolve(__dirname, '../helpers/main/error.go');
try {
const js = goLoader.runGoScript2JS(goFile);
assert.notOk(js);
} catch (error) {
assert.isDefined(error);
}
});
});
describe('createGopherJSCommandArgs', function () {
it('no minify', function () {
const args = goLoader.createGopherJSCommandArgs('./test.go');
assert.deepEqual(args, [
'build',
'./test.go'
]);
});
it('minify false', function () {
const args = goLoader.createGopherJSCommandArgs('./test.go', false);
assert.deepEqual(args, [
'build',
'./test.go'
]);
});
it('minify true', function () {
const args = goLoader.createGopherJSCommandArgs('./test.go', true);
assert.deepEqual(args, [
'build',
'-m',
'./test.go'
]);
});
});
});
================================================
FILE: test/spec/index-spec.js
================================================
'use strict';
const chai = require('chai');
const assert = chai.assert;
require('../../');
describe('Index', function () {
it('require setup', function () {
assert.isFunction(require.extensions['.go']);
});
});
================================================
FILE: test/spec/node-go-require-spec.js
================================================
'use strict';
/*jslint stupid: true, nomen: true*/
const path = require('path');
const chai = require('chai');
const assert = chai.assert;
require('../../lib/node-go-require');
require('../helpers/helper').modifyTestLoader();
describe('Node Go', function () {
it('require setup', function () {
assert.isFunction(require.extensions['.go']);
});
it('require', function () {
this.timeout(90000);
const goFile = path.resolve(__dirname, '../helpers/main/main.go');
const jsModule = require(goFile);
const pet = jsModule.pet.New('my pet');
let output = pet.Name();
assert.equal('my pet', output);
pet.SetName('new name');
output = pet.Name();
assert.equal('new name', output);
});
});