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

package/build/js/index.js

@@ -324,9 +324,7 @@ function filterKeys(ob, filterOb) {
 }
 function omit(obj, keysToOmit) {
   const newObj = {};
-  const filtered = Object.entries(obj).filter(
-    ([key]) => !keysToOmit.includes(key)
-  );
+  const filtered = Object.entries(obj).filter(([key]) => !keysToOmit.includes(key));
   for (const [key, value] of filtered) {
     newObj[key] = value;
   }
@@ -523,6 +521,31 @@ async function getExpectedContents(context, opts) {
   }
 }
 
+// src/forceError.ts
+var forceError = createRuleFactory({
+  name: "forceError",
+  check: async (context, opts) => {
+    context.addError({
+      message: (opts == null ? void 0 : opts.customMessage) ?? "Forced error (often used to debug package selection)",
+      file: context.getPackageJsonPath()
+    });
+  },
+  validateOptions: (opts) => {
+    if (opts == null) return;
+    if (typeof opts !== "object") {
+      throw new Error("options must be an object if provided");
+    }
+    const numKeys = Object.keys(opts).length;
+    if (numKeys === 0) return;
+    if (Object.keys(opts).length > 1 || !("customMessage" in opts)) {
+      throw new Error("options must only have `customMessage` property");
+    }
+    if (typeof opts.customMessage !== "string") {
+      throw new Error("customMessage must be a string");
+    }
+  }
+});
+
 // src/mustSatisfyPeerDependencies.ts
 import { mutateJson as mutateJson2 } from "@monorepolint/utils";
 import * as path4 from "node:path";
@@ -872,12 +895,8 @@ function getMostStrictStatement(mostStrictPeerRequirement) {
     const dependencyName = mostStrictPeerRequirement.fromPeerDependencyRequirements[0].fromPackageName;
     return `Dependency ${dependencyName} requires '${mostStrictPeerRequirement.range}'.`;
   } else {
-    const dependencyNames = mostStrictPeerRequirement.fromPeerDependencyRequirements.map(
-      (peerDependencyRequirement) => peerDependencyRequirement.fromPackageName
-    ).join(", ");
-    const dependencyRequirements = mostStrictPeerRequirement.fromPeerDependencyRequirements.map(
-      (peerDependencyRequirement) => `'${peerDependencyRequirement.range}'`
-    ).join(", ");
+    const dependencyNames = mostStrictPeerRequirement.fromPeerDependencyRequirements.map((peerDependencyRequirement) => peerDependencyRequirement.fromPackageName).join(", ");
+    const dependencyRequirements = mostStrictPeerRequirement.fromPeerDependencyRequirements.map((peerDependencyRequirement) => `'${peerDependencyRequirement.range}'`).join(", ");
     return `Dependencies [${dependencyNames}] require [${dependencyRequirements}] respectively, resolving to '${mostStrictPeerRequirement.range}'.`;
   }
 }
@@ -927,9 +946,7 @@ function findIntersection(a, b) {
   }
   const compatibleVersions = aVersions.map((aVersion) => {
     const aSemVer = coerce2(aVersion);
-    const majorMatchingBVersion = bVersions.find(
-      (m) => coerce2(m).major === aSemVer.major
-    );
+    const majorMatchingBVersion = bVersions.find((m) => coerce2(m).major === aSemVer.major);
     if (majorMatchingBVersion === void 0) {
       return void 0;
     }
@@ -982,9 +999,7 @@ function doesASatisfyB(a, b) {
   }
   return aVersions.every((aVersion) => {
     const aSemVer = coerce2(aVersion);
-    const majorMatchingBVersion = bVersions.find(
-      (m) => coerce2(m).major === aSemVer.major
-    );
+    const majorMatchingBVersion = bVersions.find((m) => coerce2(m).major === aSemVer.major);
     if (majorMatchingBVersion === void 0) {
       return false;
     }
@@ -1055,9 +1070,7 @@ var nestedWorkspaces = createRuleFactory({
       });
       return;
     }
-    const workspacePackageJsons = (workspaces || []).map(
-      (item) => `${item}/package.json`
-    );
+    const workspacePackageJsons = (workspaces || []).map((item) => `${item}/package.json`);
     const expandedWorkspacesGlobs = globby.globbySync([
       ...workspacePackageJsons,
       "!**/node_modules/**"
@@ -1066,9 +1079,7 @@ var nestedWorkspaces = createRuleFactory({
       (packageJsonPath) => !expandedWorkspacesGlobs.includes(packageJsonPath)
     );
     if (difference.length !== 0) {
-      const differencesList = difference.map(
-        (packageJsonPath) => path5.dirname(packageJsonPath)
-      ).join(", ");
+      const differencesList = difference.map((packageJsonPath) => path5.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/*".`
@@ -1078,31 +1089,55 @@ var nestedWorkspaces = createRuleFactory({
   validateOptions: Options6.check
 });
 
+// src/oncePerPackage.ts
+import * as r7 from "runtypes";
+var Options7 = r7.Record({
+  singletonKey: r7.String.Or(r7.Symbol),
+  customMessage: r7.String.optional()
+});
+var visitedMap = /* @__PURE__ */ new Map();
+var oncePerPackage = createRuleFactory({
+  name: "oncePerPackage",
+  check: async (context, options) => {
+    const visited = visitedMap.get(options.singletonKey) ?? /* @__PURE__ */ new Set();
+    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: Options7.assert
+});
+
 // src/packageEntry.ts
 import { mutateJson as mutateJson3 } from "@monorepolint/utils";
 import { diff as diff4 } from "jest-diff";
-import * as r7 from "runtypes";
-var Options7 = r7.Union(
-  r7.Record({
-    entries: r7.Dictionary(r7.Unknown)
+import * as r8 from "runtypes";
+var Options8 = r8.Union(
+  r8.Record({
+    entries: r8.Dictionary(r8.Unknown)
     // string => unknown, enforces existence of keys and their values
   }).And(
-    r7.Partial({
-      entriesExist: r7.Undefined
+    r8.Partial({
+      entriesExist: r8.Undefined
     })
   ),
-  r7.Record({
-    entriesExist: r7.Array(r7.String)
+  r8.Record({
+    entriesExist: r8.Array(r8.String)
     // enforces existence of keys, but not values
   }).And(
-    r7.Partial({
-      entries: r7.Undefined
+    r8.Partial({
+      entries: r8.Undefined
     })
   ),
-  r7.Record({
-    entries: r7.Dictionary(r7.Unknown),
+  r8.Record({
+    entries: r8.Dictionary(r8.Unknown),
     // string => unknown, enforces existence of keys and their values
-    entriesExist: r7.Array(r7.String)
+    entriesExist: r8.Array(r8.String)
   })
 );
 var packageEntry = createRuleFactory({
@@ -1146,7 +1181,7 @@ var packageEntry = createRuleFactory({
       }
     }
   },
-  validateOptions: Options7.check
+  validateOptions: Options8.check
 });
 function createStandardizedEntryErrorMessage(key) {
   return `Expected standardized entry for '${key}'`;
@@ -1157,10 +1192,10 @@ function createExpectedEntryErrorMessage(key) {
 
 // src/packageOrder.ts
 import { diff as diff5 } from "jest-diff";
-import * as r8 from "runtypes";
-var Options8 = r8.Record({
-  order: r8.Union(r8.Array(r8.String), r8.Function)
-}).Or(r8.Undefined);
+import * as r9 from "runtypes";
+var Options9 = r9.Record({
+  order: r9.Union(r9.Array(r9.String), r9.Function)
+}).Or(r9.Undefined);
 var defaultKeyOrder = [
   "name",
   "version",
@@ -1216,7 +1251,7 @@ var packageOrder = createRuleFactory({
       });
     }
   },
-  validateOptions: Options8.check
+  validateOptions: Options9.check
 });
 function arrayOrderCompare2(a, b) {
   for (let index = 0; index < a.length; index++) {
@@ -1250,14 +1285,14 @@ function isOrderFunction(order) {
 // src/packageScript.ts
 import { mutateJson as mutateJson4 } from "@monorepolint/utils";
 import { diff as diff6 } from "jest-diff";
-import * as r9 from "runtypes";
-var Options9 = r9.Record({
-  scripts: r9.Dictionary(
-    r9.Union(
-      r9.String,
-      r9.Record({
-        options: r9.Array(r9.String.Or(r9.Undefined)),
-        fixValue: r9.Union(r9.String, r9.Undefined, r9.Literal(false)).optional()
+import * as r10 from "runtypes";
+var Options10 = r10.Record({
+  scripts: r10.Dictionary(
+    r10.Union(
+      r10.String,
+      r10.Record({
+        options: r10.Array(r10.String.Or(r10.Undefined)),
+        fixValue: r10.Union(r10.String, r10.Undefined, r10.Literal(false)).optional()
       })
     )
   )
@@ -1336,18 +1371,18 @@ var packageScript = createRuleFactory({
       }
     }
   },
-  validateOptions: Options9.check
+  validateOptions: Options10.check
 });
 
 // src/requireDependency.ts
 import { mutateJson as mutateJson5 } from "@monorepolint/utils";
 import { diff as diff7 } from "jest-diff";
-import * as r10 from "runtypes";
-var Options10 = r10.Partial({
-  dependencies: r10.Dictionary(r10.String.optional()),
-  devDependencies: r10.Dictionary(r10.String.optional()),
-  peerDependencies: r10.Dictionary(r10.String.optional()),
-  optionalDependencies: r10.Dictionary(r10.String.optional())
+import * as r11 from "runtypes";
+var Options11 = r11.Partial({
+  dependencies: r11.Dictionary(r11.String.optional()),
+  devDependencies: r11.Dictionary(r11.String.optional()),
+  peerDependencies: r11.Dictionary(r11.String.optional()),
+  optionalDependencies: r11.Dictionary(r11.String.optional())
 });
 var requireDependency = createRuleFactory({
   name: "requireDependency",
@@ -1372,9 +1407,7 @@ var requireDependency = createRuleFactory({
           fixer: () => {
             mutateJson5(packageJsonPath, context.host, (input) => {
               input[type] = Object.fromEntries(
-                Object.entries(expectedEntries).filter(
-                  ([, v]) => v !== void 0
-                )
+                Object.entries(expectedEntries).filter(([, v]) => v !== void 0)
               );
               return input;
             });
@@ -1413,23 +1446,23 @@ var requireDependency = createRuleFactory({
       }
     });
   },
-  validateOptions: Options10.check
+  validateOptions: Options11.check
 });
 
 // src/standardTsconfig.ts
 import { matchesAnyGlob as matchesAnyGlob2 } from "@monorepolint/utils";
 import { diff as diff8 } from "jest-diff";
 import * as path6 from "path";
-import * as r11 from "runtypes";
+import * as r12 from "runtypes";
 var DEFAULT_TSCONFIG_FILENAME = "tsconfig.json";
-var Options11 = r11.Partial({
-  file: r11.String,
-  generator: r11.Function,
-  tsconfigReferenceFile: r11.String,
-  template: r11.Record({}).Or(r11.String),
-  templateFile: r11.String,
-  excludedReferences: r11.Array(r11.String).Or(r11.Undefined),
-  additionalReferences: r11.Array(r11.String).Or(r11.Undefined)
+var Options12 = r12.Partial({
+  file: r12.String,
+  generator: r12.Function,
+  tsconfigReferenceFile: r12.String,
+  template: r12.Record({}).Or(r12.String),
+  templateFile: r12.String,
+  excludedReferences: r12.Array(r12.String).Or(r12.Undefined),
+  additionalReferences: r12.Array(r12.String).Or(r12.Undefined)
 }).withConstraint(({ generator, template, templateFile }) => {
   let count = 0;
   if (generator) {
@@ -1471,7 +1504,7 @@ var standardTsconfig = createRuleFactory({
       });
     }
   },
-  validateOptions: Options11.check
+  validateOptions: Options12.check
 });
 function getGenerator(context, opts) {
   if (opts.generator) {
@@ -1538,8 +1571,10 @@ export {
   consistentVersions,
   createRuleFactory,
   fileContents,
+  forceError,
   mustSatisfyPeerDependencies,
   nestedWorkspaces,
+  oncePerPackage,
   packageEntry,
   packageOrder,
   packageScript,