@monorepolint/rules 0.5.0-alpha.103 → 0.5.0-alpha.106

package/src/fileContents.ts

@@ -1,15 +1,15 @@
 /*!
- * 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, RuleModule } from "@monorepolint/config";
+import { Context } from "@monorepolint/config";
 import { diff } from "jest-diff";
 import * as path from "path";
 import * as r from "runtypes";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
+import { makeRule } from "./util/makeRule.js";
 const Options = r.Union(
   r.Record({
     file: r.String,
@@ -35,8 +35,9 @@ const Options = r.Union(
 
 type Options = r.Static<typeof Options>;
 
-export const fileContents = {
-  check: function expectFileContents(context: Context, opts: Options) {
+export const fileContents = makeRule({
+  name: "fileContents",
+  check: (context, opts) => {
     const fullPath = path.join(context.packageDir, opts.file);
     const expectedContent = getExpectedContents(context, opts);
 
@@ -59,7 +60,7 @@ export const fileContents = {
     }
   },
   optionsRuntype: Options,
-} as RuleModule<typeof Options>;
+});
 
 const optionsCache = new Map<Options, ((context: Context) => string | undefined) | string | undefined>();
 
@@ -88,5 +89,3 @@ function getExpectedContents(context: Context, opts: Options) {
     return opts.template;
   }
 }
-
-export const FileContents = createNewRuleConversion("FileContents", fileContents);

package/src/index.ts

@@ -5,16 +5,16 @@
  *
  */
 
-export { alphabeticalDependencies, AlphabeticalDependencies } from "./alphabeticalDependencies.js";
-export { alphabeticalScripts, AlphabeticalScripts } from "./alphabeticalScripts.js";
-export { bannedDependencies, BannedDependencies } from "./bannedDependencies.js";
-export { consistentDependencies, ConsistentDependencies } from "./consistentDependencies.js";
-export { consistentVersions, ConsistentVersions } from "./consistentVersions.js";
-export { fileContents, FileContents } from "./fileContents.js";
-export { mustSatisfyPeerDependencies, MustSatisfyPeerDependencies } from "./mustSatisfyPeerDependencies.js";
-export { packageOrder, PackageOrder } from "./packageOrder.js";
-export { packageEntry, PackageEntry } from "./packageEntry.js";
-export { packageScript, PackageScript } from "./packageScript.js";
-export { standardTsconfig, StandardTsConfig } from "./standardTsconfig.js";
-export { nestedWorkspaces, NestedWorkspaces } from "./nestedWorkspaces.js";
-export { requireDependency, RequireDependency } from "./requireDependency.js";
+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,13 +5,13 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
+import { Context } from "@monorepolint/config";
 import { Host, mutateJson, PackageJson } from "@monorepolint/utils";
 import * as path from "node:path";
 import * as r from "runtypes";
 import { coerce } from "semver";
 import resolvePackagePath from "resolve-package-path";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
+import { makeRule } from "./util/makeRule.js";
 
 const Options = r.Union(
   r.Partial({
@@ -184,15 +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,
-};
-
-export const MustSatisfyPeerDependencies = createNewRuleConversion(
-  "MustSatisfyPeerDependencies",
-  mustSatisfyPeerDependencies
-);
+});
 
 /**
  * separating on `|`, this regex allows any of the following formats:

package/src/nestedWorkspaces.ts

@@ -5,18 +5,19 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
 import * as globby from "globby";
 import * as path from "node:path";
 import * as r from "runtypes";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
+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)
@@ -56,6 +57,4 @@ export const nestedWorkspaces: RuleModule<typeof Options> = {
     }
   },
   optionsRuntype: Options,
-};
-
-export const NestedWorkspaces = createNewRuleConversion("NestedWorkspaces", nestedWorkspaces);
+});

package/src/packageEntry.ts

@@ -5,11 +5,11 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
 import { diff } from "jest-diff";
 import * as r from "runtypes";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
+import { makeRule } from "./util/makeRule.js";
+
 export const Options = r.Union(
   r
     .Record({
@@ -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({
+  name: "packageEntry",
+  check: (context, options) => {
     const packageJson = context.getPackageJson();
 
     if (options.entries) {
@@ -78,9 +79,7 @@ export const packageEntry: RuleModule<typeof Options> = {
     }
   },
   optionsRuntype: Options,
-};
-
-export const PackageEntry = createNewRuleConversion("PackageEntry", packageEntry);
+});
 
 export function createStandardizedEntryErrorMessage(key: string) {
   return `Expected standardized entry for '${key}'`;

package/src/packageOrder.ts

@@ -5,10 +5,10 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
+import { Context } from "@monorepolint/config";
 import { diff } from "jest-diff";
 import * as r from "runtypes";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
+import { makeRule } from "./util/makeRule.js";
 type OrderFunction = (context: Context) => (a: string, b: string) => number;
 
 const Options = r
@@ -51,8 +51,9 @@ const defaultKeyOrder = [
   "publishConfig",
 ];
 
-export const packageOrder = {
-  check: function expectPackageOrder(context: Context, opts: Options) {
+export const packageOrder = makeRule({
+  name: "packageOrder",
+  check: (context, opts) => {
     const packageJson = context.getPackageJson();
     const packagePath = context.getPackageJsonPath();
 
@@ -81,9 +82,7 @@ export const packageOrder = {
     }
   },
   optionsRuntype: Options,
-} as RuleModule<typeof Options>;
-
-export const PackageOrder = createNewRuleConversion("PackageOrder", packageOrder);
+});
 
 function arrayOrderCompare(a: ReadonlyArray<string>, b: ReadonlyArray<string>) {
   for (let index = 0; index < a.length; index++) {

package/src/packageScript.ts

@@ -5,11 +5,10 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
 import { diff } from "jest-diff";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 export const Options = r.Record({
   scripts: r.Dictionary(
@@ -27,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({
+  name: "packageScript",
+  check: (context, options) => {
     const packageJson = context.getPackageJson();
     if (packageJson.scripts === undefined) {
       context.addError({
@@ -96,6 +96,4 @@ export const packageScript = {
     }
   },
   optionsRuntype: Options,
-} as RuleModule<typeof Options>;
-
-export const PackageScript = createNewRuleConversion("PackageScript", packageScript);
+});

package/src/public/util.ts

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

package/src/requireDependency.ts

@@ -5,11 +5,12 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
+import { Context } from "@monorepolint/config";
 import { mutateJson, PackageJson } from "@monorepolint/utils";
 import { diff } from "jest-diff";
 import * as r from "runtypes";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
+import { makeRule } from "./util/makeRule.js";
+
 const Options = r.Partial({
   dependencies: r.Dictionary(r.String),
   devDependencies: 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();
@@ -66,6 +68,4 @@ export const requireDependency = {
     });
   },
   optionsRuntype: Options,
-} as RuleModule<typeof Options>;
-
-export const RequireDependency = createNewRuleConversion("RequireDependency", requireDependency);
+});

package/src/standardTsconfig.ts

@@ -5,12 +5,12 @@
  *
  */
 
-import { Context, RuleModule } from "@monorepolint/config";
+import { Context } from "@monorepolint/config";
 import { matchesAnyGlob } from "@monorepolint/utils";
 import { diff } from "jest-diff";
-import { createNewRuleConversion } from "./util/createNewRuleConversion.js";
 import * as path from "path";
 import * as r from "runtypes";
+import { makeRule } from "./util/makeRule.js";
 
 const DEFAULT_TSCONFIG_FILENAME = "tsconfig.json";
 
@@ -41,8 +41,9 @@ const Options = r
 
 export interface Options extends r.Static<typeof Options> {}
 
-export const standardTsconfig = {
-  check: async function expectStandardTsconfig(context: Context, opts: Options) {
+export const standardTsconfig = makeRule({
+  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);
@@ -74,9 +75,7 @@ export const standardTsconfig = {
     }
   },
   optionsRuntype: Options,
-} as RuleModule<typeof Options>;
-
-export const StandardTsConfig = createNewRuleConversion("StandardTsconfig", standardTsconfig);
+});
 
 function getGenerator(context: Context, opts: Options) {
   if (opts.generator) {
@@ -110,10 +109,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/makeRule.ts

@@ -0,0 +1,29 @@
+import { Context, RuleEntry, RuleModule } from "@monorepolint/config";
+import * as r from "runtypes";
+
+let globalId = 0;
+export function makeRule<T extends r.Runtype<unknown>>({
+  name,
+  check,
+  optionsRuntype,
+  printStats,
+}: {
+  name: string;
+  check: (context: Context, options: r.Static<T>, extra: { id: string }) => Promise<unknown> | unknown;
+  optionsRuntype: T;
+  printStats?: () => void;
+}): RuleFunction<T> {
+  return function (ruleEntry) {
+    const id = `${name} :: ${globalId++}`;
+    return {
+      id,
+      check: (context) => check(context, ruleEntry.options, { id }),
+      name,
+      optionsRuntype,
+      ruleEntry,
+      printStats,
+    };
+  };
+}
+
+type RuleFunction<T extends r.Runtype<any>> = (ruleEntry: RuleEntry<r.Static<T>>) => RuleModule<T>;