fast-json-stringify 5.16.1 → 6.0.1

package/.github/dependabot.yml

@@ -9,5 +9,5 @@ updates:
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"
     open-pull-requests-limit: 10

package/.github/workflows/benchmark.yml

@@ -65,9 +65,9 @@ jobs:
       pull-requests: write
     steps:
       - name: Comment PR
-        uses: thollander/actions-comment-pull-request@v2
+        uses: thollander/actions-comment-pull-request@v3
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           message: |
             **PR**:
             ```
@@ -77,7 +77,7 @@ jobs:
             ```
             ${{ needs.benchmark.outputs.MASTER-BENCH }}
             ```
-            
+
       - uses: actions-ecosystem/action-remove-labels@v1
         with:
           labels: |

package/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   test:
-    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
+    uses: fastify/workflows/.github/workflows/plugins-ci.yml@v5
     with:
       license-check: true
       lint: true

package/README.md

@@ -1,8 +1,8 @@
 # fast-json-stringify
 
-![CI](https://github.com/fastify/fast-json-stringify/workflows/CI/badge.svg)
+[![CI](https://github.com/fastify/fast-json-stringify/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fast-json-stringify/actions/workflows/ci.yml)
 [![NPM version](https://img.shields.io/npm/v/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
 [![NPM downloads](https://img.shields.io/npm/dm/fast-json-stringify.svg?style=flat)](https://www.npmjs.com/package/fast-json-stringify)
 
 
@@ -70,7 +70,7 @@ compile-json-stringify date format x 1,125,735 ops/sec ±0.19% (98 runs sampled)
 - <a href="#security">`Security Notice`</a>
 - <a href="#debug">`Debug Mode`</a>
 - <a href="#standalone">`Standalone Mode`</a>
-- <a href="#acknowledgements">`Acknowledgements`</a>
+- <a href="#acknowledgments">`Acknowledgments`</a>
 - <a href="#license">`License`</a>
 
 
@@ -111,7 +111,7 @@ console.log(stringify({
 <a name="options"></a>
 ## Options
 
-Optionally, you may provide to `fast-json-stringify` an option object as second parameter:
+Optionally, you may provide to `fast-json-stringify` an option object as the second parameter:
 
 ```js
 const fastJson = require('fast-json-stringify')
@@ -165,7 +165,7 @@ And nested ones, too.
 | `date`      | `2020-04-03`               |
 | `time`      | `09:11:08`                 |
 
-**Note**: In the case of string formatted Date and not Date Object, there will be no manipulation on it. It should be properly formatted.
+**Note**: In the case of a string formatted Date and not Date Object, there will be no manipulation on it. It should be properly formatted.
 
 Example with a Date object:
 
@@ -290,7 +290,7 @@ console.log(stringify(obj)) // '{"matchfoo":"42","otherfoo":"str","matchnum":3,"
 *additionalProperties* must be an object or a boolean, declared in this way: `{ type: 'type' }`.
 *additionalProperties* will work only for the properties that are not explicitly listed in the *properties* and *patternProperties* objects.
 
-If *additionalProperties* is not present or is set to `false`, every property that is not explicitly listed in the *properties* and *patternProperties* objects,will be ignored, as described in <a href="#missingFields">Missing fields</a>.
+If *additionalProperties* is not present or is set to `false`, every property that is not explicitly listed in the *properties* and *patternProperties* objects will be ignored, as described in <a href="#missingFields">Missing fields</a>.
 Missing fields are ignored to avoid having to rewrite objects before serializing. However, other schema rules would throw in similar situations.
 If *additionalProperties* is set to `true`, it will be used by `JSON.stringify` to stringify the additional properties. If you want to achieve maximum performance, we strongly encourage you to use a fixed schema where possible.
 The additional properties will always be serialized at the end of the object.
@@ -543,12 +543,12 @@ const stringify = fastJson(schema, { schema: externalSchema })
 
 <a name="long"></a>
 #### Long integers
-By default the library will handle automatically [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt).
+By default, the library will handle automatically [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt).
 
 <a name="integer"></a>
 #### Integers
 The `type: integer` property will be truncated if a floating point is provided.
-You can customize this behaviour with the `rounding` option that will accept [`round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round), [`ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil), [`floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor) or [`trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc). Default is `trunc`:
+You can customize this behavior with the `rounding` option that will accept [`round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round), [`ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil), [`floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor), or [`trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc). Default is `trunc`:
 
 ```js
 const stringify = fastJson(schema, { rounding: 'ceil' })
@@ -650,8 +650,8 @@ const stringify = fastJson({
 
 ##### Benchmarks
 
-For reference, here goes some benchmarks for comparison over the three
-mechanisms. Benchmarks conducted on an old machine.
+For reference, here are some benchmarks for comparison over the three
+mechanisms. Benchmarks were conducted on an old machine.
 
 - Machine: `ST1000LM024 HN-M 1TB HDD, Intel Core i7-3610QM @ 2.3GHz, 12GB RAM, 4C/8T`.
 - Node.js `v16.13.1`
@@ -678,7 +678,7 @@ expose your application to remote attacks.
 
 Users are responsible for sending trusted data. `fast-json-stringify` guarantees that you will get
 a valid output only if your input matches the schema or can be coerced to the schema. If your input
-doesn't match the schema, you will get undefined behavior. 
+doesn't match the schema, you will get undefined behavior.
 
 <a name="debug"></a>
 ### Debug Mode
@@ -699,7 +699,7 @@ const debugCompiled = fastJson({
 
 console.log(debugCompiled) // it is a object contain code, ajv instance
 const rawString = debugCompiled.code // it is the generated code
-console.log(rawString) 
+console.log(rawString)
 
 const stringify = fastJson.restore(debugCompiled) // use the generated string to get back the `stringify` function
 console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"Foo"}'
@@ -728,12 +728,12 @@ const stringify = require('stringify.js')
 console.log(stringify({ firstName: 'Foo', surname: 'bar' })) // '{"firstName":"Foo"}'
 ```
 
-<a name="acknowledgements"></a>
-## Acknowledgements
+<a name="acknowledgments"></a>
+## Acknowledgments
 
 This project was kindly sponsored by [nearForm](https://nearform.com).
 
 <a name="license"></a>
 ## License
 
-MIT
+Licensed under [MIT](./LICENSE).

package/benchmark/bench-cmp-lib.js

@@ -134,7 +134,6 @@ const getRandomString = (length) => {
   return result[0].toUpperCase() + result.slice(1)
 }
 
-// eslint-disable-next-line
 for (let i = 0; i < STR_LEN; i++) {
   largeArray[i] = {
     firstName: getRandomString(8),

package/eslint.config.js

@@ -0,0 +1,9 @@
+'use strict'
+
+module.exports = require('neostandard')({
+  ignores: [
+    ...require('neostandard').resolveIgnoresFromGitignore(),
+    'lib/schema-validator.js'
+  ],
+  ts: true
+})

package/index.js

@@ -252,20 +252,16 @@ const numberKeywords = [
  * https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01#section-6
  */
 function inferTypeByKeyword (schema) {
-  // eslint-disable-next-line
-  for (var keyword of objectKeywords) {
+  for (const keyword of objectKeywords) {
     if (keyword in schema) return 'object'
   }
-  // eslint-disable-next-line
-  for (var keyword of arrayKeywords) {
+  for (const keyword of arrayKeywords) {
     if (keyword in schema) return 'array'
   }
-  // eslint-disable-next-line
-  for (var keyword of stringKeywords) {
+  for (const keyword of stringKeywords) {
     if (keyword in schema) return 'string'
   }
-  // eslint-disable-next-line
-  for (var keyword of numberKeywords) {
+  for (const keyword of numberKeywords) {
     if (keyword in schema) return 'number'
   }
   return schema.type

package/lib/serializer.js

@@ -102,8 +102,7 @@ module.exports = class Serializer {
       let result = ''
       let last = -1
       let point = 255
-      // eslint-disable-next-line
-      for (var i = 0; i < len; i++) {
+      for (let i = 0; i < len; i++) {
         point = str.charCodeAt(i)
         if (
           point === 0x22 || // '"'

package/lib/validator.js

@@ -21,7 +21,7 @@ class Validator {
       keyword: 'fjs_type',
       type: 'object',
       errors: false,
-      validate: (type, date) => {
+      validate: (_type, date) => {
         return date instanceof Date
       }
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-json-stringify",
-  "version": "5.16.1",
+  "version": "6.0.1",
   "description": "Stringify your JSON at max speed",
   "main": "index.js",
   "type": "commonjs",
@@ -10,10 +10,10 @@
     "bench:cmp": "node ./benchmark/bench-cmp-branch.js",
     "bench:cmp:ci": "node ./benchmark/bench-cmp-branch.js --ci",
     "benchmark": "node ./benchmark/bench-cmp-lib.js",
-    "lint": "standard",
-    "lint:fix": "standard --fix",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "test:typescript": "tsd",
-    "test:unit": "tap",
+    "test:unit": "c8 node --test",
     "test": "npm run test:unit && npm run test:typescript"
   },
   "precommit": [
@@ -31,38 +31,62 @@
     "fast"
   ],
   "author": "Matteo Collina <hello@matteocollina.com>",
+  "contributors": [
+    {
+      "name": "Tomas Della Vedova",
+      "url": "http://delved.org"
+    },
+    {
+      "name": "Aras Abbasi",
+      "email": "aras.abbasi@gmail.com"
+    },
+    {
+      "name": "Manuel Spigolon",
+      "email": "behemoth89@gmail.com"
+    },
+    {
+      "name": "Frazer Smith",
+      "email": "frazer.dev@icloud.com",
+      "url": "https://github.com/fdawgs"
+    }
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fastify/fast-json-stringify/issues"
   },
   "homepage": "https://github.com/fastify/fast-json-stringify#readme",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/fastify"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/fastify"
+    }
+  ],
   "devDependencies": {
-    "@fastify/pre-commit": "^2.0.2",
-    "@sinclair/typebox": "^0.32.3",
+    "@fastify/pre-commit": "^2.1.0",
+    "@sinclair/typebox": "^0.34.3",
     "benchmark": "^2.1.4",
+    "c8": "^10.1.2",
     "cli-select": "^1.1.2",
     "compile-json-stringify": "^0.1.2",
-    "is-my-json-valid": "^2.20.0",
-    "simple-git": "^3.7.1",
-    "standard": "^17.0.0",
-    "tap": "^16.0.1",
+    "eslint": "^9.17.0",
+    "fast-json-stringify": ".",
+    "is-my-json-valid": "^2.20.6",
+    "neostandard": "^0.12.0",
+    "simple-git": "^3.23.0",
     "tsd": "^0.31.0",
-    "webpack": "^5.40.0",
-    "fast-json-stringify": "."
+    "webpack": "^5.90.3"
   },
   "dependencies": {
-    "ajv": "^8.10.0",
+    "@fastify/merge-json-schemas": "^0.2.0",
+    "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "fast-deep-equal": "^3.1.3",
-    "fast-uri": "^2.1.0",
-    "rfdc": "^1.2.0",
-    "json-schema-ref-resolver": "^1.0.1",
-    "@fastify/merge-json-schemas": "^0.1.0"
-  },
-  "standard": {
-    "ignore": [
-      "schema-validator.js"
-    ]
+    "fast-uri": "^3.0.0",
+    "json-schema-ref-resolver": "^2.0.0",
+    "rfdc": "^1.2.0"
   },
   "runkitExampleFilename": "./examples/example.js"
 }

package/test/additionalProperties.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const test = require('tap').test
+const { test } = require('node:test')
 const build = require('..')
 
 test('additionalProperties', (t) => {
@@ -19,7 +19,7 @@ test('additionalProperties', (t) => {
   })
 
   const obj = { str: 'test', foo: 42, ofoo: true, foof: 'string', objfoo: { a: true } }
-  t.equal(stringify(obj), '{"str":"test","foo":"42","ofoo":"true","foof":"string","objfoo":"[object Object]"}')
+  t.assert.equal(stringify(obj), '{"str":"test","foo":"42","ofoo":"true","foof":"string","objfoo":"[object Object]"}')
 })
 
 test('additionalProperties should not change properties', (t) => {
@@ -38,7 +38,7 @@ test('additionalProperties should not change properties', (t) => {
   })
 
   const obj = { foo: '42', ofoo: 42 }
-  t.equal(stringify(obj), '{"foo":"42","ofoo":42}')
+  t.assert.equal(stringify(obj), '{"foo":"42","ofoo":42}')
 })
 
 test('additionalProperties should not change properties and patternProperties', (t) => {
@@ -62,7 +62,7 @@ test('additionalProperties should not change properties and patternProperties',
   })
 
   const obj = { foo: '42', ofoo: 42, test: '42' }
-  t.equal(stringify(obj), '{"foo":"42","ofoo":"42","test":42}')
+  t.assert.equal(stringify(obj), '{"foo":"42","ofoo":"42","test":42}')
 })
 
 test('additionalProperties set to true, use of fast-safe-stringify', (t) => {
@@ -75,7 +75,7 @@ test('additionalProperties set to true, use of fast-safe-stringify', (t) => {
   })
 
   const obj = { foo: true, ofoo: 42, arrfoo: ['array', 'test'], objfoo: { a: 'world' } }
-  t.equal(stringify(obj), '{"foo":true,"ofoo":42,"arrfoo":["array","test"],"objfoo":{"a":"world"}}')
+  t.assert.equal(stringify(obj), '{"foo":true,"ofoo":42,"arrfoo":["array","test"],"objfoo":{"a":"world"}}')
 })
 
 test('additionalProperties - string coerce', (t) => {
@@ -90,7 +90,7 @@ test('additionalProperties - string coerce', (t) => {
   })
 
   const obj = { foo: true, ofoo: 42, arrfoo: ['array', 'test'], objfoo: { a: 'world' } }
-  t.equal(stringify(obj), '{"foo":"true","ofoo":"42","arrfoo":"array,test","objfoo":"[object Object]"}')
+  t.assert.equal(stringify(obj), '{"foo":"true","ofoo":"42","arrfoo":"array,test","objfoo":"[object Object]"}')
 })
 
 test('additionalProperties - number skip', (t) => {
@@ -106,7 +106,7 @@ test('additionalProperties - number skip', (t) => {
 
   // const obj = { foo: true, ofoo: '42', xfoo: 'string', arrfoo: [1, 2], objfoo: { num: 42 } }
   const obj = { foo: true, ofoo: '42' }
-  t.equal(stringify(obj), '{"foo":1,"ofoo":42}')
+  t.assert.equal(stringify(obj), '{"foo":1,"ofoo":42}')
 })
 
 test('additionalProperties - boolean coerce', (t) => {
@@ -121,7 +121,7 @@ test('additionalProperties - boolean coerce', (t) => {
   })
 
   const obj = { foo: 'true', ofoo: 0, arrfoo: [1, 2], objfoo: { a: true } }
-  t.equal(stringify(obj), '{"foo":true,"ofoo":false,"arrfoo":true,"objfoo":true}')
+  t.assert.equal(stringify(obj), '{"foo":true,"ofoo":false,"arrfoo":true,"objfoo":true}')
 })
 
 test('additionalProperties - object coerce', (t) => {
@@ -141,7 +141,7 @@ test('additionalProperties - object coerce', (t) => {
   })
 
   const obj = { objfoo: { answer: 42 } }
-  t.equal(stringify(obj), '{"objfoo":{"answer":42}}')
+  t.assert.equal(stringify(obj), '{"objfoo":{"answer":42}}')
 })
 
 test('additionalProperties - array coerce', (t) => {
@@ -159,10 +159,10 @@ test('additionalProperties - array coerce', (t) => {
   })
 
   const coercibleValues = { arrfoo: [1, 2] }
-  t.equal(stringify(coercibleValues), '{"arrfoo":["1","2"]}')
+  t.assert.equal(stringify(coercibleValues), '{"arrfoo":["1","2"]}')
 
   const incoercibleValues = { foo: 'true', ofoo: 0, objfoo: { tyrion: 'lannister' } }
-  t.throws(() => stringify(incoercibleValues))
+  t.assert.throws(() => stringify(incoercibleValues))
 })
 
 test('additionalProperties with empty schema', (t) => {
@@ -173,7 +173,7 @@ test('additionalProperties with empty schema', (t) => {
   })
 
   const obj = { a: 1, b: true, c: null }
-  t.equal(stringify(obj), '{"a":1,"b":true,"c":null}')
+  t.assert.equal(stringify(obj), '{"a":1,"b":true,"c":null}')
 })
 
 test('additionalProperties with nested empty schema', (t) => {
@@ -187,7 +187,7 @@ test('additionalProperties with nested empty schema', (t) => {
   })
 
   const obj = { data: { a: 1, b: true, c: null } }
-  t.equal(stringify(obj), '{"data":{"a":1,"b":true,"c":null}}')
+  t.assert.equal(stringify(obj), '{"data":{"a":1,"b":true,"c":null}}')
 })
 
 test('nested additionalProperties', (t) => {
@@ -207,7 +207,7 @@ test('nested additionalProperties', (t) => {
   })
 
   const obj = [{ ap: { value: 'string' } }]
-  t.equal(stringify(obj), '[{"ap":{"value":"string"}}]')
+  t.assert.equal(stringify(obj), '[{"ap":{"value":"string"}}]')
 })
 
 test('very nested additionalProperties', (t) => {
@@ -244,7 +244,7 @@ test('very nested additionalProperties', (t) => {
   })
 
   const obj = [{ ap: { nested: { moarNested: { finally: { value: 'str' } } } } }]
-  t.equal(stringify(obj), '[{"ap":{"nested":{"moarNested":{"finally":{"value":"str"}}}}}]')
+  t.assert.equal(stringify(obj), '[{"ap":{"nested":{"moarNested":{"finally":{"value":"str"}}}}}]')
 })
 
 test('nested additionalProperties set to true', (t) => {
@@ -261,7 +261,7 @@ test('nested additionalProperties set to true', (t) => {
   })
 
   const obj = { ap: { value: 'string', someNumber: 42 } }
-  t.equal(stringify(obj), '{"ap":{"value":"string","someNumber":42}}')
+  t.assert.equal(stringify(obj), '{"ap":{"value":"string","someNumber":42}}')
 })
 
 test('field passed to fastSafeStringify as undefined should be removed', (t) => {
@@ -278,7 +278,7 @@ test('field passed to fastSafeStringify as undefined should be removed', (t) =>
   })
 
   const obj = { ap: { value: 'string', someNumber: undefined } }
-  t.equal(stringify(obj), '{"ap":{"value":"string"}}')
+  t.assert.equal(stringify(obj), '{"ap":{"value":"string"}}')
 })
 
 test('property without type but with enum, will acts as additionalProperties', (t) => {
@@ -294,7 +294,7 @@ test('property without type but with enum, will acts as additionalProperties', (
   })
 
   const obj = { ap: { additional: 'field' } }
-  t.equal(stringify(obj), '{"ap":{"additional":"field"}}')
+  t.assert.equal(stringify(obj), '{"ap":{"additional":"field"}}')
 })
 
 test('property without type but with enum, will acts as additionalProperties without overwriting', (t) => {
@@ -311,7 +311,7 @@ test('property without type but with enum, will acts as additionalProperties wit
   })
 
   const obj = { ap: { additional: 'field' } }
-  t.equal(stringify(obj), '{"ap":{}}')
+  t.assert.equal(stringify(obj), '{"ap":{}}')
 })
 
 test('function and symbol references are not serialized as undefined', (t) => {
@@ -328,5 +328,5 @@ test('function and symbol references are not serialized as undefined', (t) => {
   })
 
   const obj = { str: 'x', test: 'test', meth: () => 'x', sym: Symbol('x') }
-  t.equal(stringify(obj), '{"str":"x","test":"test"}')
+  t.assert.equal(stringify(obj), '{"str":"x","test":"test"}')
 })