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