Sort dependencies (#52)

seek-oss · Jun 14, 2020 · 0c1e129 · 0c1e129
1 parent b85b4b3
commit 0c1e129
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/.changeset/chilly-wombats-notice.md b/.changeset/chilly-wombats-notice.md
@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+**configure, init:** Sort dependencies
diff --git a/src/cli/configure/processing/package.test.ts b/src/cli/configure/processing/package.test.ts
@@ -103,6 +103,36 @@ describe('withPackage', () => {
       "
     `));
 
+  it('sorts dependencies', () =>
+    expect(
+      withPackage((data) => data)(
+        JSON.stringify({
+          devDependencies: {
+            c: '3',
+            e: '5',
+            d: '4',
+          },
+          dependencies: {
+            b: '2',
+            a: '1',
+          },
+        }),
+      ),
+    ).toMatchInlineSnapshot(`
+      "{
+        \\"dependencies\\": {
+          \\"a\\": \\"1\\",
+          \\"b\\": \\"2\\"
+        },
+        \\"devDependencies\\": {
+          \\"c\\": \\"3\\",
+          \\"d\\": \\"4\\",
+          \\"e\\": \\"5\\"
+        }
+      }
+      "
+    `));
+
   it('handles bad JSON gracefully', () =>
     expect(
       withPackage((data) => {

diff --git a/src/cli/configure/processing/package.ts b/src/cli/configure/processing/package.ts
@@ -4,9 +4,22 @@ import { PackageJson } from '../types';
 
 import { formatObject, parseObject } from './json';
 
+const sortRecord = <T>(record: Record<string, T>): Record<string, T> =>
+  Object.fromEntries(
+    Object.entries(record).sort(([keyA], [keyB]) => keyA.localeCompare(keyB)),
+  );
+
 export const formatPackage = (data: PackageJson) => {
   normalizeData(data);
 
+  if (data.dependencies) {
+    data.dependencies = sortRecord(data.dependencies);
+  }
+
+  if (data.devDependencies) {
+    data.devDependencies = sortRecord(data.devDependencies);
+  }
+
   // normalize-package-data fields that aren't useful for applications
 
   delete data._id;