hookney 1.1.4 → 1.2.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016-present, Belexos GmbH
+Copyright 2016-present, tbillenstein
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -1,7 +1,7 @@
 Hookney
 =======
 
-`Hookney` is a helper around self-referencing JSON objects for Node.js and the Browser.
+`Hookney` is a helper around self-referencing JSON objects for Node.js and the browser.
 `Hookney` supports reading from and writing to files. JSON files may contain comments.
 This makes `Hookney` ideal for handling configuration files.
 
@@ -27,15 +27,15 @@ const Hookney = require('hookney');
 `Hookney` has a single dependency to [lodash](https://lodash.com/), which must be loaded before using `Hookney`.
 
 You can download the latest release from the repository
-* [`hookney.js`](https://github.com/belexos/hookney/blob/master/hookney.js) unminified, including comments
-* [`hookney.min.js`](https://github.com/belexos/hookney/blob/master/hookney.min.js) minified version
+* [`hookney.js`](https://github.com/tbillenstein/hookney/blob/master/hookney.js) unminified, including comments
+* [`hookney.min.js`](https://github.com/tbillenstein/hookney/blob/master/hookney.min.js) minified version
 
 Load [lodash](https://lodash.com/) from a CDN or any other source.
 ```html
-<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.5/lodash.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.20/lodash.min.js"></script>
 
 <!-- Alternative CDN -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.5/lodash.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js"></script>
 
 <!-- Load from local node module -->
 <script src="node_modules/lodash/lodash.min.js"></script>
@@ -161,7 +161,7 @@ const config = Hookney.fromString(text).resolveReferences().json();
 // => config === { a: 1, b: "str", c: 1 }
 ```
 
-### Load JSON object from file and resolve references. JSON file may contain comments.
+### Load JSON object from a file and resolve references. JSON file may contain comments.
 
 ```js
 // Synchronous
@@ -180,7 +180,7 @@ Hookney.fromFile("/path/to/file.json", function(err, hookney)
 });
 ```
 
-Hookney.fromFile() and Hookney.fromFileSync() support an optional 'options' parameter.
+`Hookney.fromFile()` and `Hookney.fromFileSync()` support an optional `options` parameter.
 
 ```js
 const options = {
@@ -197,14 +197,15 @@ Hookney.fromFile("/path/to/file.json", options, function(err, hookney)
 });
 ```
 
-For details on the 'options' parameter, please refer to the 
+For details on the `options` parameter, please refer to the 
 [Node.js documentation](https://nodejs.org/api/fs.html#fs_fs_readfile_path_options_callback).
 
-In addition to the options described there, 1 additional parameter 'reviver' is supported.
-Please refer to the [JSON.parse() documentation](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse)
+In addition to the options described there, 1 additional parameter `reviver` is supported.
+Please refer to the 
+[JSON.parse() documentation](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse)
 for details.
 
-Hookney.fromFile() and Hookney.fromFileSync() are not available in the browser.
+`Hookney.fromFile()` and `Hookney.fromFileSync()` are not available in the browser.
 
 ### Write JSON object to file.
 
@@ -224,7 +225,7 @@ Hookney.writeFile("/path/to/file.json", function(err)
 });
 ```
 
-writeFile() and writeFileSync() support an optional 'options' parameter.
+`writeFile()` and `writeFileSync()` support an optional `options` parameter.
 
 ```js
 const options = {
@@ -243,29 +244,37 @@ Hookney.writeFile("/path/to/file.json", options, function(err)
 });
 ```
 
-For details on the 'options' parameter, please refer to the 
+For details on the `options` parameter, please refer to the 
 [Node.js documentation](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options).
 
-In addition to the options described there, 2 additional parameters 'replacer' and 'space' are supported.
-Please refer to the [JSON.stringify() documentation](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify)
+In addition to the options described there, 2 additional parameters `replacer` and `space` are supported.
+Please refer to the 
+[JSON.stringify() documentation](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify)
 for details.
 
-writeFile() and writeFileSync() are not available in the browser.
+`writeFile()` and `writeFileSync()` are not available in the browser.
 
 
 More examples
 -------------
-Please refer to the [test spec](https://github.com/belexos/hookney/blob/master/spec/HookneySpec.js) for more examples.
+Please refer to the [test spec](https://github.com/tbillenstein/hookney/blob/master/spec/HookneySpec.js) for more examples.
 
 
 Testing
 -------
-We are using [Jasmine testing framework](https://jasmine.github.io/index.html) and [Istanbul test coverage framework](https://istanbul.js.org/).
+We use 
+* [JSHint](https://jshint.com/) for static code analysis.
+* [Jasmine testing framework](https://jasmine.github.io/index.html) for testing.
+* [Karma test runner](https://karma-runner.github.io/latest/index.html) for testing in the browser.
+* [Istanbul test coverage framework](https://istanbul.js.org/) for tracking test coverage.
 
+Steps to be taken
 * Clone or download the repository.
-* Change into project directory.
+* Change into the project directory.
 * Use `npm install` to install all development dependencies.
+* Use `npm runt lint` to run static code analysis. 
 * Use `npm test` to run the tests. 
+* Use `npm run coverage` to track test coverage. 
 * The output should display successful execution results and a code coverage map.
 
 
@@ -273,33 +282,45 @@ Build
 -----
 * Clone or download the repository.
 * Change into project directory.
-* Use `grunt` in project directory to build `hookney.min.js` from `hookney.js`.
+* Use `npm run build` in project directory to build `hookney.min.js` from `hookney.js`.
 
 
 Contribution
 ------------
-Please use [Github issues](https://github.com/belexos/hookney/issues) for requests.
+Please use [Github issues](https://github.com/tbillenstein/hookney/issues) for requests.
 
 Pull requests are welcome.
 
 
 Issues
 ------
-We use GitHub issues to track bugs. Please ensure your bug description is clear and has sufficient instructions to be able to reproduce the issue.
+We use GitHub issues to track bugs. Please ensure your bug description is clear and has sufficient instructions to be 
+able to reproduce the issue.
 
-The absolute best way to report a bug is to submit a pull request including a new failing test which describes the bug. When the bug is fixed, your pull request can then be merged.
+The absolute best way to report a bug is to submit a pull request including a new failing test which describes the bug. 
+When the bug is fixed, your pull request can then be merged.
 
-The next best way to report a bug is to provide a reduced test case on jsFiddle or jsBin or produce exact code inline in the issue which will reproduce the bug.
+The next best way to report a bug is to provide a reduced test case on jsFiddle or jsBin or produce exact code inline 
+in the issue which will reproduce the bug.
 
 
 Support
 -------
-* Send us an email: [support@belexos.com](mailto:support@belexos.com)
-* Follow us on Twitter: [@belexos](http://twitter.com/belexos)
+* Send us an email: [tb@thomasbillenstein.com](mailto:tb@thomasbillenstein.com)
+* Follow us on Twitter: [@tbillenstein](https://x.com/tbillenstein/)
 
 
 Changelog
 ---------
+v1.2.0
+* Update npm modules.
+* Update and extend test environment.
+* Add static code analysis tool JSHint.
+* Add Karma test runner.
+* Fix JSHint issues.
+* Replace uglify-js by terser for minification.
+* Update README.
+
 v1.1.4
 * Update npm modules.
 
@@ -321,4 +342,5 @@ v1.0.0
 
 License
 -------
-Copyright (c) 2016-present, Belexos GmbH. `Hookney` is licensed under the [MIT License](https://github.com/belexos/hookney/blob/master/LICENSE).
+Copyright (c) 2016-present, tbillenstein. `Hookney` is licensed under the 
+[MIT License](https://github.com/tbillenstein/hookney/blob/master/LICENSE).

package/hookney.js

@@ -1,14 +1,15 @@
 /**
- * Hookney - Helper around self referencing JSON objects for Node.js and the Browser.
+ * Hookney - Helper around self referencing JSON objects for Node.js and the browser.
  *
- * @copyright: Copyright (c) 2016-present, Belexos GmbH
+ * @copyright: Copyright (c) 2016-present, tbillenstein
  *
- * @author: Br00ze <br00ze@belexos.com> (http://belexos.com)
+ * @author: tbillenstein <tb@thomasbillenstein.com> (https://thomasbillenstein.com)
  *
  * @license This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
 
+
 (function(window)
 {
 	const nodeEnv = typeof module === 'object' && module && typeof module.exports === 'object';
@@ -39,7 +40,7 @@
 
 		for (i = 0; i < l; i++)
 		{
-			_.merge(json, arguments[i])
+			_.merge(json, arguments[i]);
 		}
 
 		this.json = function()
@@ -68,7 +69,7 @@
 				if (!done)
 				{
 					done = options;
-					options = {}
+					options = {};
 				}
 
 				options = options || {};
@@ -206,7 +207,7 @@
 
 		for (i = 0; i < l; i++)
 		{
-			_.merge(json, arguments[i])
+			_.merge(json, arguments[i]);
 		}
 
 		return new Hookney(json);
@@ -232,7 +233,7 @@
 			if (!done)
 			{
 				done = options;
-				options = {}
+				options = {};
 			}
 
 			options = options || {};
@@ -286,7 +287,7 @@
 			catch (err)
 			{
 				err.message = path + ': ' + err.message;
-				throw err
+				throw err;
 			}
 		};
 	}
@@ -310,7 +311,7 @@
 
 		tokenizer.lastIndex = 0;
 
-		while (tmp = tokenizer.exec(json))
+		while ((tmp = tokenizer.exec(json)) !== null)
 		{
 			lc = RegExp.leftContext;
 			rc = RegExp.rightContext;

package/hookney.min.js

@@ -1,2 +1,2 @@
-/*! hookney V1.1.4, Copyright (c) 2016-present, Belexos GmbH. MIT licensed. */
-!function(a){function b(){"use strict";function a(c){var g,h,i,k;if(d(c))for(g in c)c.hasOwnProperty(g)&&(h=c[g],d(h)?a(h):e(h)?a(h):f(h)&&(c[g]=b(j,h)));else if(e(c))for(k=c.length,i=0;i<k;i++)h=c[i],d(h)?a(h):e(h)?a(h):f(h)&&(c[i]=b(j,h))}function b(c,d){const e=new RegExp(c,"gm").exec(d);var g;return e&&(g=i.get(k,e[1]),d=d===e[0]?g:d.replace(e[0],f(g)?g:JSON.stringify(g)),f(d)?d=b(c,d):"object"==typeof d&&a(d)),d}const c=arguments.length,k={};var l;for(l=0;l<c;l++)i.merge(k,arguments[l]);this.json=function(){return k},this.stringify=function(a,b){return JSON.stringify(k,a,b)},this.resolveReferences=function(){return a(k),this},g&&(this.writeFile=function(a,b,c){const d=this;c||(c=b,b={}),b=b||{},b.encoding||(b.encoding="utf8"),h.writeFile(a,this.stringify(b.replacer,b.space),b,function(a){a?c(a,null):c(null,d)})},this.writeFileSync=function(a,b){return b=b||{},b.encoding||(b.encoding="utf8"),h.writeFileSync(a,this.stringify(b.replacer,b.space),b),this})}function c(a){var b,c,d,e,f=/"|(\/\*)|(\*\/)|(\/\/)|\n|\r/g,g=!1,h=!1,i=!1,j=[],k=0,l=0;for(f.lastIndex=0;b=f.exec(a);)d=RegExp.leftContext,e=RegExp.rightContext,h||i||(c=d.substring(l),g||(c=c.replace(/(\n|\r|\s)*/g,"")),j[k++]=c),l=f.lastIndex,'"'!==b[0]||h||i?"/*"!==b[0]||g||h||i?"*/"!==b[0]||g||!h||i?"//"!==b[0]||g||h||i?"\n"!==b[0]&&"\r"!==b[0]||g||h||!i?h||i||/\n|\r|\s/.test(b[0])||(j[k++]=b[0]):i=!1:i=!0:h=!1:h=!0:(c=d.match(/(\\)*$/),g&&c&&c[0].length%2!=0||(g=!g),l--,e=a.substring(l));return j[k++]=e,j.join("")}function d(a){return"object"==typeof a&&!Array.isArray(a)}function e(a){return Array.isArray(a)}function f(a){return"string"==typeof a}const g="object"==typeof module&&module&&"object"==typeof module.exports,h=g?require("fs"):null,i=g?require("lodash"):a._,j="\\$\\{self\\:(.*?)\\}";g?module.exports=b:a.Hookney=b,b.from=function(){const a=arguments.length,c={};var d;for(d=0;d<a;d++)i.merge(c,arguments[d]);return new b(c)},b.fromString=function(a,d){var e={};return a&&f(a)&&a.length&&(a=c(a),e=JSON.parse(a,d)),new b(e)},g&&(b.fromFile=function(a,d,e){e||(e=d,d={}),d=d||{},d.encoding||(d.encoding="utf8"),h.readFile(a,d,function(f,g){if(f)return void e(f,null);g=c(g);try{e(null,b.fromString(g,d.reviver))}catch(f){f.message=a+": "+f.message,e(f,null)}})},b.fromFileSync=function(a,d){var e;d=d||{},d.encoding||(d.encoding="utf8"),e=h.readFileSync(a,d),e=c(e);try{return b.fromString(e,d.reviver)}catch(b){throw b.message=a+": "+b.message,b}})}(this);
+/*! hookney V1.2.1, Copyright (c) 2016-present, tbillenstein. MIT licensed. */
+!function(e){const n="object"==typeof module&&module&&"object"==typeof module.exports,t=n?require("fs"):null,r=n?require("lodash"):e._,i="\\$\\{self\\:(.*?)\\}";function o(){"use strict";const e=arguments.length,o={};var s;for(s=0;s<e;s++)r.merge(o,arguments[s]);function l(e){var n,t,r,o;if(c(e))for(n in e)e.hasOwnProperty(n)&&(c(t=e[n])||f(t)?l(t):u(t)&&(e[n]=g(i,t)));else if(f(e))for(o=e.length,r=0;r<o;r++)c(t=e[r])||f(t)?l(t):u(t)&&(e[r]=g(i,t))}function g(e,n){const t=new RegExp(e,"gm").exec(n);var i;return t&&(i=r.get(o,t[1]),n=n===t[0]?i:n.replace(t[0],u(i)?i:JSON.stringify(i)),u(n)?n=g(e,n):"object"==typeof n&&l(n)),n}this.json=function(){return o},this.stringify=function(e,n){return JSON.stringify(o,e,n)},this.resolveReferences=function(){return l(o),this},n&&(this.writeFile=function(e,n,r){const i=this;r||(r=n,n={}),(n=n||{}).encoding||(n.encoding="utf8"),t.writeFile(e,this.stringify(n.replacer,n.space),n,function(e){e?r(e,null):r(null,i)})},this.writeFileSync=function(e,n){return(n=n||{}).encoding||(n.encoding="utf8"),t.writeFileSync(e,this.stringify(n.replacer,n.space),n),this})}function s(e){var n,t,r,i,o=/"|(\/\*)|(\*\/)|(\/\/)|\n|\r/g,s=!1,c=!1,f=!1,u=[],l=0,g=0;for(o.lastIndex=0;null!==(n=o.exec(e));)r=RegExp.leftContext,i=RegExp.rightContext,c||f||(t=r.substring(g),s||(t=t.replace(/(\n|\r|\s)*/g,"")),u[l++]=t),g=o.lastIndex,'"'!==n[0]||c||f?"/*"!==n[0]||s||c||f?"*/"!==n[0]||s||!c||f?"//"!==n[0]||s||c||f?"\n"!==n[0]&&"\r"!==n[0]||s||c||!f?c||f||/\n|\r|\s/.test(n[0])||(u[l++]=n[0]):f=!1:f=!0:c=!1:c=!0:(t=r.match(/(\\)*$/),s&&t&&t[0].length%2!=0||(s=!s),g--,i=e.substring(g));return u[l++]=i,u.join("")}function c(e){return"object"==typeof e&&!Array.isArray(e)}function f(e){return Array.isArray(e)}function u(e){return"string"==typeof e}n?module.exports=o:e.Hookney=o,o.from=function(){const e=arguments.length,n={};var t;for(t=0;t<e;t++)r.merge(n,arguments[t]);return new o(n)},o.fromString=function(e,n){var t={};return e&&u(e)&&e.length&&(e=s(e),t=JSON.parse(e,n)),new o(t)},n&&(o.fromFile=function(e,n,r){r||(r=n,n={}),(n=n||{}).encoding||(n.encoding="utf8"),t.readFile(e,n,function(t,i){if(t)r(t,null);else{i=s(i);try{r(null,o.fromString(i,n.reviver))}catch(t){t.message=e+": "+t.message,r(t,null)}}})},o.fromFileSync=function(e,n){var r;(n=n||{}).encoding||(n.encoding="utf8"),r=s(r=t.readFileSync(e,n));try{return o.fromString(r,n.reviver)}catch(n){throw n.message=e+": "+n.message,n}})}(this);

package/package.json

@@ -1,19 +1,27 @@
 {
   "name": "hookney",
-  "version": "1.1.4",
-  "description": "Hookney is a helper around self referencing JSON objects for Node.js and the Browser.",
+  "version": "1.2.1",
+  "description": "Hookney is a helper around self referencing JSON objects for Node.js and the browser.",
   "main": "hookney.js",
   "directories": {
     "test": "test"
   },
   "scripts": {
-    "test": "nyc ./node_modules/.bin/jasmine",
-    "build": "grunt build"
+    "build": "grunt build",
+    "coverage": "nyc ./node_modules/.bin/jasmine",
+    "lint": "grunt jshint",
+    "test": "./node_modules/.bin/jasmine && npx karma start test/karma/karma.conf.js --single-run",
+    "test-node": "./node_modules/.bin/jasmine",
+    "test-browser": "npx karma start test/karma/karma.conf.js --single-run"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/belexos/hookney.git"
+    "url": "https://github.com/tbillenstein/hookney.git"
   },
+  "bugs": {
+    "url": "https://github.com/tbillenstein/hookney/issues"
+  },
+  "homepage": "https://github.com/tbillenstein/hookney#readme",
   "keywords": [
     "json",
     "self",
@@ -31,9 +39,8 @@
     "from file",
     "from string"
   ],
-  "author": "Br00ze <br00ze@belexos.com> (http://belexos.com)",
+  "author": "tbillenstein <tb@thomasbillenstein.com> (https://thomasbillenstein.com)",
   "license": "MIT",
-  "homepage": "https://github.com/belexos/hookney#readme",
   "nyc": {
     "exclude": [
       "**/*Spec.js"
@@ -44,13 +51,19 @@
     ]
   },
   "dependencies": {
-    "lodash": "^4.17.14"
+    "lodash": "^4.17.20"
   },
   "devDependencies": {
-    "grunt": "^1.0.4",
-    "grunt-contrib-uglify": "^2.3.0",
+    "grunt": "^1.6.1",
+    "grunt-contrib-jshint": "^3.2.0",
     "grunt-contrib-watch": "^1.1.0",
-    "jasmine": "^3.5.0",
-    "nyc": "^15.0.0"
+    "grunt-terser": "^2.0.0",
+    "jasmine": "^5.13.0",
+    "karma": "^6.4.4",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-coverage": "^2.2.1",
+    "karma-firefox-launcher": "^2.1.3",
+    "karma-jasmine": "^5.1.0",
+    "nyc": "^17.1.0"
   }
 }