@monorepolint/rules 0.5.0-alpha.97 → 0.5.0-beta.0

package/src/fileContents.ts

@@ -1,20 +1,19 @@
 /*!
- * Copyright 2019 Palantir Technologies, Inc.
+ * Copyright 2023 Palantir Technologies, Inc.
  *
  * Licensed under the MIT license. See LICENSE file in the project root for details.
  *
  */
 
-import { Context } from "@monorepolint/core";
-import { RuleModule } from "@monorepolint/core";
-import diff from "jest-diff";
+import { Context } from "@monorepolint/config";
+import { diff } from "jest-diff";
 import * as path from "path";
 import * as r from "runtypes";
-
+import { makeRule } from "./util/makeRule.js";
 const Options = r.Union(
   r.Record({
     file: r.String,
-    generator: r.Function,
+    generator: r.Function.withGuard((x): x is (context: Context) => string | Promise<string> => x != undefined),
     template: r.Undefined.optional(),
     templateFile: r.Undefined.optional(),
   }),
@@ -36,10 +35,11 @@ const Options = r.Union(
 
 type Options = r.Static<typeof Options>;
 
-export const fileContents = {
-  check: function expectFileContents(context: Context, opts: Options) {
+export const fileContents = makeRule<Options>({
+  name: "fileContents",
+  check: async (context, opts) => {
     const fullPath = path.join(context.packageDir, opts.file);
-    const expectedContent = getExpectedContents(context, opts);
+    const expectedContent = await getExpectedContents(context, opts);
 
     const pathExists = context.host.exists(fullPath);
     const actualContent = pathExists ? context.host.readFile(fullPath, { encoding: "utf-8" }) : undefined;
@@ -59,12 +59,15 @@ export const fileContents = {
       });
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});
 
-const optionsCache = new Map<Options, ((context: Context) => string | undefined) | string | undefined>();
+const optionsCache = new Map<
+  Options,
+  ((context: Context) => Promise<string> | string | undefined) | string | undefined
+>();
 
-function getExpectedContents(context: Context, opts: Options) {
+async function getExpectedContents(context: Context, opts: Options) {
   // we need to use has because undefined is a valid value in the cache
   if (optionsCache.has(opts)) {
     const cachedEntry = optionsCache.get(opts);
@@ -76,7 +79,7 @@ function getExpectedContents(context: Context, opts: Options) {
 
   if (opts.generator) {
     optionsCache.set(opts, opts.generator);
-    return opts.generator(context) as string | undefined; // we have no guarentee its the right kind of function
+    return opts.generator(context);
   } else if (opts.templateFile) {
     const { packageDir: workspacePackageDir } = context.getWorkspaceContext();
     const fullPath = path.resolve(workspacePackageDir, opts.templateFile);

package/src/index.ts

@@ -5,16 +5,16 @@
  *
  */
 
-export { alphabeticalDependencies } from "./alphabeticalDependencies";
-export { alphabeticalScripts } from "./alphabeticalScripts";
-export { bannedDependencies } from "./bannedDependencies";
-export { consistentDependencies } from "./consistentDependencies";
-export { consistentVersions } from "./consistentVersions";
-export { fileContents } from "./fileContents";
-export { mustSatisfyPeerDependencies } from "./mustSatisfyPeerDependencies";
-export { packageOrder } from "./packageOrder";
-export { packageEntry } from "./packageEntry";
-export { packageScript } from "./packageScript";
-export { standardTsconfig } from "./standardTsconfig";
-export { nestedWorkspaces } from "./nestedWorkspaces";
-export { requireDependency } from "./requireDependency";
+export { alphabeticalDependencies } from "./alphabeticalDependencies.js";
+export { alphabeticalScripts } from "./alphabeticalScripts.js";
+export { bannedDependencies } from "./bannedDependencies.js";
+export { consistentDependencies } from "./consistentDependencies.js";
+export { consistentVersions } from "./consistentVersions.js";
+export { fileContents } from "./fileContents.js";
+export { mustSatisfyPeerDependencies } from "./mustSatisfyPeerDependencies.js";
+export { packageOrder } from "./packageOrder.js";
+export { packageEntry } from "./packageEntry.js";
+export { packageScript } from "./packageScript.js";
+export { standardTsconfig } from "./standardTsconfig.js";
+export { nestedWorkspaces } from "./nestedWorkspaces.js";
+export { requireDependency } from "./requireDependency.js";

package/src/mustSatisfyPeerDependencies.ts

@@ -5,12 +5,13 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
+import { Context } from "@monorepolint/config";
 import { Host, mutateJson, PackageJson } from "@monorepolint/utils";
-import path from "path";
-import resolvePackagePath from "resolve-package-path";
+import * as path from "node:path";
 import * as r from "runtypes";
 import { coerce } from "semver";
+import resolvePackagePath from "resolve-package-path";
+import { makeRule } from "./util/makeRule.js";
 
 const Options = r.Union(
   r.Partial({
@@ -183,10 +184,11 @@ const Options = r.Union(
 
 export type Options = r.Static<typeof Options>;
 
-export const mustSatisfyPeerDependencies: RuleModule<typeof Options> = {
+export const mustSatisfyPeerDependencies = makeRule({
+  name: "mustSatisfyPeerDependencies",
   check: checkSatisfyPeerDependencies,
-  optionsRuntype: Options,
-};
+  validateOptions: Options.check,
+});
 
 /**
  * separating on `|`, this regex allows any of the following formats:
@@ -213,7 +215,8 @@ export const MATCH_ANY_VERSION_RANGE = /^(\*|x)$/;
  *
  * More info: https://docs.npmjs.com/about-semantic-versioning
  */
-export const MATCH_GREATER_OR_EQUAL_VERSION_RANGE = /^>= ?\d+(?:\.\d+|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?$/;
+export const MATCH_GREATER_OR_EQUAL_VERSION_RANGE =
+  /^>= ?\d+(?:\.\d+|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?$/;
 
 /**
  * This regex allows any of the following formats:
@@ -237,7 +240,8 @@ export const MATCH_GREATER_OR_EQUAL_VERSION_RANGE = /^>= ?\d+(?:\.\d+|\.\d+\.\d+
  *
  * More info: https://docs.npmjs.com/about-semantic-versioning
  */
-export const MATCH_MAJOR_VERSION_RANGE = /^(?:\^?\d+|\^?\d+\.x|\^?\d+\.x\.x|\^\d+\.\d+|\^\d+\.\d+\.x|\^\d+\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)$/;
+export const MATCH_MAJOR_VERSION_RANGE =
+  /^(?:\^?\d+|\^?\d+\.x|\^?\d+\.x\.x|\^\d+\.\d+|\^\d+\.\d+\.x|\^\d+\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)$/;
 
 /**
  * Does not currently accept `<`, `<=`, `>`, `=` or `-` for ranges (e.g. `> 2.5.1 < 3` or `1.0.0 - 1.2.0`),
@@ -252,7 +256,8 @@ export const MATCH_MAJOR_VERSION_RANGE = /^(?:\^?\d+|\^?\d+\.x|\^?\d+\.x\.x|\^\d
  *
  * TODO: accept minor pins `~4.2.1`
  */
-export const RANGE_REGEX = /^(\*|x|>= ?\d+(?:\.\d+|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?|\^?\d+(\.x|\.x\.x|\.\d+|\.\d+\.x|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?( \|\| \^?\d+(\.x|\.x\.x|\.\d+|\.\d+\.x|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?)*)$/;
+export const RANGE_REGEX =
+  /^(\*|x|>= ?\d+(?:\.\d+|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?|\^?\d+(\.x|\.x\.x|\.\d+|\.\d+\.x|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?( \|\| \^?\d+(\.x|\.x\.x|\.\d+|\.\d+\.x|\.\d+\.\d+(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)?)*)$/;
 
 interface IPeerDependencyRequirement {
   fromPackageName: string;
@@ -267,7 +272,7 @@ interface IResolvedPeerDependencyRequirement {
 function checkSatisfyPeerDependencies(context: Context, opts: Options) {
   const { dependencyBlacklist, dependencyWhitelist, enforceForDevDependencies, skipUnparseableRanges } = opts;
   const packageJsonPath = path.resolve(context.getPackageJsonPath());
-  const packageJson: PackageJson = require(packageJsonPath);
+  const packageJson = context.host.readJson(packageJsonPath) as PackageJson;
   const packageDependencies = packageJson.dependencies || {};
   const packageDevDependencies = packageJson.devDependencies || {};
   const packagePeerDependencies = packageJson.peerDependencies || {};
@@ -302,7 +307,7 @@ function checkSatisfyPeerDependencies(context: Context, opts: Options) {
     if (dependencyPackageJsonPath == null) {
       throw new Error(`Could not resolve ${dependency} from ${path.dirname(packageJsonPath)}`);
     }
-    const dependencyPackageJson: PackageJson = require(dependencyPackageJsonPath);
+    const dependencyPackageJson = context.host.readJson(dependencyPackageJsonPath) as PackageJson;
     const requiredPeerDependencies = dependencyPackageJson.peerDependencies;
     if (requiredPeerDependencies == null) {
       continue;

package/src/nestedWorkspaces.ts

@@ -5,22 +5,23 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
-import globby from "globby";
-import path from "path";
+import * as globby from "globby";
+import * as path from "node:path";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 export const Options = r.Undefined;
 
 type Options = r.Static<typeof Options>;
 
 // Enforce that the root package.json contains all of the workspaces in the repo (including nested packages)
-export const nestedWorkspaces: RuleModule<typeof Options> = {
-  check: (context: Context) => {
+export const nestedWorkspaces = makeRule({
+  name: "nestedWorkspaces",
+  check: (context) => {
     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.sync(["*/**/package.json", "!**/node_modules/**"]);
+    const packageJsonPaths = globby.globbySync(["*/**/package.json", "!**/node_modules/**"]);
 
     const workspaces = Array.isArray(rootPackageJson.workspaces)
       ? rootPackageJson.workspaces
@@ -40,7 +41,7 @@ export const nestedWorkspaces: RuleModule<typeof Options> = {
     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.sync([...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));
@@ -55,5 +56,5 @@ export const nestedWorkspaces: RuleModule<typeof Options> = {
       });
     }
   },
-  optionsRuntype: Options,
-};
+  validateOptions: Options.check,
+});

package/src/packageEntry.ts

@@ -5,10 +5,10 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 export const Options = r.Union(
   r
@@ -37,8 +37,9 @@ export const Options = r.Union(
 
 export type Options = r.Static<typeof Options>;
 
-export const packageEntry: RuleModule<typeof Options> = {
-  check: function expectPackageEntry(context: Context, options: Options) {
+export const packageEntry = makeRule<Options>({
+  name: "packageEntry",
+  check: (context, options) => {
     const packageJson = context.getPackageJson();
 
     if (options.entries) {
@@ -77,8 +78,8 @@ export const packageEntry: RuleModule<typeof Options> = {
       }
     }
   },
-  optionsRuntype: Options,
-};
+  validateOptions: Options.check,
+});
 
 export function createStandardizedEntryErrorMessage(key: string) {
   return `Expected standardized entry for '${key}'`;

package/src/packageOrder.ts

@@ -5,10 +5,10 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
-import diff from "jest-diff";
+import { Context } from "@monorepolint/config";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
-
+import { makeRule } from "./util/makeRule.js";
 type OrderFunction = (context: Context) => (a: string, b: string) => number;
 
 const Options = r
@@ -27,9 +27,12 @@ const defaultKeyOrder = [
   "contributors",
   "url",
   "license",
+  "type",
+  "exports",
   "private",
   "engines",
   "bin",
+  "types",
   "main",
   "module",
   "typings",
@@ -48,8 +51,9 @@ const defaultKeyOrder = [
   "publishConfig",
 ];
 
-export const packageOrder = {
-  check: function expectPackageOrder(context: Context, opts: Options) {
+export const packageOrder = makeRule<Options>({
+  name: "packageOrder",
+  check: (context, opts) => {
     const packageJson = context.getPackageJson();
     const packagePath = context.getPackageJsonPath();
 
@@ -66,6 +70,7 @@ export const packageOrder = {
         message: "Incorrect order of fields in package.json",
         longMessage: diff(expectedOrder, actualOrder, { expand: true }),
         fixer: () => {
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
           const expectedPackageJson: Record<string, any> = {};
 
           expectedOrder.forEach((key) => {
@@ -77,8 +82,8 @@ export const packageOrder = {
       });
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});
 
 function arrayOrderCompare(a: ReadonlyArray<string>, b: ReadonlyArray<string>) {
   for (let index = 0; index < a.length; index++) {

package/src/packageScript.ts

@@ -5,24 +5,19 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 export const Options = r.Record({
   scripts: r.Dictionary(
     r.Union(
       r.String,
-      r
-        .Record({
-          options: r.Array(r.String.Or(r.Undefined)),
-        })
-        .And(
-          r.Partial({
-            fixValue: r.Union(r.String, r.Undefined, r.Literal(false)),
-          })
-        )
+      r.Record({
+        options: r.Array(r.String.Or(r.Undefined)),
+        fixValue: r.Union(r.String, r.Undefined, r.Literal(false)).optional(),
+      })
     )
   ), // string => string
 });
@@ -31,8 +26,9 @@ export type Options = r.Static<typeof Options>;
 
 export const MSG_NO_SCRIPTS_BLOCK = "No scripts block in package.json";
 
-export const packageScript = {
-  check: function expectPackageScript(context: Context, options: Options) {
+export const packageScript = makeRule<Options>({
+  name: "packageScript",
+  check: (context, options) => {
     const packageJson = context.getPackageJson();
     if (packageJson.scripts === undefined) {
       context.addError({
@@ -63,7 +59,7 @@ export const packageScript = {
           }
           allowedValues.add(q);
         }
-        fixToEmpty = value.hasOwnProperty("fixValue") && value.fixValue === undefined;
+        fixToEmpty = Object.prototype.hasOwnProperty.call(value, "fixValue") && value.fixValue === undefined;
         fixValue = value.fixValue;
       }
 
@@ -99,5 +95,5 @@ export const packageScript = {
       }
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});

package/src/public/util.ts

@@ -0,0 +1 @@
+export { makeRule } from "../util/makeRule.js";

package/src/requireDependency.ts

@@ -5,10 +5,11 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
+import { Context } from "@monorepolint/config";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { diff } from "jest-diff";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 const Options = r.Partial({
   dependencies: r.Dictionary(r.String),
@@ -19,7 +20,8 @@ const Options = r.Partial({
 
 type Options = r.Static<typeof Options>;
 
-export const requireDependency = {
+export const requireDependency = makeRule({
+  name: "requireDependency",
   check: function expectPackageEntry(context: Context, options: Options) {
     const packageJson = context.getPackageJson();
     const packageJsonPath = context.getPackageJsonPath();
@@ -49,11 +51,11 @@ export const requireDependency = {
       }
 
       for (const [dep, version] of Object.entries(options[type]!)) {
-        if (packageJson[type][dep] !== version) {
+        if (packageJson[type]?.[dep] !== version) {
           context.addError({
             file: packageJsonPath,
             message: `Expected dependency ${dep}@${version}`,
-            longMessage: diff(`${dep}@${version}\n`, `${dep}@${packageJson[type][dep] || "missing"}\n`)!,
+            longMessage: diff(`${dep}@${version}\n`, `${dep}@${packageJson[type]![dep] || "missing"}\n`)!,
             fixer: () => {
               mutateJson<PackageJson>(packageJsonPath, context.host, (input) => {
                 input[type] = { ...input[type], [dep]: version };
@@ -65,5 +67,5 @@ export const requireDependency = {
       }
     });
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});

package/src/standardTsconfig.ts

@@ -5,11 +5,12 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/core";
+import { Context } from "@monorepolint/config";
 import { matchesAnyGlob } from "@monorepolint/utils";
-import diff from "jest-diff";
+import { diff } from "jest-diff";
 import * as path from "path";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 const DEFAULT_TSCONFIG_FILENAME = "tsconfig.json";
 
@@ -38,10 +39,11 @@ const Options = r
     return count === 1 || "Expect one of { generator, template, templateFile }";
   });
 
-export type Options = r.Static<typeof Options>;
+export interface Options extends r.Static<typeof Options> {}
 
-export const standardTsconfig = {
-  check: async function expectStandardTsconfig(context: Context, opts: Options) {
+export const standardTsconfig = makeRule<Options>({
+  name: "standardTsconfig",
+  check: async (context, opts) => {
     const tsconfigFileName = opts.file ?? DEFAULT_TSCONFIG_FILENAME;
     const fullPath = path.resolve(context.packageDir, tsconfigFileName);
     const generator = getGenerator(context, opts);
@@ -72,8 +74,8 @@ export const standardTsconfig = {
       });
     }
   },
-  optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+  validateOptions: Options.check,
+});
 
 function getGenerator(context: Context, opts: Options) {
   if (opts.generator) {
@@ -92,6 +94,7 @@ function getGenerator(context: Context, opts: Options) {
 }
 
 function makeGenerator(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   template: any,
   excludedReferences: ReadonlyArray<string> | undefined,
   additionalReferences: ReadonlyArray<string> | undefined,
@@ -107,10 +110,9 @@ function makeGenerator(
 
     const packageJson = context.getPackageJson();
     const deps = [...Object.keys(packageJson.dependencies || {}), ...Object.keys(packageJson.devDependencies || {})];
-
     for (const dep of deps) {
       const packageDir = nameToDirectory.get(dep);
-      if (packageDir !== undefined && (excludedReferences === undefined || matchesAnyGlob(dep, excludedReferences))) {
+      if (packageDir !== undefined && (excludedReferences === undefined || !matchesAnyGlob(dep, excludedReferences))) {
         const absoluteReferencePath =
           tsconfigReferenceFile !== undefined ? path.join(packageDir, tsconfigReferenceFile) : packageDir;
         template.references.push({

package/src/util/checkAlpha.ts

@@ -5,8 +5,8 @@
  *
  */
 
-import { Context } from "@monorepolint/core";
-import diff from "jest-diff";
+import { Context } from "@monorepolint/config";
+import { diff } from "jest-diff";
 
 export function checkAlpha(
   context: Context,

package/src/util/makeRule.ts

@@ -0,0 +1,29 @@
+import { Context, RuleEntry, RuleModule } from "@monorepolint/config";
+
+let globalId = 0;
+export function makeRule<X>({
+  name,
+  check,
+  validateOptions,
+  printStats,
+}: {
+  name: string;
+  check: (context: Context, options: X, extra: { id: string }) => Promise<unknown> | unknown;
+  printStats?: () => void;
+  validateOptions: (options: unknown) => asserts options is X;
+}): RuleFunction<X> {
+  return function (ruleEntry) {
+    const id = `${name} :: ${globalId++}`;
+    return {
+      id,
+      // eslint-disable-next-line @typescript-eslint/no-extra-non-null-assertion
+      check: (context) => check(context, ruleEntry.options!!, { id }),
+      name,
+      validateOptions,
+      ruleEntry,
+      printStats,
+    };
+  };
+}
+
+type RuleFunction<T> = (ruleEntry: RuleEntry<T>) => RuleModule<T>;

package/src/util/packageDependencyGraphService.ts

@@ -3,7 +3,7 @@
  */
 
 import { Host, PackageJson } from "@monorepolint/utils";
-import path from "path";
+import * as path from "node:path";
 import resolvePackagePath from "resolve-package-path";
 
 /** Interface for a node in a package dependency graph. */
@@ -45,7 +45,7 @@ export class PackageDependencyGraphService implements IPackageDependencyGraphSer
         return nodes.get(packageJsonPath)!;
       }
 
-      const packageJson: PackageJson = host.readJson(packageJsonPath);
+      const packageJson = host.readJson(packageJsonPath) as PackageJson;
       const node: IPackageDependencyGraphNode = {
         packageJson,
         dependencies: new Map<string, IPackageDependencyGraphNode>(),

package/tsconfig.json

@@ -1,10 +1,18 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "./lib",
-    "rootDir": "./src"
+    "outDir": "./build/js",
+    "rootDir": "./src",
+    "declarationDir": "./build/types",
+    "tsBuildInfoFile": "./build/tsconfig.tsbuildinfo"
   },
+  "include": [
+    "src"
+  ],
   "references": [
+    {
+      "path": "../config"
+    },
     {
       "path": "../core"
     },

package/lib/__tests__/alphabeticalScripts.spec.d.ts

@@ -1,8 +0,0 @@
-/*!
- * Copyright 2019 Palantir Technologies, Inc.
- *
- * Licensed under the MIT license. See LICENSE file in the project root for details.
- *
- */
-export {};
-//# sourceMappingURL=alphabeticalScripts.spec.d.ts.map

package/lib/__tests__/alphabeticalScripts.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"alphabeticalScripts.spec.d.ts","sourceRoot":"","sources":["../../src/__tests__/alphabeticalScripts.spec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/lib/__tests__/alphabeticalScripts.spec.js

@@ -1,61 +0,0 @@
-"use strict";
-/*!
- * Copyright 2019 Palantir Technologies, Inc.
- *
- * Licensed under the MIT license. See LICENSE file in the project root for details.
- *
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-// tslint:disable:no-console
-const utils_1 = require("./utils");
-const alphabeticalScripts_1 = require("../alphabeticalScripts");
-const checkAlpha_1 = require("../util/checkAlpha");
-const PACKAGE_SCRIPTS_SORTED = (0, utils_1.jsonToString)({
-    name: "foo-lib",
-    scripts: {
-        a: "a-",
-        b: "b-",
-        c: "c-",
-    },
-});
-const PACKAGE_SCRIPTS_UNSORTED = (0, utils_1.jsonToString)({
-    name: "foo-lib",
-    scripts: {
-        c: "c-",
-        a: "a-",
-        b: "b-",
-    },
-});
-describe.each(utils_1.HOST_FACTORIES)("alphabeticalScripts ($name)", (hostFactory) => {
-    describe("fix: true", () => {
-        let workspace;
-        let spy;
-        let context;
-        beforeEach(async () => {
-            workspace = await (0, utils_1.createTestingWorkspace)({
-                fixFlag: true,
-                host: hostFactory.make(),
-            });
-            context = workspace.context; // minimizing delta
-            spy = jest.spyOn(workspace.context, "addError");
-        });
-        it("fixes unsorted scripts", () => {
-            workspace.writeFile("package.json", PACKAGE_SCRIPTS_UNSORTED);
-            alphabeticalScripts_1.alphabeticalScripts.check(context, undefined);
-            expect(spy).toHaveBeenCalledTimes(1);
-            const failure = spy.mock.calls[0][0];
-            expect(failure).toMatchObject(workspace.failureMatcher({
-                file: "package.json",
-                hasFixer: true,
-                message: (0, checkAlpha_1.createIncorrectOrderErrorMessage)("scripts", "foo-lib"),
-            }));
-            expect(workspace.readFile("package.json")).toEqual(PACKAGE_SCRIPTS_SORTED);
-        });
-        it("does nothing if already sorted", () => {
-            workspace.writeFile("package.json", PACKAGE_SCRIPTS_SORTED);
-            alphabeticalScripts_1.alphabeticalScripts.check(context, undefined);
-            expect(spy).toHaveBeenCalledTimes(0);
-        });
-    });
-});
-//# sourceMappingURL=alphabeticalScripts.spec.js.map

package/lib/__tests__/alphabeticalScripts.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"alphabeticalScripts.spec.js","sourceRoot":"","sources":["../../src/__tests__/alphabeticalScripts.spec.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,4BAA4B;AAC5B,mCAA8G;AAE9G,gEAA6D;AAC7D,mDAAsE;AAEtE,MAAM,sBAAsB,GAAG,IAAA,oBAAY,EAAC;IAC1C,IAAI,EAAE,SAAS;IACf,OAAO,EAAE;QACP,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,IAAI;KACR;CACF,CAAC,CAAC;AAEH,MAAM,wBAAwB,GAAG,IAAA,oBAAY,EAAC;IAC5C,IAAI,EAAE,SAAS;IACf,OAAO,EAAE;QACP,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,IAAI;KACR;CACF,CAAC,CAAC;AAEH,QAAQ,CAAC,IAAI,CAAC,sBAAc,CAAC,CAAC,6BAA6B,EAAE,CAAC,WAAW,EAAE,EAAE;IAC3E,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,IAAI,SAA2B,CAAC;QAChC,IAAI,GAAgB,CAAC;QACrB,IAAI,OAAgB,CAAC;QAErB,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,SAAS,GAAG,MAAM,IAAA,8BAAsB,EAAC;gBACvC,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,WAAW,CAAC,IAAI,EAAE;aACzB,CAAC,CAAC;YACH,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,mBAAmB;YAEhD,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,SAAS,CAAC,SAAS,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAC;YAE9D,yCAAmB,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAE9C,MAAM,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAErC,MAAM,OAAO,GAAY,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAC3B,SAAS,CAAC,cAAc,CAAC;gBACvB,IAAI,EAAE,cAAc;gBACpB,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,IAAA,6CAAgC,EAAC,SAAS,EAAE,SAAS,CAAC;aAChE,CAAC,CACH,CAAC;YAEF,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC7E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,SAAS,CAAC,SAAS,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;YAE5D,yCAAmB,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAE9C,MAAM,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/__tests__/bannedDependencies.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=bannedDependencies.spec.d.ts.map

package/lib/__tests__/bannedDependencies.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bannedDependencies.spec.d.ts","sourceRoot":"","sources":["../../src/__tests__/bannedDependencies.spec.ts"],"names":[],"mappings":""}