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.

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@^4.4.0/edition-deno/index.ts'

Skypack

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

unpkg

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

jspm

<script type="module">
    import pkg from '//dev.jspm.io/arrange-package-json@4.4.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.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2020+ Benjamin Lupton

and licensed under:

• Artistic License 2.0