development (#13)

* Approximately 3–4 times faster parsing than 5.0.x versions.
* JSON-Z will now honor an object’s `toJSON5()` method, if present, at higher priority than `toJSON()`, and lower priority than `toJSONZ()`.
* Updated the allowed CLI arguments to match the latest JSON5 CLI.

Author: kshetline

.eslintrc.json

@@ -4,12 +4,13 @@
   "plugins": ["chai-friendly", "@typescript-eslint"],
   "extends": [
     "standard",
-    "plugin:node/recommended"
+    "plugin:n/recommended"
   ],
   "parserOptions": {
     "sourceType": "module",
     "ecmaVersion": 2023
   },
+  "ignorePatterns": ["*.d.ts"],
   "rules": {
     "array-bracket-spacing": [
       "error",
@@ -20,6 +21,10 @@
       "as-needed"
     ],
     "brace-style": ["error", "stroustrup", { "allowSingleLine": true }],
+    "camelcase": [
+      "error",
+      { "allow": ["^LOWER_[a-z]", "^_\\$"] }
+    ],
     "comma-dangle": [
       "error",
       "never"
@@ -31,9 +36,10 @@
     ],
     "no-process-exit": "off",
     "no-prototype-builtins": "off",
-    "node/no-unpublished-require": "off",
-    "node/no-unsupported-features/es-syntax": "off",
-    "node/shebang": "off",
+    "n/no-process-exit": "off",
+    "n/no-unpublished-require": "off",
+    "n/no-unsupported-features/es-syntax": "off",
+    "n/shebang": "off",
     "no-unused-expressions": "off",
     "chai-friendly/no-unused-expressions": "error",
     "object-curly-spacing": [
@@ -51,6 +57,11 @@
         "named": "never",
         "asyncArrow": "always"
       }
+    ],
+    "yoda": [
+      "error",
+      "never",
+      { "exceptRange": true }
     ]
   },
   "overrides": [

CHANGELOG.md

@@ -1,3 +1,9 @@
+### 5.1.0
+
+* Approximately 3–4 times faster parsing than 5.0.x versions.
+* JSON-Z will now honor an object’s `toJSON5()` method, if present, at higher priority than `toJSON()`, and lower priority than `toJSONZ()`.
+* Updated the allowed CLI arguments to match the latest JSON5 CLI.
+
 ### 5.0.1
 
 * Eliminated `minimist` dependency. (Package is now dependency-free.)

GRAMMAR.md

@@ -113,7 +113,7 @@ decimal-sequence = decimal-digit, { [ "_" ], decimal-digit } ;
 
 non-octal-sequence = non-octal-digit, { [ "_" ], non-octal-digit } ;
 
-hex = "0x", hex-digit, { [ "_" ], hex-digit } ;
+hex (* JSON5 *) = "0x", hex-digit, { [ "_" ], hex-digit } ;
 
 floating = ( ( ( decimal-sequence, ".", [ decimal-sequence ] | ".", decimal-sequence ), [ exponent ] ) | decimal-sequence, exponent ), [ "d" (* JSON-Z *) | "n" (* JSON-Z / integer only *) | "m" (* JSON-Z *) ] ;
 
@@ -141,7 +141,7 @@ octal (* JSON-Z *) = "0o", { octal-digit }- ;
 
 decimal = { decimal-digit }- ;
 
-hex = "0x", { hex-digit }- ;
+hex (* JSON5 *) = "0x", { hex-digit }- ;
 
 floating = { decimal-digit }-, ( ( ".", { decimal-digit }-, [ exponent ]) | ( exponent ) ), [ "d" (* JSON-Z *) | "n" (* JSON-Z / integer only *) | "m" (* JSON-Z *) ] ;
 
@@ -155,13 +155,13 @@ exponent = ("E" | 'e'), [ sign ], { decimal-digit }- ;
 ```plantuml
 @startebnf
 
-string = double-quoted-string | single-quoted-string | backtick-quoted-string (* JSON-Z *) ;
+string = double-quoted-string | single-quoted-string (* JSON5 *) | backtick-quoted-string (* JSON-Z *) ;
 
 double-quoted-string = '"', { safe-string-character | "'" | "`" | escape }, '"';
 
-single-quoted-string = "'", { safe-string-character | '"' | "`" | escape }, "'";
+single-quoted-string (* JSON5 *) = "'", { safe-string-character | '"' | "`" | escape }, "'";
 
-backtick-quoted-string = "`", { safe-string-character (* Note: the sequence ${ must be escaped as $\{ *) | "'" | '"' | escape }, "`";
+backtick-quoted-string (* JSON-Z *) = "`", { safe-string-character (* Note: the sequence ${ must be escaped as $\{ *) | "'" | '"' | escape }, "`";
 
 escape = "\", ( simple-escape | short-escape (* JSON5 *) | unicode-escape ) ;
 

README.md

@@ -40,7 +40,7 @@ This JavaScript library is the official reference implementation for JSON-Z pars
 
 ## Summary of Features
 
-The following features, which are not supported in standard JSON, have been added to JSON-Z. Items in **bold** are unique to JSON-Z.
+The following features, which are not supported in standard JSON, have been added to JSON-Z, with many inherited from JSON5. Items in **bold** are unique to JSON-Z.
 
 ### Objects
 
@@ -270,17 +270,18 @@ This works very much like [`JSON.stringify`](https://developer.mozilla.org/en-US
 
 A JSON-Z string representing the value.
 
-#### Using obj.toJSON() and obj.toJSONZ()
+#### Using obj.toJSON(), obj.toJSON5(), and obj.toJSONZ()
 
 For use with the standard `JSON.stringify()`, any object being stringified can have an optional `toJSON()` method. This way an object can explicitly tell `JSON.stringify()` how its value should be represented.
 
 JSON-Z can also use an object's `toJSON()` method, but other factors might take priority as follows:
 
 1. If an object has a `toJSONZ()` method, this takes the highest priority. The value returned by `toJSONZ()` can be further modified by any replacer function in effect. Note that when `toJSONZ()` is called, two arguments are passed to this function: `key` (an array index or object property name) and `holder` (the parent array or parent object (if any) of the object).
-2. If an object can be converted by an extended type handler, that has the next priority. When `ExtendedTypeMode.AS_FUNCTIONS` is in effect, a conversion handled by an extended type handler is final. Replacer functions can, however, further act upon extended type conversions when `ExtendedTypeMode.AS_OBJECTS` is in effect.
-3. `toJSON()` is the next possible value conversion, but only if `toJSONZ()` has not already taken priority.
-4. Any active replacer function is then applied.
-5. Finally, special handling for `BigInt` and "big decimal" numbers takes place.
+2. An object’s `toJSON5()` method has the next priority if no `toJSONZ()` method exists.
+3. If an object can be converted by an extended type handler, that has the next priority. When `ExtendedTypeMode.AS_FUNCTIONS` is in effect, a conversion handled by an extended type handler is final. Replacer functions can, however, further act upon extended type conversions when `ExtendedTypeMode.AS_OBJECTS` is in effect.
+4. `toJSON()` is the next possible value conversion if none of the three above conditions apply.
+5. Any active replacer function is then applied.
+6. Finally, special handling for `BigInt` and "big decimal" numbers takes place.
 
 ### JSONZ.hasBigDecimal()