Skip to content

feremabraz/packagejson-alphabetically

Repository files navigation

packagejson-alphabetically (reborn)

Sorts package.json alphabetically.

I lost my old npm account XD, so I had to publish this under a new name, sorry!

packagejson-alphabetically

How to use

As a dev dependency:

pnpm add --save-dev packagejson-alphabetically-reborn
pnpm exec packagejson-alphabetically

Directly:

pnpm dlx packagejson-alphabetically-reborn

CLI Options

  • pnpm exec packagejson-alphabetically [path] — Sorts the specified package.json file (default: ./package.json).
  • --check — Checks if the file is already sorted. Exits with code 0 if sorted, 1 if not. Useful for CI/linting.
  • --dry-run — Prints the sorted output to stdout without writing to disk.

Examples

Sort the default package.json:

pnpm exec packagejson-alphabetically

Sort a custom path:

pnpm exec packagejson-alphabetically ./some/other/package.json

Check if sorted (CI/lint):

pnpm exec packagejson-alphabetically --check

Preview sorted output without writing:

pnpm exec packagejson-alphabetically --dry-run

Features

  • Deep sorting: All nested objects (e.g., dependencies, devDependencies, scripts) are sorted alphabetically.
  • Robust error handling: Handles missing files, invalid JSON, and write errors with clear messages.

Error Handling

  • If the specified file does not exist, you will see a "File not found" error.
  • If the file contains invalid JSON, you will see an "Invalid JSON" error.
  • Any other errors will be shown with a descriptive message.

About

Sorts package.json alphabetically.

Topics

Resources

License

Stars

Watchers

Forks

Contributors