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

package/src/__tests__/packageEntry.spec.ts

@@ -8,50 +8,56 @@
 // tslint:disable:no-console
 
 import { Context, Failure } from "@monorepolint/config";
-import { createExpectedEntryErrorMessage, createStandardizedEntryErrorMessage, packageEntry } from "../packageEntry.js";
-import { AddErrorSpy, createTestingWorkspace, HOST_FACTORIES, TestingWorkspace } from "./utils.js";
-import { describe, expect, it, beforeEach, afterEach, vi } from "vitest";
-
-const PACKAGE_MISSING_ENTRY =
-  JSON.stringify(
-    {
-      name: "package",
-      version: {},
-      scripts: {},
-      dependencies: {},
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import {
+  createExpectedEntryErrorMessage,
+  createStandardizedEntryErrorMessage,
+  packageEntry,
+} from "../packageEntry.js";
+import {
+  AddErrorSpy,
+  createTestingWorkspace,
+  HOST_FACTORIES,
+  TestingWorkspace,
+} from "./utils.js";
+
+const PACKAGE_MISSING_ENTRY = JSON.stringify(
+  {
+    name: "package",
+    version: {},
+    scripts: {},
+    dependencies: {},
+  },
+  undefined,
+  2,
+) + "\n";
+
+const PACKAGE_LICENSE = JSON.stringify(
+  {
+    name: "package",
+    version: {},
+    scripts: {},
+    dependencies: {},
+    license: "UNLICENSED",
+  },
+  undefined,
+  2,
+) + "\n";
+
+const PACKAGE_REPOSITORY = JSON.stringify(
+  {
+    name: "package",
+    version: {},
+    scripts: {},
+    dependencies: {},
+    repository: {
+      type: "git",
+      url: "https://github.com:foo/foo",
     },
-    undefined,
-    2
-  ) + "\n";
-
-const PACKAGE_LICENSE =
-  JSON.stringify(
-    {
-      name: "package",
-      version: {},
-      scripts: {},
-      dependencies: {},
-      license: "UNLICENSED",
-    },
-    undefined,
-    2
-  ) + "\n";
-
-const PACKAGE_REPOSITORY =
-  JSON.stringify(
-    {
-      name: "package",
-      version: {},
-      scripts: {},
-      dependencies: {},
-      repository: {
-        type: "git",
-        url: "https://github.com:foo/foo",
-      },
-    },
-    undefined,
-    2
-  ) + "\n";
+  },
+  undefined,
+  2,
+) + "\n";
 
 describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
   describe("fix: true", () => {
@@ -93,7 +99,7 @@ describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: createStandardizedEntryErrorMessage("license"),
-        })
+        }),
       );
 
       expect(workspace.readFile("package.json")).toEqual(PACKAGE_LICENSE);
@@ -122,7 +128,7 @@ describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: createStandardizedEntryErrorMessage("repository"),
-        })
+        }),
       );
 
       expect(workspace.readFile("package.json")).toEqual(PACKAGE_REPOSITORY);
@@ -165,7 +171,7 @@ describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: false,
           message: createExpectedEntryErrorMessage("bugs"),
-        })
+        }),
       );
       expect(workspace.readFile("package.json")).toEqual(PACKAGE_REPOSITORY);
     });
@@ -193,7 +199,7 @@ describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: createStandardizedEntryErrorMessage("repository"),
-        })
+        }),
       );
 
       const failure2: Failure = spy.mock.calls[1][0];
@@ -202,7 +208,7 @@ describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: false,
           message: createExpectedEntryErrorMessage("bugs"),
-        })
+        }),
       );
 
       expect(workspace.readFile("package.json")).toEqual(PACKAGE_REPOSITORY);

package/src/__tests__/packageOrder.spec.ts

@@ -6,36 +6,39 @@
  */
 
 // tslint:disable:no-console
-import { AddErrorSpy, createTestingWorkspace, HOST_FACTORIES, TestingWorkspace } from "./utils.js";
 import { Context, Failure } from "@monorepolint/config";
+import { beforeEach, describe, expect, it, vi } from "vitest";
 import { packageOrder } from "../packageOrder.js";
-import { describe, expect, it, beforeEach, vi } from "vitest";
-
-const PACKAGE_UNORDERED =
-  JSON.stringify(
-    {
-      scripts: {},
-      dependencies: {},
-      version: {},
-      name: "package",
-    },
-    undefined,
-    2
-  ) + "\n";
-
-const PACKAGE_UNORDERED_UNKOWN_KEYS =
-  JSON.stringify(
-    {
-      butter: false,
-      apple: false,
-      scripts: {},
-      dependencies: {},
-      version: {},
-      name: "package-unknown-keys",
-    },
-    undefined,
-    2
-  ) + "\n";
+import {
+  AddErrorSpy,
+  createTestingWorkspace,
+  HOST_FACTORIES,
+  TestingWorkspace,
+} from "./utils.js";
+
+const PACKAGE_UNORDERED = JSON.stringify(
+  {
+    scripts: {},
+    dependencies: {},
+    version: {},
+    name: "package",
+  },
+  undefined,
+  2,
+) + "\n";
+
+const PACKAGE_UNORDERED_UNKOWN_KEYS = JSON.stringify(
+  {
+    butter: false,
+    apple: false,
+    scripts: {},
+    dependencies: {},
+    version: {},
+    name: "package-unknown-keys",
+  },
+  undefined,
+  2,
+) + "\n";
 
 const orderArray = ["name", "version", "scripts", "dependencies"];
 
@@ -44,43 +47,40 @@ const orderFunction = (_context: Context) => (a: string, b: string) => {
   return b.length - a.length || a.localeCompare(b);
 };
 
-const PACKAGE_ORDERED =
-  JSON.stringify(
-    {
-      name: "package",
-      version: {},
-      scripts: {},
-      dependencies: {},
-    },
-    undefined,
-    2
-  ) + "\n";
-
-const PACKAGE_ORDERED_BY_LENGTH =
-  JSON.stringify(
-    {
-      dependencies: {},
-      scripts: {},
-      version: {},
-      name: "package",
-    },
-    undefined,
-    2
-  ) + "\n";
-
-const PACKAGE_ORDERED_UNKOWN_KEYS =
-  JSON.stringify(
-    {
-      name: "package-unknown-keys",
-      version: {},
-      scripts: {},
-      dependencies: {},
-      apple: false,
-      butter: false,
-    },
-    undefined,
-    2
-  ) + "\n";
+const PACKAGE_ORDERED = JSON.stringify(
+  {
+    name: "package",
+    version: {},
+    scripts: {},
+    dependencies: {},
+  },
+  undefined,
+  2,
+) + "\n";
+
+const PACKAGE_ORDERED_BY_LENGTH = JSON.stringify(
+  {
+    dependencies: {},
+    scripts: {},
+    version: {},
+    name: "package",
+  },
+  undefined,
+  2,
+) + "\n";
+
+const PACKAGE_ORDERED_UNKOWN_KEYS = JSON.stringify(
+  {
+    name: "package-unknown-keys",
+    version: {},
+    scripts: {},
+    dependencies: {},
+    apple: false,
+    butter: false,
+  },
+  undefined,
+  2,
+) + "\n";
 
 describe.each(HOST_FACTORIES)("expectPackageOrder ($name)", (hostFactory) => {
   describe("fix: true", () => {
@@ -115,7 +115,7 @@ describe.each(HOST_FACTORIES)("expectPackageOrder ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: "Incorrect order of fields in package.json",
-        })
+        }),
       );
 
       expect(workspace.readFile("package.json")).toEqual(PACKAGE_ORDERED);
@@ -138,10 +138,12 @@ describe.each(HOST_FACTORIES)("expectPackageOrder ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: "Incorrect order of fields in package.json",
-        })
+        }),
       );
 
-      expect(workspace.readFile("package.json")).toEqual(PACKAGE_ORDERED_UNKOWN_KEYS);
+      expect(workspace.readFile("package.json")).toEqual(
+        PACKAGE_ORDERED_UNKOWN_KEYS,
+      );
     });
 
     it("fixes order using function", () => {
@@ -161,10 +163,12 @@ describe.each(HOST_FACTORIES)("expectPackageOrder ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: "Incorrect order of fields in package.json",
-        })
+        }),
       );
 
-      expect(workspace.readFile("package.json")).toEqual(PACKAGE_ORDERED_BY_LENGTH);
+      expect(workspace.readFile("package.json")).toEqual(
+        PACKAGE_ORDERED_BY_LENGTH,
+      );
     });
 
     it("does nothing if already order", () => {
@@ -178,7 +182,9 @@ describe.each(HOST_FACTORIES)("expectPackageOrder ($name)", (hostFactory) => {
 
       expect(spy).not.toHaveBeenCalled();
 
-      expect(workspace.readFile("package.json")).toEqual(PACKAGE_ORDERED_UNKOWN_KEYS);
+      expect(workspace.readFile("package.json")).toEqual(
+        PACKAGE_ORDERED_UNKOWN_KEYS,
+      );
     });
   });
 });

package/src/__tests__/packageScript.spec.ts

@@ -6,10 +6,15 @@
  */
 
 // tslint:disable:no-console
-import { describe, expect, it, beforeEach, vi } from "vitest";
 import { Context, Failure } from "@monorepolint/config";
+import { beforeEach, describe, expect, it, vi } from "vitest";
 import { packageScript } from "../packageScript.js";
-import { AddErrorSpy, createTestingWorkspace, HOST_FACTORIES, TestingWorkspace } from "./utils.js";
+import {
+  AddErrorSpy,
+  createTestingWorkspace,
+  HOST_FACTORIES,
+  TestingWorkspace,
+} from "./utils.js";
 
 const json = (a: unknown) => JSON.stringify(a, undefined, 2) + "\n";
 
@@ -63,7 +68,7 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: "No scripts block in package.json",
-        })
+        }),
       );
     });
   });
@@ -102,10 +107,12 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: "No scripts block in package.json",
-        })
+        }),
       );
 
-      expect(JSON.parse(workspace.readFile("package.json")!).scripts).toEqual({});
+      expect(JSON.parse(workspace.readFile("package.json")!).scripts).toEqual(
+        {},
+      );
     });
 
     it("adds a script", () => {
@@ -127,13 +134,16 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: expect.stringContaining(
-            `Expected standardized script entry for '${MISSING_SCRIPT_NAME}'`
+            `Expected standardized script entry for '${MISSING_SCRIPT_NAME}'`,
           ) as unknown as string,
-        })
+        }),
       );
 
-      expect(JSON.parse(workspace.readFile("package.json")!).scripts[MISSING_SCRIPT_NAME]).toEqual(
-        MISSING_SCRIPT_VALUE
+      expect(
+        JSON.parse(workspace.readFile("package.json")!)
+          .scripts[MISSING_SCRIPT_NAME],
+      ).toEqual(
+        MISSING_SCRIPT_VALUE,
       );
     });
 
@@ -218,7 +228,9 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
       expect(errors.length).toBe(1);
       expect(errors[0][0].fixer).toBeDefined();
 
-      expect(JSON.parse(workspace.readFile("package.json")!).scripts).toEqual({});
+      expect(JSON.parse(workspace.readFile("package.json")!).scripts).toEqual(
+        {},
+      );
     });
 
     it("can allow only empty", () => {
@@ -240,7 +252,9 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
       expect(errors.length).toBe(1);
       expect(errors[0][0].fixer).toBeDefined();
 
-      expect(JSON.parse(workspace.readFile("package.json")!).scripts).toEqual({});
+      expect(JSON.parse(workspace.readFile("package.json")!).scripts).toEqual(
+        {},
+      );
     });
   });
 });

package/src/__tests__/requireDependency.spec.ts

@@ -9,10 +9,10 @@ import { SimpleHost } from "@monorepolint/utils";
 import { readFileSync, writeFileSync } from "node:fs";
 import * as path from "node:path";
 import * as tmp from "tmp";
+import { afterEach, describe, expect, it, vi } from "vitest";
 import { requireDependency } from "../requireDependency.js";
 import { makeDirectoryRecursively } from "../util/makeDirectory.js";
 import { jsonToString } from "./utils.js";
-import { describe, expect, it, afterEach, vi } from "vitest";
 
 const PACKAGE_ROOT = jsonToString({
   workspaces: {
@@ -36,6 +36,7 @@ const PACKAGE_WITH_WRONG_ENTRIES = jsonToString({
   },
   devDependencies: {
     bar: "1.0.0",
+    baz: "1.0.0",
   },
 });
 
@@ -54,6 +55,7 @@ const OPTIONS = {
   },
   devDependencies: {
     bar: "^2.0.0",
+    baz: undefined,
   },
 } as const;
 
@@ -83,11 +85,13 @@ describe("requireDependency", () => {
         verbose: false,
         silent: true,
       },
-      new SimpleHost()
+      new SimpleHost(),
     );
 
     function checkAndSpy(q: string) {
-      const context = workspaceContext.createChildContext(path.resolve(dir.name, q));
+      const context = workspaceContext.createChildContext(
+        path.resolve(dir.name, q),
+      );
       const addErrorSpy = vi.spyOn(context, "addError");
       requireDependency({ options: OPTIONS }).check(context);
       return { context, addErrorSpy };
@@ -109,7 +113,9 @@ describe("requireDependency", () => {
   }
 
   it("checks correctly", () => {
-    const { addFile, workspaceContext, checkAndSpy } = makeWorkspace({ fix: false });
+    const { addFile, workspaceContext, checkAndSpy } = makeWorkspace({
+      fix: false,
+    });
     addFile("./package.json", PACKAGE_ROOT);
     addFile("./packages/none/package.json", PACKAGE_WITH_NO_ENTRIES);
     addFile("./packages/missing/package.json", PACKAGE_WITH_ENTRIES_MISSING);
@@ -125,7 +131,7 @@ describe("requireDependency", () => {
     expect(missing.addErrorSpy).toHaveBeenCalledTimes(2);
 
     const wrong = checkAndSpy("./packages/wrong");
-    expect(wrong.addErrorSpy).toHaveBeenCalledTimes(2);
+    expect(wrong.addErrorSpy).toHaveBeenCalledTimes(3);
 
     const right = checkAndSpy("./packages/right");
     expect(right.addErrorSpy).toHaveBeenCalledTimes(0);
@@ -141,7 +147,7 @@ describe("requireDependency", () => {
     expect(missing.addErrorSpy).toHaveBeenCalledTimes(2);
 
     const wrong = checkAndSpy("./packages/wrong");
-    expect(wrong.addErrorSpy).toHaveBeenCalledTimes(2);
+    expect(wrong.addErrorSpy).toHaveBeenCalledTimes(3);
 
     const missingContents = readFile("./packages/missing/package.json");
     expect(missingContents).toEqual(CORRECT_OUTPUT);

package/src/__tests__/utils.ts

@@ -8,9 +8,9 @@
 import { AddErrorOptions, WorkspaceContext } from "@monorepolint/config";
 import { WorkspaceContextImpl } from "@monorepolint/core";
 import { CachingHost, Host, SimpleHost } from "@monorepolint/utils";
-import { expect, MockInstance } from "vitest";
 import * as path from "node:path";
 import * as tmp from "tmp";
+import { expect, MockInstance } from "vitest";
 
 export function jsonToString(obj: unknown) {
   return JSON.stringify(obj, undefined, 2) + "\n";
@@ -22,7 +22,9 @@ interface TestingWorkspaceOpts {
   fixFlag: boolean;
 }
 
-export async function createTestingWorkspace(inboundOpts: TestingWorkspaceOpts) {
+export async function createTestingWorkspace(
+  inboundOpts: TestingWorkspaceOpts,
+) {
   tmp.setGracefulCleanup();
   const tmpdir = tmp.dirSync();
   const opts = {
@@ -43,7 +45,11 @@ export async function createTestingWorkspace(inboundOpts: TestingWorkspaceOpts)
 
   return new DefaultTestingWorkspace(
     { ...opts, rootPath },
-    new WorkspaceContextImpl(rootPath, { fix: opts.fixFlag, rules: [] }, opts.host)
+    new WorkspaceContextImpl(
+      rootPath,
+      { fix: opts.fixFlag, rules: [] },
+      opts.host,
+    ),
   );
 }
 
@@ -68,9 +74,10 @@ export interface TestingWorkspace {
 
   /**
    * Helper method for matching failures via vi `expect().toMatchObject
-   *
    */
-  failureMatcher(opts: { file: string; message: string; hasFixer: boolean }): any;
+  failureMatcher(
+    opts: { file: string; message: string; hasFixer: boolean },
+  ): any;
 
   readonly context: WorkspaceContext;
 }
@@ -78,7 +85,7 @@ export interface TestingWorkspace {
 class DefaultTestingWorkspace implements TestingWorkspace {
   constructor(
     private opts: RealTestingWorkspaceOpts,
-    public readonly context: WorkspaceContext
+    public readonly context: WorkspaceContext,
   ) {}
 
   addProject(name: string, fields: object) {
@@ -110,7 +117,9 @@ class DefaultTestingWorkspace implements TestingWorkspace {
   }
 
   readFile(filePath: string) {
-    return this.opts.host.readFile(this.getFilePath(filePath), { encoding: "utf-8" });
+    return this.opts.host.readFile(this.getFilePath(filePath), {
+      encoding: "utf-8",
+    });
   }
 
   failureMatcher(opts: { file: string; message: string; hasFixer: boolean }) {

package/src/bannedDependencies.ts

@@ -11,7 +11,10 @@ import { AggregateTiming } from "@monorepolint/utils";
 import * as path from "node:path";
 import * as r from "runtypes";
 import { createRuleFactory } from "./util/createRuleFactory.js";
-import { IPackageDependencyGraphNode, PackageDependencyGraphService } from "./util/packageDependencyGraphService.js";
+import {
+  IPackageDependencyGraphNode,
+  PackageDependencyGraphService,
+} from "./util/packageDependencyGraphService.js";
 // FIXME: This rule is messed. bannedTransitiveDependencies doesnt glob
 
 const bannedDepGlobsField = r.Union(
@@ -19,7 +22,7 @@ const bannedDepGlobsField = r.Union(
   r.Record({
     glob: r.Array(r.String).optional(),
     exact: r.Array(r.String).optional(),
-  })
+  }),
 );
 
 const Options = r.Union(
@@ -27,16 +30,14 @@ const Options = r.Union(
     bannedDependencies: bannedDepGlobsField,
     bannedTransitiveDependencies: r.Undefined.optional(),
   }),
-
   r.Record({
     bannedDependencies: bannedDepGlobsField.optional(),
     bannedTransitiveDependencies: r.Array(r.String),
   }),
-
   r.Record({
     bannedDependencies: bannedDepGlobsField.optional(),
     bannedTransitiveDependencies: r.Array(r.String).optional(),
-  })
+  }),
 );
 
 export type Options = r.Static<typeof Options>;
@@ -57,11 +58,17 @@ export const bannedDependencies = createRuleFactory<Options>({
     const packageJson = context.getPackageJson();
     const packagePath = context.getPackageJsonPath();
 
-    const curDeps = packageJson.dependencies && Object.keys(packageJson.dependencies);
-    const curDevDeps = packageJson.devDependencies && Object.keys(packageJson.devDependencies);
-    const curPeerDeps = packageJson.peerDependencies && Object.keys(packageJson.peerDependencies);
+    const curDeps = packageJson.dependencies
+      && Object.keys(packageJson.dependencies);
+    const curDevDeps = packageJson.devDependencies
+      && Object.keys(packageJson.devDependencies);
+    const curPeerDeps = packageJson.peerDependencies
+      && Object.keys(packageJson.peerDependencies);
 
-    const { bannedDependencies: banned, bannedTransitiveDependencies: transitives } = opts;
+    const {
+      bannedDependencies: banned,
+      bannedTransitiveDependencies: transitives,
+    } = opts;
 
     const globs = banned && (Array.isArray(banned) ? banned : banned.glob);
     const exacts = banned && (Array.isArray(banned) ? undefined : banned.exact);
@@ -89,8 +96,8 @@ export const bannedDependencies = createRuleFactory<Options>({
       context.addError({
         file: packagePath,
         message:
-          `Found ${violations.size} banned dependencies of package.json:\n\t` +
-          Array.from(violations)
+          `Found ${violations.size} banned dependencies of package.json:\n\t`
+          + Array.from(violations)
             .map((v) => `'${v}'`)
             .join(", "),
       });
@@ -113,7 +120,11 @@ export const bannedDependencies = createRuleFactory<Options>({
   },
 });
 
-function populateProblemsExact(banned: Set<string>, dependencies: ReadonlyArray<string>, violations: Set<string>) {
+function populateProblemsExact(
+  banned: Set<string>,
+  dependencies: ReadonlyArray<string>,
+  violations: Set<string>,
+) {
   for (const dependency of dependencies) {
     if (banned.has(dependency)) {
       violations.add(dependency);
@@ -124,7 +135,7 @@ function populateProblemsExact(banned: Set<string>, dependencies: ReadonlyArray<
 function populateProblemsGlobs(
   bannedDependencyGlobs: ReadonlyArray<string>,
   dependencies: ReadonlyArray<string>,
-  violations: Set<string>
+  violations: Set<string>,
 ) {
   for (const dependency of dependencies) {
     if (matchesAnyGlob(dependency, bannedDependencyGlobs)) {
@@ -136,13 +147,19 @@ function populateProblemsGlobs(
 // This function is slow. God help you if you use this on a big repo
 function checkTransitives(context: Context, banned: Set<string>) {
   const graphService = new PackageDependencyGraphService();
-  const root = graphService.buildDependencyGraph(path.resolve(context.getPackageJsonPath()), context.host);
+  const root = graphService.buildDependencyGraph(
+    path.resolve(context.getPackageJsonPath()),
+    context.host,
+  );
   for (const { dependencies, importPath } of graphService.traverse(root)) {
     for (const [dependency] of dependencies) {
       if (banned.has(dependency)) {
         // Remove the starting package since it's obvious in CLI output.
         const [, ...importPathWithoutRoot] = importPath;
-        const pathing = [...importPathWithoutRoot.map(nameOrPackageJsonPath), dependency].join(" -> ");
+        const pathing = [
+          ...importPathWithoutRoot.map(nameOrPackageJsonPath),
+          dependency,
+        ].join(" -> ");
 
         context.addError({
           file: root.paths.packageJsonPath,