feat(fmt): support package.json sorting (#139)

Author: chenjiahan

package.json

@@ -20,7 +20,6 @@
     "cspell-ban-words": "catalog:",
     "heading-case": "catalog:",
     "prettier": "catalog:",
-    "prettier-plugin-packagejson": "catalog:",
     "rstack": "workspace:*",
     "typescript": "catalog:"
   },

packages/rstack/THIRD_PARTY_NOTICES.md

@@ -500,6 +500,57 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 
+## sort-package-json
+
+This package includes bundled code from
+[sort-package-json](https://github.com/keithamus/sort-package-json).
+
+License: MIT
+
+Copyright (c) 2015 Keith Cirkel
+
+The bundled code also contains MIT-licensed code from:
+
+- detect-indent 7.0.2, copyright Sindre Sorhus
+- detect-newline 4.0.1, copyright Sindre Sorhus
+- git-hooks-list 4.2.1, copyright fisker Cheung
+- is-plain-obj 4.1.0, copyright Sindre Sorhus
+- sort-object-keys 2.1.0, copyright Keith Cirkel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notices and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+The bundled code also contains semver 7.8.5, licensed under the ISC License:
+
+Copyright (c) Isaac Z. Schlueter and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
 ## tinyexec
 
 This package includes bundled code from [tinyexec](https://github.com/tinylibs/tinyexec).

packages/rstack/package.json

@@ -77,6 +77,7 @@
     "lint-staged": "catalog:",
     "micromatch": "catalog:",
     "rslog": "catalog:",
+    "sort-package-json": "catalog:",
     "tiny-readdir": "catalog:",
     "typescript": "catalog:",
     "worktank": "catalog:"

packages/rstack/src/fmt/config.ts

@@ -1,7 +1,11 @@
 import { dirname, relative } from 'node:path';
 import micromatch from 'micromatch';
-import type { Options as PrettierOptions } from 'prettier';
-import type { FmtConfig, FmtConfigDefinition, ResolvedFmtConfig } from './types.ts';
+import type {
+  FmtConfig,
+  FmtConfigDefinition,
+  ResolvedFmtConfig,
+  ResolvedFmtOptions,
+} from './types.ts';
 
 type ResolveFmtConfigOptions = {
   definition: FmtConfigDefinition | undefined;
@@ -45,7 +49,7 @@ const pathMatchesGlobs = (
 };
 
 /** Applies matching overrides to the shared formatter options. */
-const resolveFmtOptions = (filePath: string, config: ResolvedFmtConfig): PrettierOptions => {
+const resolveFmtOptions = (filePath: string, config: ResolvedFmtConfig): ResolvedFmtOptions => {
   if (config.overrides.length === 0) {
     return config.baseOptions;
   }

packages/rstack/src/fmt/format.ts

@@ -24,19 +24,20 @@ const formatText = async (
     ...options,
     filepath: filePath,
     parser,
-    plugins: getPrettierPlugins(options.plugins),
   };
+  const plugins = await getPrettierPlugins(formatOptions);
 
   if (cursorOffset === undefined) {
     return {
       status: 'formatted',
-      formatted: await format(source, formatOptions),
+      formatted: await format(source, { ...formatOptions, plugins }),
     };
   }
 
   const result = await formatWithCursor(source, {
     ...formatOptions,
     cursorOffset,
+    plugins,
   });
 
   return {

packages/rstack/src/fmt/parser.ts

@@ -16,7 +16,7 @@ const resolveFmtParser = async (
   (
     await getFileInfo(filePath, {
       ...fileInfoOptions,
-      plugins: getPrettierPlugins(options.plugins),
+      plugins: await getPrettierPlugins(options),
     })
   ).inferredParser;
 

packages/rstack/src/fmt/plugins.ts

@@ -2,10 +2,10 @@ import { isAbsolute, join, resolve as resolvePath } from 'node:path';
 import { pathToFileURL } from 'node:url';
 import { moduleResolve } from 'import-meta-resolve';
 import type { Options as PrettierOptions } from 'prettier';
-import type { FmtPluginSpecifier } from './types.ts';
+import type { FmtPluginSpecifier, ResolvedFmtOptions } from './types.ts';
 
 type FmtPlugin = NonNullable<PrettierOptions['plugins']>[number];
-type FmtPluginResolver = (options: PrettierOptions) => PrettierOptions;
+type FmtPluginResolver = (options: ResolvedFmtOptions) => ResolvedFmtOptions;
 
 const resolveModuleUrl = (specifier: string, parentUrl: URL): string =>
   moduleResolve(specifier, parentUrl).href;

packages/rstack/src/fmt/prettierPlugins.ts

@@ -1,12 +1,30 @@
 import * as yukuPlugin from '@prettier/plugin-yuku';
-import type { Options as PrettierOptions } from 'prettier';
+import type { Options as PrettierOptions, Plugin } from 'prettier';
+import type { ResolvedFmtOptions } from './types.ts';
 
 type PrettierPlugins = NonNullable<PrettierOptions['plugins']>;
 
-const defaultFmtPlugins: PrettierPlugins = [yukuPlugin];
+const fmtOptionsPlugin = {
+  options: {
+    sortPackageJson: {
+      category: 'Global',
+      default: false,
+      description: 'Sort package.json fields using sort-package-json.',
+      type: 'boolean',
+    },
+  },
+} satisfies Plugin;
 
-/** Prepends Yuku so project plugins can override the default parser. */
-const getPrettierPlugins = (plugins: PrettierOptions['plugins']): PrettierPlugins =>
-  plugins?.length ? [...defaultFmtPlugins, ...plugins] : defaultFmtPlugins;
+const defaultFmtPlugins: PrettierPlugins = [yukuPlugin, fmtOptionsPlugin];
+
+/** Prepends bundled plugins so project plugins can override their parsers. */
+const getPrettierPlugins = async (options: ResolvedFmtOptions): Promise<PrettierPlugins> => {
+  const plugins =
+    options.sortPackageJson === true && /(^|[/\\])package\.json$/.test(options.filepath ?? '')
+      ? [...defaultFmtPlugins, (await import('./sortPackageJsonPlugin.ts')).sortPackageJsonPlugin]
+      : defaultFmtPlugins;
+
+  return options.plugins?.length ? [...plugins, ...options.plugins] : plugins;
+};
 
 export { getPrettierPlugins };

packages/rstack/src/fmt/serial.ts

@@ -12,7 +12,7 @@ const formatFileSerial = async (
   const source = await readFile(path, 'utf8');
   const formatted = await format(source, {
     ...options,
-    plugins: getPrettierPlugins(options.plugins),
+    plugins: await getPrettierPlugins(options),
   });
 
   if (source === formatted) {

packages/rstack/src/fmt/sortPackageJsonPlugin.ts

@@ -0,0 +1,14 @@
+import type { Plugin } from 'prettier';
+import { parsers } from 'prettier/plugins/babel';
+import sortPackageJson from 'sort-package-json';
+
+const sortPackageJsonPlugin: Plugin = {
+  parsers: {
+    'json-stringify': {
+      ...parsers['json-stringify'],
+      preprocess: (source) => sortPackageJson(source),
+    },
+  },
+};
+
+export { sortPackageJsonPlugin };