feat: packageSortOrder option

matzkoh · Apr 11, 2024 · 084e11e · 084e11e
1 parent b5fa154
commit 084e11e
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 1 deletion.
diff --git a/lib/__snapshots__/index.test.js.snap b/lib/__snapshots__/index.test.js.snap
@@ -42,3 +42,46 @@ exports[`format should be correct 1`] = `
 }
 "
 `;
+
+exports[`format should follow custom order 1`] = `
+"{
+  "version": "",
+  "name": "",
+  "description": "",
+  "keywords": [
+    "C",
+    "B",
+    "A"
+  ],
+  "license": "",
+  "author": "",
+  "scripts": {
+    "prebuild": "",
+    "build": "",
+    "postbuild": "",
+    "dev": "",
+    "lint": "",
+    "start": "",
+    "pretest": "",
+    "test": "",
+    "posttest": ""
+  },
+  "dependencies": {
+    "A": "*",
+    "B": "*"
+  },
+  "devDependencies": {
+    "A": "*",
+    "B": "*"
+  },
+  "peerDependencies": {
+    "A": "*",
+    "B": "*"
+  },
+  "optionalDependencies": {
+    "A": "*",
+    "B": "*"
+  }
+}
+"
+`;
diff --git a/lib/index.cjs b/lib/index.cjs
@@ -22,8 +22,27 @@ exports.parsers = {
       if (parser.preprocess) {
         text = parser.preprocess(text, options)
       }
+      const sortPackageJsonOptions =
+        options.packageSortOrder.length !== 0
+          ? {
+              sortOrder: options.packageSortOrder,
+            }
+          : undefined
 
-      return testPath(options.filepath) ? sortPackageJson.default(text) : text
+      return testPath(options.filepath)
+        ? sortPackageJson.default(text, sortPackageJsonOptions)
+        : text
     },
   },
 }
+
+/** @type {import('prettier').Plugin['options']} */
+exports.options = {
+  packageSortOrder: {
+    category: 'Global',
+    type: 'string',
+    array: true,
+    default: [{ value: [] }],
+    description: 'Custom ordering array',
+  },
+}
diff --git a/lib/index.test.js b/lib/index.test.js
@@ -71,4 +71,15 @@ describe('format', () => {
 
     delete parsers['json-stringify'].preprocess
   })
+
+  it('should follow custom order', () =>
+    expect(
+      Promise.resolve(
+        prettier.format(uglyJson, {
+          filepath: 'package.json',
+          plugins: ['./lib/index.cjs'],
+          packageSortOrder: ['version', 'name'],
+        }),
+      ),
+    ).resolves.toMatchSnapshot())
 })