arrange-package-json

arrange-package-json

Arrange the properties in the package.json file to a universally consistent order

Usage

Complete API Documentation.

import arrangePackageData from 'arrange-package-json'
console.log(
    arrangePackageData({
        banana: true,
        apple: true,
        version: '1.0.0',
        name: 'pkg',
    })
)
// {name: 'pkg', version: '1.0.0', banana: true, apple: true}

Known fields are arranged to their universally consistent order. Unknown fields are placed at the end with their order maintained.

If you are interested in this package, you will be interested in:

• Projectz
• sortobject
• arrangekeys

Install

npm

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

Deno

import pkg from 'https://unpkg.com/arrange-package-json@^5.2.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/arrange-package-json@^5.2.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/arrange-package-json@^5.2.0'
</script>

jspm

<script type="module">
    import pkg from '//dev.jspm.io/arrange-package-json@5.2.0'
</script>

Editions

This package is published with the following editions:

• arrange-package-json aliases arrange-package-json/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
• arrange-package-json/source/index.ts is TypeScript source code with Import for modules
• arrange-package-json/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• arrange-package-json/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• arrange-package-json/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• arrange-package-json/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
• arrange-package-json/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• arrange-package-json/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

Finances

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
• 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

Changelog

v5.2.0 2023 December 29

• Updated dependencies, base files, and editions using boundation
• Thank you to the sponsors: Andrew Nesbitt, Balsa, Codecov, Poonacha Medappa, Rob Morris, Sentry, Syntax