bevry / sortobject

Deeply sort an object by its keys without mangling any arrays inside of it

Sort Object

Returns a copy of an object, sorted deeply by its keys, without mangling any arrays inside of it

Usage

Complete API Documentation.

import sortObject from 'sortobject'
const fixture = {
    c: true,
    a: true,
    b: null,
    d: [
        {
            c: true,
            a: true,
            b: null,
        },
        {
            c: true,
            a: true,
            b: null,
            d: [
                {
                    c: true,
                    a: true,
                    b: null,
                },
            ],
        },
    ],
}
const actual = sortObject(fixture)
console.log(JSON.stringify(actual, null, 4)) /* {
    "a": true,
    "b": null,
    "c": true,
    "d": [
        {
            "a": true,
            "b": null,
            "c": true
        },
        {
            "a": true,
            "b": null,
            "c": true,
            "d": [
                {
                    "a": true,
                    "b": null,
                    "c": true
                }
            ]
        }
    ]
} */

Install

npm

• Install: npm install --save sortobject
• Import: import pkg from ('sortobject')
• Require: const pkg = require('sortobject').default

Deno

import pkg from 'https://unpkg.com/sortobject@^5.6.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/sortobject@^5.6.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/sortobject@^5.6.0'
</script>

jspm

<script type="module">
    import pkg from '//dev.jspm.io/[email protected]'
</script>

Editions

This package is published with the following editions:

• sortobject/source/index.ts is TypeScript source code with Import for modules
• sortobject/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• sortobject aliases sortobject/edition-es2022/index.js
• sortobject/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• sortobject/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
• sortobject/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• sortobject/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

• Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

• Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

• Benjamin Lupton — view contributions
• James Newell
• James Newell — view contributions
• Serge Havas — view contributions

Finances

Funders

• GoVests

Sponsors

• Andrew Nesbitt — Software engineer and researcher
• Balsa — We're Balsa, and we're building tools for builders.
• Codecov — Empower developers with tools to improve code quality and testing.
• Poonacha Medappa
• Rob Morris
• Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
• Syntax — Syntax Podcast

Donors

• Andrew Nesbitt
• Armen Mkrtchian
• Balsa
• Chad
• Codecov
• dr.dimitru
• Elliott Ditman
• entroniq
• GitHub
• GoVests
• Hunter Beast
• Jean-Luc Geering
• Michael Duane Mooring
• Michael Harry Scepaniak
• Mohammed Shah
• Mr. Henry
• Nermal
• Pleo
• Poonacha Medappa
• Rob Morris
• Robert de Forest
• Sentry
• ServieJS
• Skunk Team
• Syntax
• WriterJohnBuck

License

Unless stated otherwise all works are:

• Copyright © Benjamin Lupton

and licensed under:

• Artistic License 2.0

sortobject's Issues

Problem with 1.1.0 release (with webpack)

There seems to be a problem with the latest release, using webpack

Works fine when using version 1.0.0

First error is

WARNING in ../~/sortobject/index.js
Critical dependencies:
3:63-70 require function is used in a way in which dependencies cannot be statically extracted
 @ ../~/sortobject/index.js 3:63-70

Next we get loads of something like this

WARNING in ../~/sortobject/package.json
Module parse failed: /path/to/project/node_modules/sortobject/package.json Unexpected token (2:9)
You may need an appropriate loader to handle this file type.
SyntaxError: Unexpected token (2:9)
    at Parser.pp.raise (/path/to/project/node_modules/acorn/dist/acorn.js:920:13)
    at Parser.pp.unexpected (/path/to/project/node_modules/acorn/dist/acorn.js:1483:8)
    at Parser.pp.semicolon (/path/to/project/node_modules/acorn/dist/acorn.js:1462:73)
    at Parser.pp.parseExpressionStatement (/path/to/project/node_modules/acorn/dist/acorn.js:1976:8)
    at Parser.pp.parseStatement (/path/to/project/node_modules/acorn/dist/acorn.js:1754:188)
    at Parser.pp.parseBlock (/path/to/project/node_modules/acorn/dist/acorn.js:1991:21)
    at Parser.pp.parseStatement (/path/to/project/node_modules/acorn/dist/acorn.js:1735:19)
    at Parser.pp.parseTopLevel (/path/to/project/node_modules/acorn/dist/acorn.js:1648:21)
    at Parser.parse (/path/to/project/node_modules/acorn/dist/acorn.js:1616:17)
    at Object.parse (/path/to/project/node_modules/acorn/dist/acorn.js:882:44)
    at Parser.parse (/path/to/project/node_modules/webpack/lib/Parser.js:902:15)
    at DependenciesBlock.<anonymous> (/path/to/project/node_modules/webpack/lib/NormalModule.js:104:16)
    at DependenciesBlock.onModuleBuild (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:310:10)
    at nextLoader (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:275:25)
    at /path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:259:5
    at Storage.provide (/path/to/project/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:52:20)
    at CachedInputFileSystem.readFile (/path/to/project/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:140:24)
    at DependenciesBlock.onLoadPitchDone (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:255:7)
    at DependenciesBlock.loadPitch (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:182:27)
    at DependenciesBlock.doBuild (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:241:4)
    at DependenciesBlock.build (/path/to/project/node_modules/webpack/lib/NormalModule.js:84:14)
    at Compilation.buildModule (/path/to/project/node_modules/webpack/lib/Compilation.js:126:9)
 @ ../~/sortobject ^\.\/.*$

 WARNING in ../~/sortobject/HISTORY.md
Module parse failed: /path/to/project/node_modules/sortobject/HISTORY.md Unexpected character '#' (1:0)
You may need an appropriate loader to handle this file type.
SyntaxError: Unexpected character '#' (1:0)
    at Parser.pp.raise (/path/to/project/node_modules/acorn/dist/acorn.js:920:13)
    at Parser.pp.getTokenFromCode (/path/to/project/node_modules/acorn/dist/acorn.js:2813:8)
    at Parser.pp.readToken (/path/to/project/node_modules/acorn/dist/acorn.js:2508:15)
    at Parser.pp.nextToken (/path/to/project/node_modules/acorn/dist/acorn.js:2500:71)
    at Parser.parse (/path/to/project/node_modules/acorn/dist/acorn.js:1615:10)
    at Object.parse (/path/to/project/node_modules/acorn/dist/acorn.js:882:44)
    at Parser.parse (/path/to/project/node_modules/webpack/lib/Parser.js:902:15)
    at DependenciesBlock.<anonymous> (/path/to/project/node_modules/webpack/lib/NormalModule.js:104:16)
    at DependenciesBlock.onModuleBuild (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:310:10)
    at nextLoader (/path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:275:25)
    at /path/to/project/node_modules/webpack-core/lib/NormalModuleMixin.js:259:5
    at Storage.finished (/path/to/project/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:38:16)
    at /path/to/project/node_modules/graceful-fs/graceful-fs.js:78:16
    at FSReqWrap.readFileAfterClose [as oncomplete] (fs.js:404:3)
 @ ../~/sortobject ^\.\/.*$

Your .dependabot/config.yml contained invalid details

Dependabot encountered the following error when parsing your .dependabot/config.yml:

The property '#/update_configs/0/automerged_updates/0/match/update_type' value "security" did not match one of the following values: all, security:patch, semver:patch, semver:minor, in_range

Please update the config file to conform with Dependabot's specification using our docs and online validator.

require function is used in a way in which dependencies cannot be statically extracted

Hello,

I've posted question on StackOverflow regarding one library, which complains about your library when I try to run tests. It looks like the problem, which was fixed in 1.1.1, but I use 1.1.1 and the problem persists. I've also created a small project so you can reproduce it.

Can you fix this bug or at least make sure, that this is not a bug in your library?

Iterations + Contribution

Since the object/array .length doesn't change, why is the need to calculate the .length on each iteration cycle ? I've also improved the code, following the D.R.Y and readability philosopy.

Old code:

module.exports = function sortObject (obj, comparator) {
    // Arrays
    if ( Array.isArray(obj) ) {
        const result = []
        for ( let i = 0; i < obj.length; ++i ) {
            // Fetch
            let value = obj[i]

            // Recurse if object or array
            if ( value != null && typeof value === 'object' ) {
                value = sortObject(value, comparator)
            }

            // Push
            result.push(value)
        }
        return result
    }

    // Objects
    else {
        const result = {}
        const sortedKeys = Object.keys(obj).sort(comparator)
        for ( let i = 0; i < sortedKeys.length; ++i ) {
            // Fetch
            const key = sortedKeys[i]
            let value = obj[key]

            // Recurse if object or array
            if ( value != null && typeof value === 'object' ) {
                value = sortObject(value, comparator)
            }

            // Push
            result[key] = value
        }
        return result
    }
}

New one:

var iterArray = function(arr, obj, toKeyVal, comparator) {
    var result = toKeyVal ? {} : [],
        value = null;

    arr.forEach(function(elem) {
        value = toKeyVal ? obj[elem] : elem;
        if (value !== null && typeof value === 'object') {
            value = sortObject(value, comparator);
        }
        if (toKeyVal) {
            result[elem] = value;
        } else {
            result.push(value);
        }
    });
    return toKeyVal ? result : result.sort();
};

var sortObject = function (obj, comparator) {
    // Arrays
    if ( Array.isArray(obj) ) {
        return iterArray(obj, obj, false, comparator);
    }

    // Objects
    else {
        return iterArray(Object.keys(obj).sort(),
                obj, true, comparator);
    }
};

15 hours later: replaced return result; to return toKeyVal ? result : result.sort();, so the array elements to be sorterd alphabetically in case of

d: ['b','d','e','a','c']

TypeScript typings

The provided solution in the readme.md to get the typings to work for TypeScript is not an option for many projects (including ours). I've made a PR to DefinitelyTyped to add TS typings of sortobject, but they suggested to open an issue in here.

Are you willing to add TypeScript typings to sortobject to help TypeScript users if I do make a PR to this repo (also meaning that these types do need to be updated together with future changes)? Otherwise, are you fine with it if DefinitelyTyped will merge mine PR so that users get the typings from there?

Allow specific ordering/arrangement of keys

Turns out I've already implemented this over at https://github.com/bevry/arragekeys - however has no nesting/recursion abilities