npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

better-sort-package-json

v1.1.0

Published

Sort a package.json file following the NPM docs

Downloads

407

Readme

better-sort-package-json

Sorts a package.json file following these rules:

  1. The root properties follow the order they appear in the NPM package.json specification, then the Node.JS fields, and finally all the other properties.
  2. The string arrays in the root, such as keywords and files, are sorted alphabetically.
  3. The properties in script are sorted alphabetically but placing the "pre" and "post" scripts along with before and after its target.
  4. All other nested objects have their properties sorted in alphabetical order.

Motivation and prior art

Other packages like sort-package-json already exist but there is no way to customize the sorting rule applied and I was looking for a simpler set matching current practices at Hemi.

CLI

This package can be installed globally, then used to sort package.json files:

npm install --global better-sort-package-json
better-sort-package-json <path-to-a-package-json-file-to-sort>

In addition, it can be used without installing it:

npx better-sort-package-json <path-to-a-package-json-file-to-sort>

API

Install the package:

npm install better-sort-package-json

Then use it to sort the contents of a package.json:

import * as fs from "node:fs";
import { sortPackageJson } from "better-sort-package-json";

fs.writeFileSync(path, sortPackageJson(fs.readFileSync(path, "utf8")));

Automatically sort on commit

To i.e. let lint-staged take care of sorting the package.json automatically, but without altering the formatting done by Prettier, this configuration can be used:

{
  "*.json,!package.json": ["prettier --write"],
  "package.json": ["better-sort-package-json", "prettier --write"]
}