feat: yarn key support, sort scripts

Author: shellscape

README.md

@@ -48,34 +48,54 @@ $ npx prettier --write package.json
 
 This plugin enforces its own set of opinionated rules:
 
+### Scripts
+
+Keys in `scripts` are ordered alphabetically. Use prefixes wisely to properly order child scripts. e.g. `lint`, `lint:ts`.
+
 ### Sorting
 
 Top-level keys are sorted according to a style commonly seen in the packages of [@sindresorhus](https://github.com/sindresorhus). Known keys, and their order are:
 
 ```js
 [
+  // meta
   'name',
   'version',
+  'flat',
+  'private',
   'publishConfig',
   'description',
   'license',
   'repository',
   'author',
   'homepage',
   'bugs',
+
+  // entry
   'main',
+  'bin',
+
+  // constraints
   'engines',
+  'cpu',
+  'os',
+
+  // content and util
   'scripts',
   'files',
   'keywords',
-  'peerDependencies',
+
+  // dependencies
+  'bundledDependencies',
   'optionalDependencies',
+  'peerDependencies',
   'dependencies',
-  'devDependencies'
+  'devDependencies',
+  'resolutions'
 ]
 ```
 
-Unknown keys, or keys not part of the list above, will be alphabetically sorted and added to the end of the file.
+Unknown keys, or keys not part of the list above, will be alphabetically sorted and added to the end of the file. Note that this list takes into account both `npm` and `yarn` keys.
 
 ### Forthcoming
 
@@ -85,7 +105,6 @@ Forthcoming rules include:
 - [ ] Engines format
 - [ ] Files order and content
 - [ ] Repository format
-- [ ] Scripts order
 
 ## Meta
 

lib/index.js

@@ -10,13 +10,18 @@
 */
 const { parsers } = require('prettier/parser-babylon');
 
+const { scripts } = require('./scripts');
 const { sort } = require('./sort');
 
 const { 'json-stringify': parser } = parsers;
 const rePkg = /package\.json$/;
 
 const format = (input) => {
-  const result = JSON.stringify(sort(input), null, 2);
+  let pkg = JSON.parse(input);
+  pkg = sort(pkg);
+  pkg = scripts(pkg);
+
+  const result = JSON.stringify(pkg, null, 2);
   return result;
 };
 

lib/scripts.js

@@ -0,0 +1,30 @@
+/*
+  Copyright © 2019 Andrew Powell
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of this Source Code Form.
+*/
+const sortScripts = (pkg) => {
+  const { scripts } = pkg;
+
+  if (!scripts) {
+    return pkg;
+  }
+
+  const result = Object.assign({}, pkg, { scripts: {} });
+  const keys = Object.keys(scripts).sort();
+
+  for (const key of keys) {
+    if (scripts[key]) {
+      result.scripts[key] = scripts[key];
+    }
+  }
+
+  return result;
+};
+
+module.exports = { scripts: sortScripts };

lib/sort.js

@@ -9,26 +9,43 @@
   included in all copies or substantial portions of this Source Code Form.
 */
 const primary = [
+  // meta
   'name',
   'version',
+  'flat',
+  'private',
+  'publishConfig',
   'description',
   'license',
   'repository',
   'author',
   'homepage',
   'bugs',
+
+  // entry
   'main',
+  'bin',
+
+  // constraints
   'engines',
+  'cpu',
+  'os',
+
+  // content and util
   'scripts',
   'files',
   'keywords',
+
+  // dependencies
+  'bundledDependencies',
+  'optionalDependencies',
   'peerDependencies',
   'dependencies',
-  'devDependencies'
+  'devDependencies',
+  'resolutions'
 ];
 
-const sort = (input) => {
-  const pkg = JSON.parse(input);
+const sort = (pkg) => {
   const result = {};
   const unknown = Object.keys(pkg)
     .filter((key) => !primary.includes(key))

test/fixtures/fixture.json

@@ -13,16 +13,16 @@
   },
   "scripts": {
     "ci:coverage": "nyc npm run ci:test && nyc report --reporter=text-lcov > coverage.lcov",
+    "lint": "eslint --fix --cache lib test && prettier --write package.json",
     "ci:lint": "npm run lint && npm run security",
+    "security": "npm audit",
     "ci:lint:commits": "commitlint --from=${CIRCLE_BRANCH} --to=${CIRCLE_SHA1}",
     "ci:test": "npm run test -- --verbose",
     "commitlint": "commitlint",
-    "commitmsg": "commitlint -e $GIT_PARAMS",
-    "lint": "eslint --fix --cache lib test && prettier --write package.json",
-    "lint-staged": "lint-staged",
     "prepublishOnly": "npm run lint",
-    "security": "npm audit",
-    "test": "ava"
+    "commitmsg": "commitlint -e $GIT_PARAMS",
+    "test": "ava",
+    "lint-staged": "lint-staged"
   },
   "files": [
     "lib/",

test/snapshots/test.js.md

@@ -82,3 +82,82 @@ Generated by [AVA](https://ava.li).
       "pre-commit": "lint-staged"␊
     }␊
     `
+
+## preprocess
+
+> Snapshot 1
+
+    `{␊
+      "name": "prettier-plugin-package",␊
+      "version": "0.1.1",␊
+      "description": "An opinionated package.json formatter plugin for Prettier",␊
+      "license": "MPL-2.0",␊
+      "repository": "shellscape/prettier-plugin-package",␊
+      "author": "shellscape",␊
+      "homepage": "https://github.com/shellscape/prettier-plugin-package",␊
+      "bugs": "https://github.com/shellscape/prettier-plugin-package/issues",␊
+      "main": "lib/index.js",␊
+      "engines": {␊
+        "node": ">= 8.0.0"␊
+      },␊
+      "scripts": {␊
+        "ci:coverage": "nyc npm run ci:test && nyc report --reporter=text-lcov > coverage.lcov",␊
+        "ci:lint": "npm run lint && npm run security",␊
+        "ci:lint:commits": "commitlint --from=${CIRCLE_BRANCH} --to=${CIRCLE_SHA1}",␊
+        "ci:test": "npm run test -- --verbose",␊
+        "commitlint": "commitlint",␊
+        "commitmsg": "commitlint -e $GIT_PARAMS",␊
+        "lint": "eslint --fix --cache lib test && prettier --write package.json",␊
+        "lint-staged": "lint-staged",␊
+        "prepublishOnly": "npm run lint",␊
+        "security": "npm audit",␊
+        "test": "ava"␊
+      },␊
+      "files": [␊
+        "lib/",␊
+        "README.md",␊
+        "LICENSE"␊
+      ],␊
+      "keywords": [␊
+        "package",␊
+        "package.json",␊
+        "plugin",␊
+        "prettier"␊
+      ],␊
+      "peerDependencies": {␊
+        "prettier": "^1.18.2"␊
+      },␊
+      "dependencies": {},␊
+      "devDependencies": {␊
+        "@commitlint/cli": "^8.1.0",␊
+        "@commitlint/config-conventional": "^8.1.0",␊
+        "ava": "^2.2.0",␊
+        "eslint-config-shellscape": "^2.0.2",␊
+        "execa": "^2.0.3",␊
+        "lint-staged": "^9.2.0",␊
+        "nyc": "^14.1.0",␊
+        "pre-commit": "^1.2.2",␊
+        "prettier": "^1.18.2"␊
+      },␊
+      "ava": {␊
+        "files": [␊
+          "!**/fixtures/**"␊
+        ]␊
+      },␊
+      "lint-staged": {␊
+        "*.js": [␊
+          "eslint --fix",␊
+          "git add"␊
+        ]␊
+      },␊
+      "nyc": {␊
+        "include": [␊
+          "lib/*.js"␊
+        ],␊
+        "exclude": [␊
+          "test/"␊
+        ]␊
+      },␊
+      "pre-commit": "lint-staged"␊
+    }␊
+    `

test/snapshots/test.js.snap

@@ -18,7 +18,32 @@ test('randomize', (t) => {
   const options = {
     filepath: join(__dirname, 'package.json'),
     parser: 'json-stringify',
-    plugins: ['.']
+    plugins: ['.'],
+    shit: 'balls'
+  };
+  const keys = shuffle(Object.keys(pkg));
+  const fixture = {};
+
+  for (const key of keys) {
+    fixture[key] = pkg[key];
+  }
+
+  const input = JSON.stringify(fixture, null, 2);
+  const output = prettier.format(input, options);
+
+  t.snapshot(output);
+});
+
+test('preprocess', (t) => {
+  const options = {
+    filepath: join('package.json'),
+    parser: 'json-stringify',
+    plugins: ['.'],
+    preprocess: (input) => {
+      const { version, repository } = JSON.parse(input);
+      const result = { repository, version };
+      return result;
+    }
   };
   const keys = shuffle(Object.keys(pkg));
   const fixture = {};
@@ -32,3 +57,16 @@ test('randomize', (t) => {
 
   t.snapshot(output);
 });
+
+test('not package.json', (t) => {
+  const options = {
+    filepath: 'batman.json',
+    parser: 'json-stringify',
+    plugins: ['.']
+  };
+  const fixture = { version: 'batman', name: 'joker' };
+  const input = JSON.stringify(fixture, null, 2);
+  const output = prettier.format(input, options);
+
+  t.is(input.trim(), output.trim());
+});