@monorepolint/rules 0.6.0-alpha.2 → 0.6.0-alpha.4

package/src/mustSatisfyPeerDependencies.ts

@@ -8,9 +8,9 @@
 import { Context } from "@monorepolint/config";
 import { Host, mutateJson, PackageJson } from "@monorepolint/utils";
 import * as path from "node:path";
+import resolvePackagePath from "resolve-package-path";
 import * as r from "runtypes";
 import { coerce } from "semver";
-import resolvePackagePath from "resolve-package-path";
 import { createRuleFactory } from "./util/createRuleFactory.js";
 
 const Options = r.Union(
@@ -29,7 +29,7 @@ const Options = r.Union(
         dependencyWhitelist: r.Undefined,
         dependencyBlacklist: r.Undefined,
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -40,7 +40,7 @@ const Options = r.Union(
         skipUnparseableRanges: r.Undefined,
         dependencyBlacklist: r.Undefined,
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -51,7 +51,7 @@ const Options = r.Union(
         skipUnparseableRanges: r.Undefined,
         dependencyWhitelist: r.Undefined,
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -62,7 +62,7 @@ const Options = r.Union(
         skipUnparseableRanges: r.Undefined,
         dependencyWhitelist: r.Undefined,
         dependencyBlacklist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -73,7 +73,7 @@ const Options = r.Union(
       r.Partial({
         dependencyBlacklist: r.Undefined,
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -84,7 +84,7 @@ const Options = r.Union(
       r.Partial({
         dependencyWhitelist: r.Undefined,
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -95,7 +95,7 @@ const Options = r.Union(
       r.Partial({
         dependencyWhitelist: r.Undefined,
         dependencyBlacklist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -106,7 +106,7 @@ const Options = r.Union(
       r.Partial({
         skipUnparseableRanges: r.Undefined,
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -117,7 +117,7 @@ const Options = r.Union(
       r.Partial({
         skipUnparseableRanges: r.Undefined,
         dependencyBlacklist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -128,7 +128,7 @@ const Options = r.Union(
       r.Partial({
         skipUnparseableRanges: r.Undefined,
         dependencyWhitelist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -139,7 +139,7 @@ const Options = r.Union(
     .And(
       r.Partial({
         enforceForDevDependencies: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -150,7 +150,7 @@ const Options = r.Union(
     .And(
       r.Partial({
         dependencyBlacklist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -161,7 +161,7 @@ const Options = r.Union(
     .And(
       r.Partial({
         dependencyWhitelist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -172,14 +172,14 @@ const Options = r.Union(
     .And(
       r.Partial({
         skipUnparseableRanges: r.Undefined,
-      })
+      }),
     ),
   r.Record({
     skipUnparseableRanges: r.Boolean,
     dependencyWhitelist: r.Array(r.String),
     dependencyBlacklist: r.Array(r.String),
     enforceForDevDependencies: r.Boolean,
-  })
+  }),
 );
 
 export type Options = r.Static<typeof Options>;
@@ -270,7 +270,12 @@ interface IResolvedPeerDependencyRequirement {
 }
 
 function checkSatisfyPeerDependencies(context: Context, opts: Options) {
-  const { dependencyBlacklist, dependencyWhitelist, enforceForDevDependencies, skipUnparseableRanges } = opts;
+  const {
+    dependencyBlacklist,
+    dependencyWhitelist,
+    enforceForDevDependencies,
+    skipUnparseableRanges,
+  } = opts;
   const packageJsonPath = path.resolve(context.getPackageJsonPath());
   const packageJson = context.host.readJson(packageJsonPath) as PackageJson;
   const packageDependencies = packageJson.dependencies || {};
@@ -279,8 +284,18 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
   const packageName = packageJson.name || packageJsonPath;
 
   // check that no peer dependencies are also declared as regular dependencies
-  for (const [peerDependencyName, peerDependencyRange] of Object.entries(packagePeerDependencies)) {
-    if (shouldSkipPackage({ dependencyBlacklist, dependencyWhitelist, packageName: peerDependencyName })) {
+  for (
+    const [peerDependencyName, peerDependencyRange] of Object.entries(
+      packagePeerDependencies,
+    )
+  ) {
+    if (
+      shouldSkipPackage({
+        dependencyBlacklist,
+        dependencyWhitelist,
+        packageName: peerDependencyName,
+      })
+    ) {
       continue;
     }
 
@@ -288,37 +303,59 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
     if (dependencyRange != null) {
       context.addError({
         file: packageJsonPath,
-        message:
-          `[0] Package ${packageName} has overloaded ${peerDependencyName} dependencies.\n\t` +
-          `Peer dependency '${peerDependencyRange}' and regular dependency '${dependencyRange}'.`,
+        message: `[0] Package ${packageName} has overloaded ${peerDependencyName} dependencies.\n\t`
+          + `Peer dependency '${peerDependencyRange}' and regular dependency '${dependencyRange}'.`,
       });
     }
   }
 
   // map of all inherited peer dependency requirements
-  const allRequiredPeerDependencies: { [peerDependencyName: string]: IPeerDependencyRequirement[] } = {};
+  const allRequiredPeerDependencies: {
+    [peerDependencyName: string]: IPeerDependencyRequirement[];
+  } = {};
 
   // for each of this package's dependencies, add the dependency's peer requirements into `allRequiredPeerDependencies`
   const allDependencies = enforceForDevDependencies
-    ? [...Object.keys(packageDependencies), ...Object.keys(packageDevDependencies)]
+    ? [
+      ...Object.keys(packageDependencies),
+      ...Object.keys(packageDevDependencies),
+    ]
     : Object.keys(packageDependencies);
   for (const dependency of allDependencies) {
-    const dependencyPackageJsonPath = resolvePackagePath(dependency, path.dirname(packageJsonPath));
+    const dependencyPackageJsonPath = resolvePackagePath(
+      dependency,
+      path.dirname(packageJsonPath),
+    );
     if (dependencyPackageJsonPath == null) {
-      throw new Error(`Could not resolve ${dependency} from ${path.dirname(packageJsonPath)}`);
+      throw new Error(
+        `Could not resolve ${dependency} from ${path.dirname(packageJsonPath)}`,
+      );
     }
-    const dependencyPackageJson = context.host.readJson(dependencyPackageJsonPath) as PackageJson;
+    const dependencyPackageJson = context.host.readJson(
+      dependencyPackageJsonPath,
+    ) as PackageJson;
     const requiredPeerDependencies = dependencyPackageJson.peerDependencies;
     if (requiredPeerDependencies == null) {
       continue;
     }
-    for (const [peerDependencyName, range] of Object.entries(requiredPeerDependencies)) {
-      if (shouldSkipPackage({ dependencyBlacklist, dependencyWhitelist, packageName: peerDependencyName })) {
+    for (
+      const [peerDependencyName, range] of Object.entries(
+        requiredPeerDependencies,
+      )
+    ) {
+      if (
+        shouldSkipPackage({
+          dependencyBlacklist,
+          dependencyWhitelist,
+          packageName: peerDependencyName,
+        })
+      ) {
         continue;
       }
 
       if (!isValidRange(range)) {
-        const message = `Unable to parse ${dependencyPackageJson.name}'s ${peerDependencyName} peer dependency range '${range}'.`;
+        const message =
+          `Unable to parse ${dependencyPackageJson.name}'s ${peerDependencyName} peer dependency range '${range}'.`;
         if (skipUnparseableRanges) {
           context.addWarning({ file: dependencyPackageJsonPath, message });
           continue;
@@ -328,26 +365,40 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
       if (allRequiredPeerDependencies[peerDependencyName] == null) {
         allRequiredPeerDependencies[peerDependencyName] = [];
       }
-      allRequiredPeerDependencies[peerDependencyName].push({ fromPackageName: dependencyPackageJson.name!, range });
+      allRequiredPeerDependencies[peerDependencyName].push({
+        fromPackageName: dependencyPackageJson.name!,
+        range,
+      });
     }
   }
 
-  for (const [peerDependencyName, peerDependencyRequirements] of Object.entries(allRequiredPeerDependencies)) {
+  for (
+    const [peerDependencyName, peerDependencyRequirements] of Object.entries(
+      allRequiredPeerDependencies,
+    )
+  ) {
     // for each inherited peer dependency, determine the strictest range
     let mostStrictPeerRequirement: IResolvedPeerDependencyRequirement = {
       fromPeerDependencyRequirements: [peerDependencyRequirements[0]],
       range: peerDependencyRequirements[0].range,
     };
     for (const peerRequirement of peerDependencyRequirements) {
-      if (doesASatisfyB(mostStrictPeerRequirement.range, peerRequirement.range)) {
+      if (
+        doesASatisfyB(mostStrictPeerRequirement.range, peerRequirement.range)
+      ) {
         continue;
-      } else if (doesASatisfyB(peerRequirement.range, mostStrictPeerRequirement.range)) {
+      } else if (
+        doesASatisfyB(peerRequirement.range, mostStrictPeerRequirement.range)
+      ) {
         mostStrictPeerRequirement = {
           fromPeerDependencyRequirements: [peerRequirement],
           range: peerRequirement.range,
         };
       } else {
-        const maybeIntersection = findIntersection(peerRequirement.range, mostStrictPeerRequirement.range);
+        const maybeIntersection = findIntersection(
+          peerRequirement.range,
+          mostStrictPeerRequirement.range,
+        );
         if (maybeIntersection !== undefined) {
           mostStrictPeerRequirement = {
             fromPeerDependencyRequirements: [
@@ -360,9 +411,9 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
           context.addError({
             file: packageJsonPath,
             message:
-              `[1] Package ${packageName} has conflicting inherited ${peerDependencyName} peer dependencies.\n\t` +
-              `Dependency ${peerRequirement.fromPackageName} requires '${peerRequirement.range}' but\n\t` +
-              getMostStrictStatement(mostStrictPeerRequirement),
+              `[1] Package ${packageName} has conflicting inherited ${peerDependencyName} peer dependencies.\n\t`
+              + `Dependency ${peerRequirement.fromPackageName} requires '${peerRequirement.range}' but\n\t`
+              + getMostStrictStatement(mostStrictPeerRequirement),
           });
         }
       }
@@ -373,18 +424,21 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
     const packageDependencyRange = packageDependencies[peerDependencyName];
     if (packageDependencyRange != null) {
       if (!isValidRange(packageDependencyRange)) {
-        const message = `Unable to parse ${packageName}'s ${peerDependencyName} dependency range '${packageDependencyRange}'.`;
+        const message =
+          `Unable to parse ${packageName}'s ${peerDependencyName} dependency range '${packageDependencyRange}'.`;
         if (skipUnparseableRanges) {
           context.addWarning({ file: packageJsonPath, message });
         } else {
           throw new Error(message);
         }
-      } else if (!doesASatisfyB(packageDependencyRange, mostStrictPeerRequirement.range)) {
+      } else if (
+        !doesASatisfyB(packageDependencyRange, mostStrictPeerRequirement.range)
+      ) {
         context.addError({
           file: packageJsonPath,
           message:
-            `[2] Package ${packageName} dependency on ${peerDependencyName} '${packageDependencyRange}' does not satisfy inherited peer dependencies.\n\t` +
-            getMostStrictStatement(mostStrictPeerRequirement),
+            `[2] Package ${packageName} dependency on ${peerDependencyName} '${packageDependencyRange}' does not satisfy inherited peer dependencies.\n\t`
+            + getMostStrictStatement(mostStrictPeerRequirement),
         });
       }
     }
@@ -396,8 +450,8 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
       context.addError({
         file: packageJsonPath,
         message:
-          `[3] Package ${packageName} is missing required ${peerDependencyName} dependency.\n\t` +
-          getMostStrictStatement(mostStrictPeerRequirement),
+          `[3] Package ${packageName} is missing required ${peerDependencyName} dependency.\n\t`
+          + getMostStrictStatement(mostStrictPeerRequirement),
         fixer: getAddDependencyTypeFixer({
           packageJsonPath,
           dependencyType: "peerDependencies",
@@ -412,18 +466,24 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
     // the range must be equal to or stricter than `mostStrictPeerRequirement`
     if (packagePeerDependencyRange != null) {
       if (!isValidRange(packagePeerDependencyRange)) {
-        const message = `Unable to parse ${packageName}'s ${peerDependencyName} peer dependency range '${packagePeerDependencyRange}'.`;
+        const message =
+          `Unable to parse ${packageName}'s ${peerDependencyName} peer dependency range '${packagePeerDependencyRange}'.`;
         if (skipUnparseableRanges) {
           context.addWarning({ file: packageJsonPath, message });
         } else {
           throw new Error(message);
         }
-      } else if (!doesASatisfyB(packagePeerDependencyRange, mostStrictPeerRequirement.range)) {
+      } else if (
+        !doesASatisfyB(
+          packagePeerDependencyRange,
+          mostStrictPeerRequirement.range,
+        )
+      ) {
         context.addError({
           file: packageJsonPath,
           message:
-            `[4] Package ${packageName} peer dependency on ${peerDependencyName} '${packagePeerDependencyRange}' is not strict enough.\n\t` +
-            getMostStrictStatement(mostStrictPeerRequirement),
+            `[4] Package ${packageName} peer dependency on ${peerDependencyName} '${packagePeerDependencyRange}' is not strict enough.\n\t`
+            + getMostStrictStatement(mostStrictPeerRequirement),
           fixer: getAddDependencyTypeFixer({
             packageJsonPath,
             dependencyType: "peerDependencies",
@@ -448,28 +508,34 @@ function shouldSkipPackage({
 }) {
   // blacklist should take precedance
   if (
-    (dependencyBlacklist != null && dependencyBlacklist.includes(packageName)) ||
-    (dependencyWhitelist != null && !dependencyWhitelist.includes(packageName))
+    (dependencyBlacklist != null && dependencyBlacklist.includes(packageName))
+    || (dependencyWhitelist != null
+      && !dependencyWhitelist.includes(packageName))
   ) {
     return true;
   }
   return false;
 }
 
-function getMostStrictStatement(mostStrictPeerRequirement: IResolvedPeerDependencyRequirement) {
+function getMostStrictStatement(
+  mostStrictPeerRequirement: IResolvedPeerDependencyRequirement,
+) {
   if (mostStrictPeerRequirement.fromPeerDependencyRequirements.length === 1) {
-    const dependencyName = mostStrictPeerRequirement.fromPeerDependencyRequirements[0].fromPackageName;
+    const dependencyName = mostStrictPeerRequirement.fromPeerDependencyRequirements[0]
+      .fromPackageName;
     return `Dependency ${dependencyName} requires '${mostStrictPeerRequirement.range}'.`;
   } else {
-    const dependencyNames = mostStrictPeerRequirement.fromPeerDependencyRequirements
+    const dependencyNames = mostStrictPeerRequirement
+      .fromPeerDependencyRequirements
       .map((peerDependencyRequirement) => peerDependencyRequirement.fromPackageName)
       .join(", ");
-    const dependencyRequirements = mostStrictPeerRequirement.fromPeerDependencyRequirements
+    const dependencyRequirements = mostStrictPeerRequirement
+      .fromPeerDependencyRequirements
       .map((peerDependencyRequirement) => `'${peerDependencyRequirement.range}'`)
       .join(", ");
     return (
-      `Dependencies [${dependencyNames}] require [${dependencyRequirements}] respectively, ` +
-      `resolving to '${mostStrictPeerRequirement.range}'.`
+      `Dependencies [${dependencyNames}] require [${dependencyRequirements}] respectively, `
+      + `resolving to '${mostStrictPeerRequirement.range}'.`
     );
   }
 }
@@ -503,7 +569,10 @@ function getMostStrictStatement(mostStrictPeerRequirement: IResolvedPeerDependen
  * @param b version range that matches `RANGE_REGEX`
  * @returns the maximum intersecting `ValidRange`, or `undefined` if there is no intersection
  */
-export function findIntersection(a: ValidRange, b: ValidRange): ValidRange | undefined {
+export function findIntersection(
+  a: ValidRange,
+  b: ValidRange,
+): ValidRange | undefined {
   if (doesASatisfyB(a, b)) {
     return a;
   } else if (doesASatisfyB(b, a)) {
@@ -574,9 +643,19 @@ export function findIntersection(a: ValidRange, b: ValidRange): ValidRange | und
         // there is no intersecting `b` major version for this `a` major version
         return undefined;
       }
-      if (doesASatisfyB(aVersion as ValidRange, majorMatchingBVersion as ValidRange)) {
+      if (
+        doesASatisfyB(
+          aVersion as ValidRange,
+          majorMatchingBVersion as ValidRange,
+        )
+      ) {
         return aVersion;
-      } else if (doesASatisfyB(majorMatchingBVersion as ValidRange, aVersion as ValidRange)) {
+      } else if (
+        doesASatisfyB(
+          majorMatchingBVersion as ValidRange,
+          aVersion as ValidRange,
+        )
+      ) {
         return majorMatchingBVersion;
       } else {
         return undefined;
@@ -673,7 +752,9 @@ export function doesASatisfyB(a: ValidRange, b: ValidRange): boolean {
 
     const aVersionIsRange = isMajorVersionRange(aVersion);
     const majorMatchingBSemVer = coerce(majorMatchingBVersion)!;
-    const majorMatchingBVersionIsRange = isMajorVersionRange(majorMatchingBVersion);
+    const majorMatchingBVersionIsRange = isMajorVersionRange(
+      majorMatchingBVersion,
+    );
 
     if (majorMatchingBVersionIsRange) {
       // `a` satisfies `b` so long as `aSemVer` is greater than or equal to `majorMatchingBSemVer`

package/src/nestedWorkspaces.ts

@@ -21,18 +21,22 @@ export const nestedWorkspaces = createRuleFactory({
     const rootPackageJson = context.getWorkspaceContext().getPackageJson();
 
     // Expand a set of globs covering all package.json files in the entire repo (except the root)
-    const packageJsonPaths = globby.globbySync(["*/**/package.json", "!**/node_modules/**"]);
+    const packageJsonPaths = globby.globbySync([
+      "*/**/package.json",
+      "!**/node_modules/**",
+    ]);
 
     const workspaces = Array.isArray(rootPackageJson.workspaces)
       ? rootPackageJson.workspaces
       : rootPackageJson.workspaces !== undefined
-        ? rootPackageJson.workspaces.packages
-        : undefined;
+      ? rootPackageJson.workspaces.packages
+      : undefined;
 
     if (workspaces === undefined && packageJsonPaths.length > 0) {
       context.addError({
         file: context.getPackageJsonPath(),
-        message: 'The "workspace" field is missing, even though there are workspaces in the repository.',
+        message:
+          "The \"workspace\" field is missing, even though there are workspaces in the repository.",
       });
       return;
     }
@@ -41,18 +45,23 @@ export const nestedWorkspaces = createRuleFactory({
     const workspacePackageJsons = (workspaces || []).map((item) => `${item}/package.json`);
 
     // Expand the globs to get an array of all package.json files that are in packages specified by a workspace.
-    const expandedWorkspacesGlobs = globby.globbySync([...workspacePackageJsons, "!**/node_modules/**"]);
+    const expandedWorkspacesGlobs = globby.globbySync([
+      ...workspacePackageJsons,
+      "!**/node_modules/**",
+    ]);
 
     // Ensure there are no package.jsons which are not included in the globbed workspaces set
-    const difference = packageJsonPaths.filter((packageJsonPath) => !expandedWorkspacesGlobs.includes(packageJsonPath));
+    const difference = packageJsonPaths.filter((packageJsonPath) =>
+      !expandedWorkspacesGlobs.includes(packageJsonPath)
+    );
 
     if (difference.length !== 0) {
-      const differencesList = difference.map((packageJsonPath) => path.dirname(packageJsonPath)).join(", ");
+      const differencesList = difference.map((packageJsonPath) => path.dirname(packageJsonPath))
+        .join(", ");
       context.addError({
         file: context.getPackageJsonPath(),
-        message:
-          `The "workspace" field is missing one or more values: ${differencesList}. ` +
-          'You may be able to use a glob to avoid listing each workspace individually, e.g. "packages/nested-workspace/*".',
+        message: `The "workspace" field is missing one or more values: ${differencesList}. `
+          + "You may be able to use a glob to avoid listing each workspace individually, e.g. \"packages/nested-workspace/*\".",
       });
     }
   },

package/src/oncePerPackage.ts

@@ -0,0 +1,32 @@
+import * as r from "runtypes";
+import { createRuleFactory } from "./util/createRuleFactory.js";
+
+export const Options = r.Record({
+  singletonKey: r.String.Or(r.Symbol),
+  customMessage: r.String.optional(),
+});
+
+export type Options = r.Static<typeof Options>;
+
+const visitedMap = new Map<string | symbol, Set<string>>();
+
+export const oncePerPackage = createRuleFactory<Options>({
+  name: "oncePerPackage",
+
+  check: async (context, options) => {
+    const visited = visitedMap.get(options.singletonKey) ?? new Set<string>();
+    visitedMap.set(options.singletonKey, visited);
+
+    if (visited.has(context.getName())) {
+      context.addError({
+        message: "This package has already been visited for this key: "
+          + options.singletonKey.toString(),
+        file: context.getPackageJsonPath(),
+      });
+    } else {
+      visited.add(context.getName());
+    }
+  },
+
+  validateOptions: Options.assert,
+});

package/src/packageEntry.ts

@@ -18,7 +18,7 @@ export const Options = r.Union(
     .And(
       r.Partial({
         entriesExist: r.Undefined,
-      })
+      }),
     ),
   r
     .Record({
@@ -27,12 +27,12 @@ export const Options = r.Union(
     .And(
       r.Partial({
         entries: r.Undefined,
-      })
+      }),
     ),
   r.Record({
     entries: r.Dictionary(r.Unknown), // string => unknown, enforces existence of keys and their values
     entriesExist: r.Array(r.String),
-  })
+  }),
 );
 
 export type Options = r.Static<typeof Options>;
@@ -46,21 +46,28 @@ export const packageEntry = createRuleFactory<Options>({
       for (const key of Object.keys(options.entries)) {
         const value = options.entries[key];
 
-        const entryDiff = diff(JSON.stringify(value) + "\n", (JSON.stringify(packageJson[key]) || "") + "\n");
+        const entryDiff = diff(
+          JSON.stringify(value) + "\n",
+          (JSON.stringify(packageJson[key]) || "") + "\n",
+        );
         if (
-          (typeof value !== "object" && value !== packageJson[key]) ||
-          entryDiff == null ||
-          !entryDiff.includes("Compared values have no visual difference")
+          (typeof value !== "object" && value !== packageJson[key])
+          || entryDiff == null
+          || !entryDiff.includes("Compared values have no visual difference")
         ) {
           context.addError({
             file: context.getPackageJsonPath(),
             message: createStandardizedEntryErrorMessage(key),
             longMessage: entryDiff,
             fixer: () => {
-              mutateJson<PackageJson>(context.getPackageJsonPath(), context.host, (input) => {
-                input[key] = value;
-                return input;
-              });
+              mutateJson<PackageJson>(
+                context.getPackageJsonPath(),
+                context.host,
+                (input) => {
+                  input[key] = value;
+                  return input;
+                },
+              );
             },
           });
         }

package/src/packageOrder.ts

@@ -57,9 +57,13 @@ export const packageOrder = createRuleFactory<Options>({
     const packageJson = context.getPackageJson();
     const packagePath = context.getPackageJsonPath();
 
-    const order: string[] | OrderFunction = opts === undefined ? defaultKeyOrder : opts.order;
+    const order: string[] | OrderFunction = opts === undefined
+      ? defaultKeyOrder
+      : opts.order;
 
-    const comparator = isOrderFunction(order) ? order(context) : createComparator(order);
+    const comparator = isOrderFunction(order)
+      ? order(context)
+      : createComparator(order);
 
     const actualOrder = Object.keys(packageJson);
     const expectedOrder = actualOrder.slice().sort(comparator); // sort mutates, so we need to copy the previous result
@@ -118,6 +122,8 @@ function createComparator(order: ReadonlyArray<string>) {
   };
 }
 
-function isOrderFunction(order: ReadonlyArray<string> | OrderFunction): order is OrderFunction {
+function isOrderFunction(
+  order: ReadonlyArray<string> | OrderFunction,
+): order is OrderFunction {
   return !Array.isArray(order);
 }