feat: support sorting package.json

.prettierignore

@@ -1,2 +1 @@
-package.json
 pnpm-lock.yaml

package.json

@@ -54,6 +54,7 @@
   },
   "dependencies": {
     "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
+    "prettier-plugin-packagejson": "^2.5.6",
     "prettier-plugin-tailwindcss": "^0.6.9",
     "rattail": "^1.0.18"
   },
@@ -77,4 +78,4 @@
   "engines": {
     "pnpm": ">=9.0"
   }
-}
+}

src/index.ts

@@ -2,15 +2,27 @@ import { PluginConfig } from '@ianvs/prettier-plugin-sort-imports'
 import { Config as PrettierConfig } from 'prettier'
 import { normalizeToArray } from 'rattail'
 
-export type Config = PrettierConfig & PluginConfig
+export type Config = PrettierConfig &
+  PluginConfig & {
+    packageSortOrder?: string[]
+  }
 
 export type DefineConfigOptions = Config & {
   sortImports?: boolean
   sortAtomicClass?: boolean
+  sortPackageJson?: boolean
 }
 
 export function defineConfig(options: DefineConfigOptions = {}): Config {
-  const { sortImports = true, sortAtomicClass = true, plugins = [], ...rest } = options
+  const {
+    sortImports = true,
+    sortAtomicClass = true,
+    sortPackageJson = true,
+    packageSortOrder = [],
+    overrides = [],
+    plugins = [],
+    ...rest
+  } = options
 
   const builtinPlugins: string[] = []
 
@@ -22,6 +34,10 @@ export function defineConfig(options: DefineConfigOptions = {}): Config {
     builtinPlugins.push('prettier-plugin-tailwindcss')
   }
 
+  if (sortPackageJson) {
+    builtinPlugins.push('prettier-plugin-packagejson')
+  }
+
   return {
     printWidth: 120,
     singleQuote: true,
@@ -30,6 +46,19 @@ export function defineConfig(options: DefineConfigOptions = {}): Config {
       ? ['<BUILTIN_MODULES>', '^vue$', '^react$', '<THIRD_PARTY_MODULES>', '^@/(.*)$', '^~/(.*)$', '^[.]']
       : undefined,
     plugins: [...builtinPlugins, ...normalizeToArray(plugins)],
+    overrides: [
+      ...(sortPackageJson
+        ? [
+            {
+              files: '**/package.json',
+              options: {
+                packageSortOrder,
+              },
+            },
+          ]
+        : []),
+      ...normalizeToArray(overrides),
+    ],
     ...rest,
   }
 }

tests/index.spec.ts

@@ -8,7 +8,15 @@ describe('test config', () => {
       singleQuote: true,
       semi: false,
       importOrder: ['<BUILTIN_MODULES>', '^vue$', '^react$', '<THIRD_PARTY_MODULES>', '^@/(.*)$', '^~/(.*)$', '^[.]'],
-      plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-tailwindcss'],
+      plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-tailwindcss', 'prettier-plugin-packagejson'],
+      overrides: [
+        {
+          files: '**/package.json',
+          options: {
+            packageSortOrder: [],
+          },
+        },
+      ],
     })
   })
 
@@ -18,29 +26,105 @@ describe('test config', () => {
       singleQuote: true,
       semi: false,
       importOrder: undefined,
-      plugins: ['prettier-plugin-tailwindcss'],
+      plugins: ['prettier-plugin-tailwindcss', 'prettier-plugin-packagejson'],
+      overrides: [
+        {
+          files: '**/package.json',
+          options: {
+            packageSortOrder: [],
+          },
+        },
+      ],
     })
   })
 
-  it('sortImports is false', () => {
+  it('sortAtomicClass is false', () => {
     expect(defineConfig({ sortAtomicClass: false })).toStrictEqual({
       printWidth: 120,
       singleQuote: true,
       semi: false,
       importOrder: ['<BUILTIN_MODULES>', '^vue$', '^react$', '<THIRD_PARTY_MODULES>', '^@/(.*)$', '^~/(.*)$', '^[.]'],
-      plugins: ['@ianvs/prettier-plugin-sort-imports'],
+      plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-packagejson'],
+      overrides: [
+        {
+          files: '**/package.json',
+          options: {
+            packageSortOrder: [],
+          },
+        },
+      ],
+    })
+  })
+
+  it('sortPackageJson is false', () => {
+    expect(defineConfig({ sortPackageJson: false })).toStrictEqual({
+      printWidth: 120,
+      singleQuote: true,
+      semi: false,
+      importOrder: ['<BUILTIN_MODULES>', '^vue$', '^react$', '<THIRD_PARTY_MODULES>', '^@/(.*)$', '^~/(.*)$', '^[.]'],
+      plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-tailwindcss'],
+      overrides: [],
+    })
+  })
+
+  it('custom packageSortOrder', () => {
+    expect(defineConfig({ packageSortOrder: ['name', 'version', 'description', 'scripts'] })).toStrictEqual({
+      printWidth: 120,
+      singleQuote: true,
+      semi: false,
+      importOrder: ['<BUILTIN_MODULES>', '^vue$', '^react$', '<THIRD_PARTY_MODULES>', '^@/(.*)$', '^~/(.*)$', '^[.]'],
+      plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-tailwindcss', 'prettier-plugin-packagejson'],
+      overrides: [
+        {
+          files: '**/package.json',
+          options: {
+            packageSortOrder: ['name', 'version', 'description', 'scripts'],
+          },
+        },
+      ],
     })
   })
 
   it('custom config', () => {
     expect(
-      defineConfig({ semi: true, plugins: ['prettier-plugin-test'], vueIndentScriptAndStyle: true }),
+      defineConfig({
+        semi: true,
+        plugins: ['prettier-plugin-test'],
+        vueIndentScriptAndStyle: true,
+        overrides: [
+          {
+            files: '*.md',
+            options: {
+              organizeImportsSkipDestructiveCodeActions: true,
+            },
+          },
+        ],
+      }),
     ).toStrictEqual({
       printWidth: 120,
       singleQuote: true,
       semi: true,
       importOrder: ['<BUILTIN_MODULES>', '^vue$', '^react$', '<THIRD_PARTY_MODULES>', '^@/(.*)$', '^~/(.*)$', '^[.]'],
-      plugins: ['@ianvs/prettier-plugin-sort-imports', 'prettier-plugin-tailwindcss', 'prettier-plugin-test'],
+      plugins: [
+        '@ianvs/prettier-plugin-sort-imports',
+        'prettier-plugin-tailwindcss',
+        'prettier-plugin-packagejson',
+        'prettier-plugin-test',
+      ],
+      overrides: [
+        {
+          files: '**/package.json',
+          options: {
+            packageSortOrder: [],
+          },
+        },
+        {
+          files: '*.md',
+          options: {
+            organizeImportsSkipDestructiveCodeActions: true,
+          },
+        },
+      ],
       vueIndentScriptAndStyle: true,
     })
   })