chore: intermediate custom sort

Squashed commit of the following:

commit a44db9e23a35805b53161adaa9b85556f40b67a2
Merge: 162d2eb e240b44
Author: shellscape <[email protected]>
Date:   Sun Oct 6 19:20:28 2019 -0400

    chore: Merge branch 'feat/sort-dependencies' of https://github.com/will-stone/prettier-plugin-package into will-stone-feat/sort-dependencies

commit e240b44
Author: Will Stone <[email protected]>
Date:   Thu Oct 3 10:41:57 2019 +0100

    feat: sort dependencies

Author: shellscape

lib/index.js

@@ -10,6 +10,7 @@
 */
 const { parsers } = require('prettier/parser-babylon');
 
+const { dependencies } = require('./rules/dependencies');
 const { engines } = require('./rules/engines');
 const { files } = require('./rules/files');
 const { scripts } = require('./rules/scripts');
@@ -24,6 +25,7 @@ const format = (properties) => {
   props = engines(props);
   props = files(props);
   props = scripts(props);
+  props = dependencies(props);
 
   return props;
 };

lib/rules/dependencies.js

@@ -0,0 +1,32 @@
+/*
+  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 dependencyNames = [
+  // dependencies
+  'bundledDependencies',
+  'optionalDependencies',
+  'peerDependencies',
+  'dependencies',
+  'devDependencies',
+  'resolutions'
+];
+
+const process = (props) =>
+  props.map((prop) => {
+    if (dependencyNames.includes(prop.key.value)) {
+      prop.value.properties.sort((a, b) =>
+        a.key.value > b.key.value ? 1 : a.key.value < b.key.value ? -1 : 0
+      );
+    }
+    return prop;
+  });
+
+module.exports = { dependencies: process };

lib/rules/props.js

@@ -0,0 +1,74 @@
+/*
+  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 primary = [
+  // meta
+  'name',
+  'version',
+  'flat',
+  'private',
+  'publishConfig',
+  'description',
+  'license',
+  'repository',
+  'author',
+  'homepage',
+  'bugs',
+
+  // entry
+  'main',
+  'bin',
+  'module',
+
+  // constraints
+  'engines',
+  'cpu',
+  'os',
+
+  // content and util
+  'scripts',
+  'files',
+  'keywords',
+
+  // dependencies
+  'bundledDependencies',
+  'optionalDependencies',
+  'peerDependencies',
+  'dependencies',
+  'devDependencies',
+  'resolutions',
+
+  // types
+  'types',
+  'typings'
+];
+
+const sort = (props) => {
+  const unknown = [];
+  const known = props.filter((prop) => {
+    if (primary.includes(prop.key.value)) {
+      return true;
+    }
+    unknown.push(prop);
+    return false;
+  });
+
+  known.sort((a, b) => {
+    const aIndex = primary.indexOf(a.key.value);
+    const bIndex = primary.indexOf(b.key.value);
+
+    return aIndex > bIndex ? 1 : aIndex < bIndex ? -1 : 0;
+  });
+  unknown.sort((a, b) => (a.key.value > b.key.value ? 1 : a.key.value < b.key.value ? -1 : 0));
+
+  return known.concat(unknown);
+};
+
+module.exports = { sort };

test/fixtures/fixture.json

@@ -38,18 +38,25 @@
     "prettier"
   ],
   "peerDependencies": {
-    "prettier": "^1.18.2"
+    "prettier": "^1.18.2",
+    "eslint-config-shellscape": "^2.0.2"
+  },
+  "dependencies": {
+    "nyc": "^14.1.0",
+    "eslint-config-shellscape": "^2.0.2",
+    "ava": "^2.2.0",
+    "execa": "^2.0.3"
   },
   "typings": "dist/index.d.ts",
   "dependencies": {},
   "devDependencies": {
-    "@commitlint/cli": "^8.1.0",
     "@commitlint/config-conventional": "^8.1.0",
+    "lint-staged": "^9.2.0",
     "ava": "^2.2.0",
     "eslint-config-shellscape": "^2.0.2",
     "execa": "^2.0.3",
-    "lint-staged": "^9.2.0",
     "nyc": "^14.1.0",
+    "@commitlint/cli": "^8.1.0",
     "pre-commit": "^1.2.2",
     "prettier": "^1.18.2"
   },

test/snapshots/test.js.md

@@ -48,6 +48,7 @@ Generated by [AVA](https://ava.li).
         "prettier"␊
       ],␊
       "peerDependencies": {␊
+        "eslint-config-shellscape": "^2.0.2",␊
         "prettier": "^1.18.2"␊
       },␊
       "dependencies": {},␊
@@ -130,6 +131,7 @@ Generated by [AVA](https://ava.li).
         "prettier"␊
       ],␊
       "peerDependencies": {␊
+        "eslint-config-shellscape": "^2.0.2",␊
         "prettier": "^1.18.2"␊
       },␊
       "dependencies": {},␊