diff --git a/.bithoundrc b/.bithoundrc index 508a54e..6f3091a 100644 --- a/.bithoundrc +++ b/.bithoundrc @@ -62,6 +62,7 @@ "mocha", "phantomjs-prebuilt", "promiscuous", + "remark-lint", "rimraf", "sinon", "sinon-chai", diff --git a/README.md b/README.md index 85466a2..49ab2c4 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ See [contributing guide](.github/CONTRIBUTING.md) | Date | Version | Description | | ----------- | ------- | ----------- | -| 2016-12-20 | v1.0.21 | Maintenance | +| 2016-12-31 | v1.0.22 | Maintenance | | 2016-07-26 | v0.1.2 | Add integration test via docker | | 2016-07-25 | v0.1.1 | Maintenance | | 2015-02-14 | v0.0.16 | Modified tests and examples due to changes in gopherjs API | diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 3bd5d22..e4f484e 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,6 @@ | Date | Version | Description | | ----------- | ------- | ----------- | -| 2016-12-20 | v1.0.21 | Maintenance | +| 2016-12-31 | v1.0.22 | Maintenance | | 2016-07-26 | v0.1.2 | Add integration test via docker | | 2016-07-25 | v0.1.1 | Maintenance | | 2015-02-14 | v0.0.16 | Modified tests and examples due to changes in gopherjs API | diff --git a/docs/api.md b/docs/api.md index dd62885..598d5a3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -23,9 +23,9 @@ script files as JS files.
* [GoLoader](#GoLoader) * [new GoLoader()](#new_GoLoader_new) - * [#runGopherJS(goFile, gopherjs)](#GoLoader+runGopherJS) ⇒object
- * [#runGoScript2JS(goFile)](#GoLoader+runGoScript2JS) ⇒ string
- * [#loadGoScript(goFile, goModule)](#GoLoader+loadGoScript) ⇒ object
+ * [#runGopherJS(goFile, gopherjs)](#GoLoader+runGopherJS) ⇒ Object
+ * [#runGoScript2JS(goFile)](#GoLoader+runGoScript2JS) ⇒ String
+ * [#loadGoScript(goFile, goModule)](#GoLoader+loadGoScript) ⇒ Object
@@ -35,42 +35,42 @@ node runtime as JS files.
-### GoLoader#runGopherJS(goFile, gopherjs) ⇒ object
+### GoLoader#runGopherJS(goFile, gopherjs) ⇒ Object
Runs the gopherjs converter process.
-**Returns**: object
- The process execution output (see shelljs for more information)
+**Returns**: Object
- The process execution output (see shelljs for more information)
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
-| goFile | string
| The google go script file path |
-| gopherjs | string
| The gopherjs executable file location |
+| goFile | String
| The google go script file path |
+| gopherjs | String
| The gopherjs executable file location |
-### GoLoader#runGoScript2JS(goFile) ⇒ string
+### GoLoader#runGoScript2JS(goFile) ⇒ String
Converts the provided go file into JS script text.
-**Returns**: string
- The JS string of the converted go script
+**Returns**: String
- The JS string of the converted go script
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
-| goFile | string
| The google go script file path |
+| goFile | String
| The google go script file path |
-### GoLoader#loadGoScript(goFile, goModule) ⇒ object
+### GoLoader#loadGoScript(goFile, goModule) ⇒ Object
Converts the provided google go file into JS script and loads it into
the node runtime.
-**Returns**: object
- The JS module
+**Returns**: Object
- The JS module
**Access:** public
| Param | Type | Description |
| --- | --- | --- |
-| goFile | string
| The go script file path |
-| goModule | object
| The module for the go script |
+| goFile | String
| The go script file path |
+| goModule | Object
| The module for the go script |
@@ -142,6 +142,6 @@ The node require implementation for google go scripts.
| Param | Type | Description |
| --- | --- | --- |
-| goModule | object
| The module for the go script |
-| fileName | string
| The go script file name |
+| goModule | Object
| The module for the go script |
+| fileName | String
| The go script file name |
diff --git a/lib/go-loader.js b/lib/go-loader.js
index e82879b..4e510bc 100644
--- a/lib/go-loader.js
+++ b/lib/go-loader.js
@@ -28,9 +28,9 @@ function GoLoader() {}
* @function
* @memberof! GoLoader
* @public
- * @param {string} goFile - The google go script file path
- * @param {string} gopherjs - The gopherjs executable file location
- * @returns {object} The process execution output (see shelljs for more information)
+ * @param {String} goFile - The google go script file path
+ * @param {String} gopherjs - The gopherjs executable file location
+ * @returns {Object} The process execution output (see shelljs for more information)
*/
GoLoader.prototype.runGopherJS = function (goFile, gopherjs) {
return shell.exec('"' + gopherjs + '" build "' + goFile + '"', {
@@ -44,8 +44,8 @@ GoLoader.prototype.runGopherJS = function (goFile, gopherjs) {
* @function
* @memberof! GoLoader
* @public
- * @param {string} goFile - The google go script file path
- * @returns {string} The JS string of the converted go script
+ * @param {String} goFile - The google go script file path
+ * @returns {String} The JS string of the converted go script
*/
GoLoader.prototype.runGoScript2JS = function (goFile) {
//get current working directory
@@ -94,9 +94,9 @@ GoLoader.prototype.runGoScript2JS = function (goFile) {
* @function
* @memberof! GoLoader
* @public
- * @param {string} goFile - The go script file path
- * @param {object} goModule - The module for the go script
- * @returns {object} The JS module
+ * @param {String} goFile - The go script file path
+ * @param {Object} goModule - The module for the go script
+ * @returns {Object} The JS module
*/
GoLoader.prototype.loadGoScript = function (goFile, goModule) {
var jsString = this.runGoScript2JS(goFile);
diff --git a/lib/node-go-require.js b/lib/node-go-require.js
index ab38ba6..51fbfed 100644
--- a/lib/node-go-require.js
+++ b/lib/node-go-require.js
@@ -59,8 +59,8 @@ var goLoader = require('./go-loader');
* @alias NodeGoRequire.requireGo
* @memberof! NodeGoRequire
* @public
- * @param {object} goModule - The module for the go script
- * @param {string} fileName - The go script file name
+ * @param {Object} goModule - The module for the go script
+ * @param {String} fileName - The go script file name
*/
var requireGo = function (goModule, fileName) {
goLoader.loadGoScript(fileName, goModule);
diff --git a/package.json b/package.json
index 317b0ec..ea4dfa8 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "node-go-require",
- "version": "1.0.21",
+ "version": "1.0.22",
"description": "Load Google GO files as any javascript modules under nodeJS runtime.",
"author": {
"name": "Sagie Gur-Ari",