@suprj/fixpack v2.4.0

fixpack

A package.json file scrubber for the truly insane.

It will re-write your package.json file as follows:

• name first
• description second
• version third
• author fourth
• all other keys in alphabetical order
• dependencies and devDependencies sorted alphabetically
• newline at the end of the file

It will warn you if any of these are missing:

• description
• author
• repository
• keywords
• main
• bugs
• homepage
• license

Fix all indenting to 2 spaces.

Oh, and it will tolerate improperly quoted and comma'd JSON thanks to ALCE.

Oh, and can do same if you pass it a bower.json file or whatnot.

Usage

1. Install it globally

$ npm i -g @suprj/fixpack

2. Run it in the same directory as your package.json, that's it.

$ fixpack

What you might do if you're clever

$ npm i cool_package --save && fixpack

Configuration

It's configurable. You can create a .fixpackrc file in your project or anywhere up the tree to your $HOME directory. Or overwrite options via CLI arguments.

Uses the rc module to do this. So you can pass all these as CLI args too.

The available options and their defaults shown below:

{
  // will put these first in this order if present
  "sortToTop": ["name", "description", "version", "author"],
  // will error if these are not present
  "required": ["name", "version"],
  // will warn if these not present
  "warn": [
    "description",
    "author",
    "repository",
    "keywords",
    "main",
    "bugs",
    "homepage",
    "license"
  ],
  // if `private: true` in package.json, it will use the next two lists instead
  "requiredOnPrivate": [],
  "warnOnPrivate": ["name", "version", "description", "main"],
  // sub items to sort by default
  "sortedSubItems": [
    "dependencies",
    "devDependencies",
    "jshintConfig",
    "scripts",
    "keywords"
  ],
  // sub items to not sort (overrides "sortedSubItems")
  "skipSortedSubItems": ["keywords"],
  // if you set quiet to true it won't do output anything to the console
  "quiet": false,
  // files to scrub
  "files": ["package.json"],
  // will set all deps to '*'
  // this may be useful because then you can
  // run npm update --save && npm update --save-dev
  // to install latest stable releases of everything.
  "wipe": false
}

Changelog

• 2.4.0 - update dependencies, lint using ESLint/Prettier, allow option to not sort specified subitems
• 2.3.0 - add wipe option that sets all dep versions to * for easier bulk updating.
• 2.2.0 - add optionalDependencies to auto sorted
• 2.1.0 - switched to standard style. Add peerDependencies to default sorted keys.
• 2.0.1 - don't error on missing bower file by default.
• 2.0.0 - configurable via .fixpackrc file using rc module.
• x.x.x - unknown miscellaneous madness and poor version tracking
• 0.0.2 diff - EOF newline
• 0.0.1 - initial release

Credits

This embarrassing display of insanity, type-A-ness, and OCD brought to you by @HenrikJoreteg.

License

MIT