@monorepolint/rules 0.6.0-alpha.1 → 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, jest } from "@jest/globals";
-
-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", () => {
@@ -66,7 +72,7 @@ describe.each(HOST_FACTORIES)("expectPackageEntries ($name)", (hostFactory) => {
       });
       context = workspace.context; // minimizing delta
 
-      spy = jest.spyOn(workspace.context, "addError");
+      spy = vi.spyOn(workspace.context, "addError");
     });
 
     afterEach(() => {
@@ -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, jest } from "@jest/globals";
-
-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", () => {
@@ -95,7 +95,7 @@ describe.each(HOST_FACTORIES)("expectPackageOrder ($name)", (hostFactory) => {
       });
       context = workspace.context; // minimizing delta
 
-      spy = jest.spyOn(workspace.context, "addError");
+      spy = vi.spyOn(workspace.context, "addError");
     });
 
     it("fixes order for expected keys", () => {
@@ -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, jest } from "@jest/globals";
 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";
 
@@ -41,7 +46,7 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
         host: hostFactory.make(),
       });
 
-      spy = jest.spyOn(workspace.context, "addError");
+      spy = vi.spyOn(workspace.context, "addError");
     });
 
     it("handles an empty script section", () => {
@@ -63,7 +68,7 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
           file: "package.json",
           hasFixer: true,
           message: "No scripts block in package.json",
-        })
+        }),
       );
     });
   });
@@ -79,7 +84,7 @@ describe.each(HOST_FACTORIES)("expectPackageScript ($name)", (hostFactory) => {
         host: hostFactory.make(),
       });
 
-      spy = jest.spyOn(workspace.context, "addError");
+      spy = vi.spyOn(workspace.context, "addError");
       context = workspace.context; // minimizing delta
     });
 
@@ -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, jest } from "@jest/globals";
 
 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,12 +85,14 @@ describe("requireDependency", () => {
         verbose: false,
         silent: true,
       },
-      new SimpleHost()
+      new SimpleHost(),
     );
 
     function checkAndSpy(q: string) {
-      const context = workspaceContext.createChildContext(path.resolve(dir.name, q));
-      const addErrorSpy = jest.spyOn(context, "addError");
+      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, jest } from "@jest/globals";
 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,
+    ),
   );
 }
 
@@ -67,10 +73,11 @@ export interface TestingWorkspace {
   readFile(filePath: string): string;
 
   /**
-   * Helper method for matching failures via jest `expect().toMatchObject
-   *
+   * 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 }) {
@@ -122,7 +131,7 @@ class DefaultTestingWorkspace implements TestingWorkspace {
   }
 }
 
-export type AddErrorSpy = jest.SpiedFunction<(options: AddErrorOptions) => void>;
+export type AddErrorSpy = MockInstance<(options: AddErrorOptions) => void>;
 
 export const HOST_FACTORIES: Array<{ name: string; make: () => Host }> = [
   { name: "SimpleHost", make: () => new SimpleHost() },