Extend Prettier’s Options interface with plugin options (#292)

Author: porada

src/index.test.ts

@@ -125,6 +125,7 @@ for (const parser of supportedParsers) {
   test(`${parser}: throws if jsonRecursiveSort is not a boolean`, async (t) => {
     await t.throwsAsync(
       async () =>
+        // @ts-expect-error Testing invalid option type
         format('{}', {
           filepath: `foo.${fileExtensions[parser]}`,
           parser,
@@ -143,6 +144,7 @@ for (const parser of supportedParsers) {
   test(`${parser}: throws if custom sort is not a string`, async (t) => {
     await t.throwsAsync(
       async () =>
+        // @ts-expect-error Testing invalid option type
         format('{}', {
           filepath: `foo.${fileExtensions[parser]}`,
           parser,

src/index.ts

@@ -480,3 +480,23 @@ export const options = {
     type: 'string' as const,
   },
 };
+
+/*
+ * Augument Prettier’s `Options` interface with JSON sorting options.
+ */
+declare module 'prettier' {
+  /* eslint-disable-next-line @typescript-eslint/consistent-type-definitions */
+  interface Options {
+    /**
+     * Sort JSON objects recursively, including all nested objects. This also sorts objects within JSON arrays.
+     *
+     * @default false
+     */
+    jsonRecursiveSort?: boolean | undefined;
+
+    /**
+     * Use a custom sort order. This is specified as a JSON string containing a set of sorting rules.
+     */
+    jsonSortOrder?: string | undefined;
+  }
+}