sortobject - npm Package Compare versions

Comparing version 1.1.1 to 1.2.0

HISTORY.md

 # History
 
+## v1.2.0 2019 January 1
+
+-   Added JSDoc documentation
+-   Updated [base files](https://github.com/bevry/base) and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
+
 ## v1.1.1 2016 May 2
-- Fixed `browser` field
 
+-   Fixed `browser` field
+
 ## v1.1.0 2016 May 2
-- Converted from CoffeeScript to JavaScript
-- Updated base files
 
+-   Converted from CoffeeScript to JavaScript
+-   Updated base files
+
 ## v1.0.1 2016 January 27
-- Fixed Firefox compatibility issue
-	- Thanks to [Serge Havas](https://github.com/Sinewyk) for [pull request #2](https://github.com/bevry/sortobject/pull/2)
-- Updated base files
 
+-   Fixed Firefox compatibility issue - Thanks to [Serge Havas](https://github.com/Sinewyk) for [pull request #2](https://github.com/bevry/sortobject/pull/2)
+-   Updated base files
+
 ## v1.0.0 2013 April 20
-- Initial working version
+
+-   Initial working version

index.js

@@ -1,3 +0,4 @@
-// 2016 March 8
-// https://github.com/bevry/editions
+'use strict'
+
+/** @type {typeof import("./source/index.js") } */
 module.exports = require('editions').requirePackage(__dirname, require)

package.json

 {
   "title": "Sort Object",
   "name": "sortobject",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Returns a copy of an object, sorted deeply by its keys, without mangling any arrays inside of it",
@@ -25,30 +25,35 @@ "homepage": "https://github.com/bevry/sortobject",
       "---",
-      "slackin",
       "patreon",
-      "gratipay",
       "flattr",
+      "liberapay",
+      "thanksapp",
+      "boostlab",
+      "buymeacoffee",
+      "opencollective",
+      "crypto",
       "paypal",
-      "bitcoin",
       "wishlist"
     ],
     "config": {
+      "buymeacoffeeUsername": "balupton",
+      "cryptoURL": "https://bevry.me/crypto",
+      "flattrUsername": "balupton",
+      "liberapayUsername": "bevry",
+      "opencollectiveUsername": "bevry",
       "patreonUsername": "bevry",
-      "gratipayUsername": "bevry",
-      "flattrUsername": "balupton",
       "paypalURL": "https://bevry.me/paypal",
-      "bitcoinURL": "https://bevry.me/bitcoin",
-      "wishlistURL": "https://bevry.me/wishlist",
-      "slackinURL": "https://slack.bevry.me"
+      "wishlistURL": "https://bevry.me/wishlist"
     }
   },
   "author": "2012+ Bevry Pty Ltd <[e-mail]> (http://bevry.me)",
-  "maintainers": [
-    "Benjamin Lupton <[e-mail]> (https://balupton.com)"
-  ],
   "sponsors": [
     "GoVests <[e-mail]> (https://www.govests.com.au)"
   ],
+  "maintainers": [
+    "Benjamin Lupton <[e-mail]> (http://balupton.com)"
+  ],
   "contributors": [
-    "Benjamin Lupton <[e-mail]> (https://balupton.com)",
-    "Serge Havas <[e-mail]> (https://github.com/Sinewyk)"
+    "Benjamin Lupton <[e-mail]> (http://balupton.com)",
+    "Serge Havas <[e-mail]> (https://github.com/Sinewyk)",
+    "James Newell (http://jameslnewell.me/)"
   ],
@@ -60,3 +65,3 @@ "bugs": {
     "type": "git",
-    "url": "http://github.com/bevry/sortobject.git"
+    "url": "https://github.com/bevry/sortobject.git"
   },
@@ -68,55 +73,135 @@ "engines": {
     {
-      "description": "Source + ESNext + Require",
-      "entry": "source/index.js",
+      "description": "esnext source code with require for modules",
       "directory": "source",
-      "syntaxes": [
+      "entry": "index.js",
+      "tags": [
         "javascript",
         "esnext",
-        "require",
-        "const",
-        "let"
-      ]
+        "require"
+      ],
+      "engines": {
+        "node": "6 || 8 || 10 || 11",
+        "browsers": false
+      }
     },
     {
-      "description": "Babel Compiled + ES2015 + Require",
-      "entry": "es2015/index.js",
-      "directory": "es2015",
-      "syntaxes": [
+      "description": "esnext compiled for browsers with require for modules",
+      "directory": "edition-browsers",
+      "entry": "index.js",
+      "tags": [
         "javascript",
-        "es2015",
         "require"
-      ]
+      ],
+      "engines": {
+        "node": false,
+        "browsers": "defaults"
+      }
+    },
+    {
+      "description": "esnext compiled for node.js 0.12 with require for modules",
+      "directory": "edition-node-0.12",
+      "entry": "index.js",
+      "tags": [
+        "javascript",
+        "require"
+      ],
+      "engines": {
+        "node": "0.12 || 4 || 6 || 8 || 10 || 11",
+        "browsers": false
+      }
     }
   ],
   "main": "index.js",
-  "browser": "es2015/index.js",
+  "browser": "edition-browsers/index.js",
+  "dependencies": {
+    "editions": "^2.1.3"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.2.3",
+    "@babel/core": "^7.2.2",
+    "@babel/plugin-proposal-object-rest-spread": "^7.2.0",
+    "@babel/preset-env": "^7.2.3",
+    "assert-helpers": "^4.9.3",
+    "eslint": "^5.11.1",
+    "eslint-config-bevry": "^1.1.1",
+    "eslint-config-prettier": "^3.3.0",
+    "eslint-plugin-babel": "^5.3.0",
+    "eslint-plugin-prettier": "^3.0.1",
+    "jsdoc": "^3.5.5",
+    "kava": "^3.1.0",
+    "minami": "^1.2.3",
+    "prettier": "^1.15.3",
+    "projectz": "^1.7.4",
+    "surge": "^0.20.1",
+    "valid-directory": "^1.0.0"
+  },
   "scripts": {
-    "setup": "npm install",
-    "clean": "rm -Rf ./docs ./es2015",
-    "compile": "npm run compile:es2015",
-    "compile:es2015": "babel ./source --out-dir ./es2015 --presets es2015",
-    "meta": "npm run meta:projectz",
-    "meta:projectz": "projectz compile",
-    "prepare": "npm run compile && npm run test && npm run meta",
-    "release": "npm run prepare && npm run release:publish && npm run release:tag && npm run release:push",
-    "release:publish": "npm publish",
-    "release:tag": "git tag v$npm_package_version -a",
-    "release:push": "git push origin master && git push origin --tags",
-    "pretest": "npm run test:eslint",
-    "test:eslint": "eslint ./source",
-    "test": "node --harmony -e \"require('editions').requirePackage(process.cwd(), require, 'test.js')\""
+    "our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
+    "our:compile": "npm run our:compile:edition-browsers && npm run our:compile:edition-node-0.12",
+    "our:compile:edition-browsers": "env BABEL_ENV=edition-browsers babel --out-dir ./edition-browsers ./source",
+    "our:compile:edition-node-0.12": "env BABEL_ENV=edition-node-0.12 babel --out-dir ./edition-node-0.12 ./source",
+    "our:deploy": "echo no need for this project",
+    "our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
+    "our:meta:docs": "npm run our:meta:docs:jsdoc",
+    "our:meta:docs:jsdoc": "rm -Rf ./docs && jsdoc --recurse --pedantic --access all --destination ./docs --package ./package.json --readme ./README.md --template ./node_modules/minami ./source && mv ./docs/$npm_package_name/$npm_package_version/* ./docs/ && rm -Rf ./docs/$npm_package_name/$npm_package_version",
+    "our:meta:projectz": "projectz compile",
+    "our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",
+    "our:release:check-changelog": "cat ./HISTORY.md | grep v$npm_package_version || (echo add a changelog entry for v$npm_package_version && exit -1)",
+    "our:release:check-dirty": "git diff --exit-code",
+    "our:release:prepare": "npm run our:clean && npm run our:compile && npm run our:test && npm run our:meta",
+    "our:release:push": "git push origin master && git push origin --tags",
+    "our:release:tag": "export MESSAGE=$(cat ./HISTORY.md | sed -n \"/## v$npm_package_version/,/##/p\" | sed 's/## //' | awk 'NR>1{print buf}{buf = $0}') && test \"$MESSAGE\" || (echo 'proper changelog entry not found' && exit -1) && git tag v$npm_package_version -am \"$MESSAGE\"",
+    "our:setup": "npm run our:setup:npm",
+    "our:setup:npm": "npm install",
+    "our:test": "npm run our:verify && npm test",
+    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint",
+    "our:verify:directory": "npx valid-directory",
+    "our:verify:eslint": "eslint --fix --ignore-pattern '**/*.d.ts' --ignore-pattern '**/vendor/' --ignore-pattern '**/node_modules/' --ext .mjs,.js,.jsx,.ts,.tsx ./source",
+    "test": "node ./test.js"
   },
-  "dependencies": {
-    "editions": "^1.1.1"
+  "eslintConfig": {
+    "extends": [
+      "bevry"
+    ]
   },
-  "devDependencies": {
-    "assert-helpers": "^4.1.0",
-    "babel-cli": "^6.7.7",
-    "babel-preset-es2015": "^6.6.0",
-    "eslint": "^2.9.0",
-    "eslint-plugin-babel": "^3.2.0",
-    "joe": "^1.6.0",
-    "joe-reporter-console": "^1.2.1",
-    "projectz": "^1.1.4"
+  "prettier": {
+    "semi": false,
+    "singleQuote": true
+  },
+  "babel": {
+    "env": {
+      "edition-browsers": {
+        "sourceType": "script",
+        "presets": [
+          [
+            "@babel/preset-env",
+            {
+              "targets": "defaults",
+              "modules": "commonjs"
+            }
+          ]
+        ],
+        "plugins": [
+          "@babel/proposal-object-rest-spread"
+        ]
+      },
+      "edition-node-0.12": {
+        "sourceType": "script",
+        "presets": [
+          [
+            "@babel/preset-env",
+            {
+              "targets": {
+                "node": "0.12"
+              },
+              "modules": "commonjs"
+            }
+          ]
+        ],
+        "plugins": [
+          "@babel/proposal-object-rest-spread"
+        ]
+      }
+    }
   }
 }

README.md

@@ -16,8 +16,11 @@ <!-- TITLE/ -->
 <br class="badge-separator" />
-<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>
-<span class="badge-patreon"><a href="http://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
-<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
 <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
+<span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/sortobject" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span>
+<span class="badge-boostlab"><a href="https://boost-lab.app/bevry/sortobject" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span>
+<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
+<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
+<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
 <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
-<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
 <span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
@@ -39,25 +42,37 @@
 
-<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>NPM</h3></a><ul>
+<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
+<ul>
 <li>Install: <code>npm install --save sortobject</code></li>
-<li>Module: <code>require('sortobject')</code></li></ul>
+<li>Require: <code>require('sortobject')</code></li>
+</ul>
 
-<a href="http://browserify.org" title="Browserify lets you require('modules') in the browser by bundling up all of your dependencies"><h3>Browserify</h3></a><ul>
-<li>Install: <code>npm install --save sortobject</code></li>
-<li>Module: <code>require('sortobject')</code></li>
-<li>CDN URL: <code>//wzrd.in/bundle/sortobject@1.1.1</code></li></ul>
+<a href="https://jspm.io" title="Native ES Modules CDN"><h3>jspm</h3></a>
 
-<a href="http://enderjs.com" title="Ender is a full featured package manager for your browser"><h3>Ender</h3></a><ul>
-<li>Install: <code>ender add sortobject</code></li>
-<li>Module: <code>require('sortobject')</code></li></ul>
+``` html
+<script type="module">
+    import * as pkg from '//dev.jspm.io/sortobject'
+</script>
+```
 
-<h3><a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
+<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
 
 <p>This package is published with the following editions:</p>
 
-<ul><li><code>sortobject</code> aliases <code>sortobject/index.js</code> which uses <a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
-<li><code>sortobject/source/index.js</code> is Source + <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
-<li><code>sortobject/es2015/index.js</code> is <a href="https://babeljs.io" title="The compiler for writing next generation JavaScript">Babel</a> Compiled + <a href="http://babeljs.io/docs/plugins/preset-es2015/" title="ECMAScript 2015">ES2015</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li></ul>
+<ul><li><code>sortobject</code> aliases <code>sortobject/index.js</code> which uses <a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
+<li><code>sortobject/source/index.js</code> is esnext source code with require for modules</li>
+<li><code>sortobject/edition-browsers/index.js</code> is esnext compiled for browsers with require for modules</li>
+<li><code>sortobject/edition-node-0.12/index.js</code> is esnext compiled for node.js 0.12 with require for modules</li></ul>
 
-<p>Older environments may need <a href="https://babeljs.io/docs/usage/polyfill/" title="A polyfill that emulates missing ECMAScript environment features">Babel's Polyfill</a> or something similar.</p>
+<h3><a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a></h3>
 
+This project provides its type information via inline <a href="http://usejsdoc.org" title="JSDoc is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor">JSDoc Comments</a>. To make use of this in <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a>, set your <code>maxNodeModuleJsDepth</code> compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:
+
+``` json
+{
+  "compilerOptions": {
+    "maxNodeModuleJsDepth": 5
+  }
+}
+```
+
 <!-- /INSTALL -->
@@ -68,23 +83,25 @@
 
-``` javascript
+[API Documentation.](http://master.sortobject.bevry.surge.sh/docs/)
+
+```javascript
 var sortObject = require('sortobject')
 var fixture = {
-    "c": true,
-    "a": true,
-    "b": null,
-    "d": [
+    c: true,
+    a: true,
+    b: null,
+    d: [
         {
-            "c": true,
-            "a": true,
-            "b": null
+            c: true,
+            a: true,
+            b: null
         },
         {
-            "c": true,
-            "a": true,
-            "b": null,
-            "d": [
+            c: true,
+            a: true,
+            b: null,
+            d: [
                 {
-                    "c": true,
-                    "a": true,
-                    "b": null
+                    c: true,
+                    a: true,
+                    b: null
                 }
@@ -96,3 +113,3 @@ ]
 var actual = sortObject(fixture)
-console.log(JSON.stringify(actual,null,4))  /* {
+console.log(JSON.stringify(actual, null, 4)) /* {
     "a": true,
@@ -149,3 +166,3 @@ "b": null,
 
-<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/sortobject/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/sortobject">view contributions</a></li></ul>
+<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/sortobject/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/sortobject">view contributions</a></li></ul>
 
@@ -156,11 +173,15 @@ <h3>Sponsors</h3>
 
-<ul><li><a href="https://www.govests.com.au">GoVests</a></li></ul>
+<ul><li><a href="http://www.govests.com.au">GoVests</a></li></ul>
 
 Become a sponsor!
 
-<span class="badge-patreon"><a href="http://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
-<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
 <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
+<span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/sortobject" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span>
+<span class="badge-boostlab"><a href="https://boost-lab.app/bevry/sortobject" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span>
+<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
+<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
+<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
 <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
-<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
 <span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
@@ -172,4 +193,5 @@
 
-<ul><li><a href="https://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/sortobject/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/sortobject">view contributions</a></li>
-<li><a href="https://github.com/Sinewyk">Serge Havas</a> — <a href="https://github.com/bevry/sortobject/commits?author=Sinewyk" title="View the GitHub contributions of Serge Havas on repository bevry/sortobject">view contributions</a></li></ul>
+<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/sortobject/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/sortobject">view contributions</a></li>
+<li><a href="https://github.com/Sinewyk">Serge Havas</a> — <a href="https://github.com/bevry/sortobject/commits?author=Sinewyk" title="View the GitHub contributions of Serge Havas on repository bevry/sortobject">view contributions</a></li>
+<li><a href="http://jameslnewell.me/">James Newell</a> — <a href="https://github.com/bevry/sortobject/commits?author=jameslnewell" title="View the GitHub contributions of James Newell on repository bevry/sortobject">view contributions</a></li></ul>
 
@@ -176,0 +198,0 @@ <a href="https://github.com/bevry/sortobject/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

source/index.js

@@ -1,6 +0,22 @@
-module.exports = function sortObject (obj, comparator) {
+'use strict'
+
+/**
+ * A typical comparator for sorting.
+ * @callback Comparator
+ * @param {any} a
+ * @param {any} b
+ * @returns {number}
+ */
+
+/**
+ * Returns a copy of an object, sorted deeply by its keys, without mangling any arrays inside of it.
+ * @param {object} obj The unsorted object.
+ * @param {Comparator} [comparator] An optional comparator to use to sort the keys.
+ * @returns {object} The new sorted object.
+ */
+function sortObject(obj, comparator) {
 	// Arrays
-	if ( Array.isArray(obj) ) {
+	if (Array.isArray(obj)) {
 		const result = []
-		for ( let i = 0; i < obj.length; ++i ) {
+		for (let i = 0; i < obj.length; ++i) {
 			// Fetch
@@ -10,3 +26,3 @@ let value = obj[i]
 			// Recurse if object or array
-			if ( value != null && typeof value === 'object' ) {
+			if (value != null && typeof value === 'object') {
 				value = sortObject(value, comparator)
@@ -25,3 +41,3 @@ }
 		const sortedKeys = Object.keys(obj).sort(comparator)
-		for ( let i = 0; i < sortedKeys.length; ++i ) {
+		for (let i = 0; i < sortedKeys.length; ++i) {
 			// Fetch
@@ -32,3 +48,3 @@ const key = sortedKeys[i]
 			// Recurse if object or array
-			if ( value != null && typeof value === 'object' ) {
+			if (value != null && typeof value === 'object') {
 				value = sortObject(value, comparator)
@@ -43,1 +59,3 @@ }
 }
+
+module.exports = sortObject

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

24253

increased by34.65%

Lines of code

140

increased by14.75%

Number of lines in readme file

209

increased by11.76%

Worsened metrics

Dev dependency count

17

increased by112.5%

Number of package files

8

decreased by-11.11%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addededitions@2.3.1(transitive)

• + Addederrlop@2.2.0(transitive)

• + Addedsemver@6.3.1(transitive)

• - Removededitions@1.3.4(transitive)

• Updatededitions@^2.1.3