rison-node - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -1,12 +0,31 @@
-# 0.3.0 (2015-12-18)
+### Changelog
 
-- Handle Date type values via `.toJSON()`
+#### [v1.0.1](https://github.com/w33ble/rison/compare/v1.0.0...v1.0.1) (16 April 2018)
+- docs: update readme [`09bbabf`](https://github.com/w33ble/rison/commit/09bbabf3959d77bf26caa84f7221b3625992d27c)
 
-# 0.2.0 (2015-12-18)
+### [v1.0.0](https://github.com/w33ble/rison/compare/v0.3.1...v1.0.0) (15 April 2016)
+- Declare variable at top of function scope in next() [`a3ea585`](https://github.com/w33ble/rison/commit/a3ea585d9417c00747ff04a74732bfd6e4f40b3e)
 
-- Act like JSON.stringify, ignore undefined values
+#### [v0.3.1](https://github.com/w33ble/rison/compare/v0.3.0...v0.3.1) (3 February 2016)
+- add some basic input validation to decode [`fbf932a`](https://github.com/w33ble/rison/commit/fbf932a6bc98161ba46190c6906988671b4b1abe)
 
-# 0.1.0 (2015-12-18)
+#### [v0.3.0](https://github.com/w33ble/rison/compare/v0.2.0...v0.3.0) (18 December 2015)
+- update changelog [`edeb915`](https://github.com/w33ble/rison/commit/edeb915fae9d753907cda33857a8631a26fa3c4e)
 
-- Create npm module from https://github.com/Nanonid/rison
-- Wrap in UMD on publish, no actual changes
+#### [v0.2.0](https://github.com/w33ble/rison/compare/v0.1.0...v0.2.0) (18 December 2015)
+- update changelog [`8c8f0eb`](https://github.com/w33ble/rison/commit/8c8f0eb56ad3f9ea2a43aa40522f8c979f938181)
+
+#### v0.1.0 (18 December 2015)
+- Use a cross-platform approach to global string replacements [`#4`](https://github.com/w33ble/rison/pull/4)
+- add CHANGELOG [`e8511c2`](https://github.com/w33ble/rison/commit/e8511c2a98dcc34ae7681ad539e61c5c8470336c)
+- just return on undefined [`74b56f3`](https://github.com/w33ble/rison/commit/74b56f319d7c1367607a1ae93c9e5a4d53124a20)
+- support Date types via toJSON [`621cc15`](https://github.com/w33ble/rison/commit/621cc15f79bf87d53be3c7437b92242d7f96d9d1)
+- include package file [`050ed24`](https://github.com/w33ble/rison/commit/050ed2439399df3716fc73ed28845ab09aa8cf69)
+- update package.json [`939e0ed`](https://github.com/w33ble/rison/commit/939e0ed812feb6338d93b4e8266df4216b353880)
+- Create LICENSE.md [`c0fe910`](https://github.com/w33ble/rison/commit/c0fe91066d9f62cc6f9893026d51de98fb1fbe53)
+- Add Python-Rison mirror [`e55200b`](https://github.com/w33ble/rison/commit/e55200b19662e7bc6cddd6cc5f1d90fbd172e8e3)
+- Add rison.js [`3c6922b`](https://github.com/w33ble/rison/commit/3c6922b45d89cd0efcacbb59d8998b3f9c6f1807)
+- Update README.md [`2c2a13a`](https://github.com/w33ble/rison/commit/2c2a13ac5fde1671e0d918b1ca8b01de559bca6d)
+- Update README.md [`4092df0`](https://github.com/w33ble/rison/commit/4092df0496488d260e6bff82a5d4428e4f21821d)
+- Initial commit [`199d23d`](https://github.com/w33ble/rison/commit/199d23df569d6f8de4a5a6f165a9ecc7a5e13ae7)
+

package.json

 {
   "name": "rison-node",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "authors": [
@@ -8,3 +8,6 @@ "Nanonid (https://github.com/Nanonid)",
     "Joe Fleming (https://github.com/w33ble)",
-    "Court Ewing (https://github.com/epixa)"
+    "Court Ewing (https://github.com/epixa)",
+    "Jonas Finnemann Jensen (https://github.com/jonasfj)",
+    "Sam Presnal",
+    "bryanrideshark (https://github.com/bryanrideshark)"
   ],
@@ -17,5 +20,5 @@ "description": "data serialization format optimized for compactness in URIs",
   },
-  "main": "build/rison.js",
+  "main": "js/rison.js",
   "files": [
-    "build",
+    "js",
     "LICENSE.md",
@@ -25,13 +28,29 @@ "README.md",
   ],
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "auto-changelog": {
+    "output": "CHANGELOG.md",
+    "template": "cltemplate.hbs",
+    "ignoreCommitPattern": "(chore|test)|(add|Add).+(author|Author|contributor|Contributor)",
+    "commitLimit": false
+  },
   "scripts": {
-    "clean": "if [ -d build ]; then rm -r build; fi",
-    "build": "npm run clean; mkdir build; (echo 'var rison = {};'; cat js/rison.js; echo 'return rison;') | umd rison > build/rison.js",
-    "prepublish": "npm run test && npm run build",
-    "pretest": "npm run build",
-    "test": "tape tests/*.js"
+    "preversion": "npm run test",
+    "version": "npm run changelog",
+    "changelog": "auto-changelog",
+    "test": "npm run lint && tape tests/*.js",
+    "lint": "eslint \"js/*.js\" \"tests/*.js\"",
+    "prepush": "npm run test"
   },
   "devDependencies": {
-    "tape": "^4.2.2",
-    "umd": "^3.0.1"
+    "auto-changelog": "^1.4.6",
+    "eslint": "^4.19.1",
+    "eslint-config-prettier": "^2.9.0",
+    "eslint-plugin-prettier": "^2.6.0",
+    "husky": "^0.14.3",
+    "prettier": "^1.12.0",
+    "tape": "^4.2.2"
   }
 }

README.md

 rison
 =====
 
-Rison mirror (http://mjtemplate.org/examples/rison.html)
+Rison mirror of now dead site (http://mjtemplate.org/examples/rison.html)
 
@@ -19,6 +19,40 @@
 
-  * [rison.js](../../dist/mjt-0.9.2/rison.js) includes a Javascript Rison encoder (based on [Douglas Crockford](http://json.org)'s [json.js](http://json.org/json.js)) and decoder (based on [Oliver Steele](http://osteele.com)'s [JSON for OpenLaszlo](http://osteele.com/sources/openlaszlo/json/)). 
+  * [rison.js](./js/rison.js) includes a Javascript Rison encoder (based on [Douglas Crockford](http://json.org)'s [json.js](http://json.org/json.js)) and decoder (based on [Oliver Steele](http://osteele.com)'s [JSON for OpenLaszlo](http://osteele.com/sources/openlaszlo/json/)). 
   * [rison.py](http://freebase-python.googlecode.com/svn/trunk/freebase/rison.py) contains a decoder in Python. 
   * [Tim Fletcher](http://tfletcher.com/dev/) has implemented [Rison in Ruby](http://rison.rubyforge.org/) including both encoder and decoder. 
 
+
+### Quick Start (Javascript)
+
+Install with npm or copy in `js/rison.js` manually, the script is
+compatible with AMD and CommonJS (such as browserify or node), you
+can also drop it into a `<script>` tag, creating the `rison` global.
+
+Once installed you have the following methods available:
+```js
+var rison = require('rison');
+
+rison.encode({any: "json", yes: true});
+rison.encode_array(["A", "B", {supportsObjects: true}]);
+rison.encode_object({supportsObjects: true, ints: 435});
+
+// Rison
+rison.encode({any: "json", yes: true});
+// (any:json,yes:!t)
+
+// O-Rison
+rison.encode_object({supportsObjects: true, ints: 435});
+// ints:435,supportsObjects:!t
+
+// A-Rison
+rison.encode_array(["A", "B", {supportsObjects: true}]);
+// A,B,(supportsObjects:!t)
+
+// Decode with: rison.decode, rison.decode_object, rison.decode_array
+// Example:
+rison.decode('(any:json,yes:!t)');
+// { any: 'json', yes: true }
+```
+
+
 ### Why another data serialization format?
@@ -25,0 +59,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

41511

increased by10.26%

Lines of code

467

increased by2.41%

Number of lines in readme file

257

increased by15.25%

Worsened metrics

Dev dependency count

7

increased by250%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes