@m4rch/sort-package-json

a package to sort your package.json

the package.json will be indented using tabs and have a newline at the end

this project is inpired by keithamus' sort-package-json, but works with a fraction of the dependencies

use

you can either install it globally

$ npm i @m4rch/sort-package-json -g

and then use it via

$ sort-package-json

or

$ spj

or you can use npx

$ npx @m4rch/sort-pacakge-json

cli

$ spj -h

  Description
    sorts your package.json

  Usage
    $ sort-package-json [dir] [options]

  Options
    -v, --version    Displays current version
    -h, --help       Displays this message

  Examples
    $ sort-package-json
    $ sort-package-json project

api

you can import the package via

main

1import sortPackage from "@m4rch/sort-package-json"

and then use it

1/*
2	get the package content
3*/
4
5let sorted = sortPackage(pkg)
6
7/*
8	write the sorted package back using fs
9*/

sortPackage takes two arguments:

• pkg
• options

pkg is either an object, a string or a buffer and is the content of the package.json file

options (optional) is an object containing the options you want to give to the sorter. current options are

• stringify: whether or not to stringify the result (default: true)

handler

or you can import the handler

1import handler from "@m4rch/sort-package-json"

and just give as only argument the path (relative to where you execute the command)

1handler(".")