Merge branch 'master' into format-renovate-config

seek-oss · Jun 24, 2020 · 5ad9e44 · 5ad9e44
2 parents 86ed9de + 92729fd
commit 5ad9e44
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 4 deletions.
diff --git a/.changeset/rare-apples-know.md b/.changeset/rare-apples-know.md
@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+**configure, init:** Format `package.json` consistently
diff --git a/src/cli/configure/processing/json.test.ts b/src/cli/configure/processing/json.test.ts
@@ -16,6 +16,27 @@ describe('formatObject', () => {
       }
       "
     `));
+
+  it('handles ordinary JSON array formatting', () =>
+    expect(formatObject({ files: ['1', '2', '3'] })).toMatchInlineSnapshot(`
+      "{
+        \\"files\\": [\\"1\\", \\"2\\", \\"3\\"]
+      }
+      "
+    `));
+
+  it('handles special-cased package.json array formatting', () =>
+    expect(formatObject({ files: ['1', '2', '3'] }, 'package.json'))
+      .toMatchInlineSnapshot(`
+      "{
+        \\"files\\": [
+          \\"1\\",
+          \\"2\\",
+          \\"3\\"
+        ]
+      }
+      "
+    `));
 });
 
 describe('parseObject', () => {

diff --git a/src/cli/configure/processing/json.ts b/src/cli/configure/processing/json.ts
@@ -2,7 +2,10 @@ import prettier from 'prettier';
 
 import { isObject } from '../../../utils/validation';
 
-export const formatObject = (data: Record<PropertyKey, unknown>) => {
+export const formatObject = (
+  data: Record<PropertyKey, unknown>,
+  filepath?: string,
+) => {
   const sortedData = Object.fromEntries(
     Object.entries(data).sort(([keyA], [keyB]) =>
       String(keyA).localeCompare(String(keyB)),
@@ -11,7 +14,10 @@ export const formatObject = (data: Record<PropertyKey, unknown>) => {
 
   const output = JSON.stringify(sortedData, null, 2);
 
-  return prettier.format(output, { parser: 'json' });
+  return prettier.format(
+    output,
+    typeof filepath === 'undefined' ? { parser: 'json' } : { filepath },
+  );
 };
 
 export const parseObject = (

diff --git a/src/cli/configure/processing/package.test.ts b/src/cli/configure/processing/package.test.ts
@@ -138,7 +138,10 @@ describe('withPackage', () => {
           \\"d\\": \\"4\\",
           \\"e\\": \\"5\\"
         },
-        \\"files\\": [\\"b\\", \\"a\\"],
+        \\"files\\": [
+          \\"b\\",
+          \\"a\\"
+        ],
         \\"scripts\\": {
           \\"prebuild\\": \\"rm -rf system32\\",
           \\"build\\": \\"npm install freebsd\\"

diff --git a/src/cli/configure/processing/package.ts b/src/cli/configure/processing/package.ts
@@ -35,7 +35,7 @@ export const formatPackage = (data: PackageJson) => {
     delete data.version;
   }
 
-  return formatObject(data);
+  return formatObject(data, 'package.json');
 };
 
 export const parsePackage = (