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

package/src/__tests__/alphabeticalScripts.spec.ts

@@ -6,7 +6,7 @@
  */
 
 // tslint:disable:no-console
-import { describe, expect, it, beforeEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, vi } from "vitest";
 import { AddErrorSpy, createTestingWorkspace, HOST_FACTORIES, jsonToString, TestingWorkspace } from "./utils.js";
 import { Context, Failure } from "@monorepolint/config";
 import { alphabeticalScripts } from "../alphabeticalScripts.js";
@@ -43,7 +43,7 @@ describe.each(HOST_FACTORIES)("alphabeticalScripts ($name)", (hostFactory) => {
       });
       context = workspace.context; // minimizing delta
 
-      spy = jest.spyOn(workspace.context, "addError");
+      spy = vi.spyOn(workspace.context, "addError");
     });
 
     it("fixes unsorted scripts", () => {

package/src/__tests__/bannedDependencies.spec.ts

@@ -4,7 +4,7 @@
  * Licensed under the MIT license. See LICENSE file in the project root for details.
  *
  */
-import { describe, expect, it, beforeEach, jest, afterEach } from "@jest/globals";
+import { describe, expect, it, beforeEach, vi, afterEach } from "vitest";
 import { WorkspaceContextImpl } from "@monorepolint/core";
 import { SimpleHost } from "@monorepolint/utils";
 import { writeFileSync } from "fs";
@@ -26,7 +26,7 @@ describe("bannedDependencies", () => {
     cleanupJobs.push(() => dir.removeCallback());
     cwd = dir.name;
 
-    const spy = jest.spyOn(process, "cwd");
+    const spy = vi.spyOn(process, "cwd");
     spy.mockReturnValue(cwd);
   });
 
@@ -50,7 +50,7 @@ describe("bannedDependencies", () => {
     );
 
     function checkAndSpy(options: Options) {
-      const addErrorSpy = jest.spyOn(workspaceContext, "addError");
+      const addErrorSpy = vi.spyOn(workspaceContext, "addError");
       bannedDependencies({ options }).check(workspaceContext);
       return { addErrorSpy };
     }

package/src/__tests__/consistentDependencies.spec.ts

@@ -12,7 +12,7 @@ import * as tmp from "tmp";
 import { consistentDependencies, Options } from "../consistentDependencies.js";
 import { makeDirectoryRecursively } from "../util/makeDirectory.js";
 import { jsonToString } from "./utils.js";
-import { describe, expect, it, afterEach, jest } from "@jest/globals";
+import { describe, expect, it, afterEach, vi } from "vitest";
 
 const PACKAGE_ROOT = jsonToString({
   workspaces: {
@@ -76,7 +76,7 @@ describe("consistentDependencies", () => {
 
     function checkAndSpy(q: string, opts?: Options) {
       const context = workspaceContext.createChildContext(path.resolve(dir.name, q));
-      const addErrorSpy = jest.spyOn(context, "addError");
+      const addErrorSpy = vi.spyOn(context, "addError");
       consistentDependencies({ options: opts }).check(context);
       return { context, addErrorSpy };
     }

package/src/__tests__/consistentVersions.spec.ts

@@ -11,7 +11,7 @@ import * as path from "path";
 import * as tmp from "tmp";
 import { consistentVersions, Options } from "../consistentVersions.js";
 import { makeDirectoryRecursively } from "../util/makeDirectory.js";
-import { describe, expect, it, beforeEach, afterEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, afterEach, vi } from "vitest";
 
 describe("consistentVersions", () => {
   tmp.setGracefulCleanup();
@@ -24,7 +24,7 @@ describe("consistentVersions", () => {
     cleanupJobs.push(() => dir.removeCallback());
     cwd = dir.name;
 
-    const spy = jest.spyOn(process, "cwd");
+    const spy = vi.spyOn(process, "cwd");
     spy.mockReturnValue(cwd);
   });
 
@@ -47,7 +47,7 @@ describe("consistentVersions", () => {
       },
       host
     );
-    const addErrorSpy = jest.spyOn(workspaceContext, "addError");
+    const addErrorSpy = vi.spyOn(workspaceContext, "addError");
 
     function check(options: Options = { matchDependencyVersions: {} }) {
       consistentVersions({ options }).check(workspaceContext);

package/src/__tests__/fileContents.spec.ts

@@ -9,14 +9,14 @@
 import { createTestingWorkspace, HOST_FACTORIES, TestingWorkspace } from "./utils.js";
 import { AddErrorOptions, Failure } from "@monorepolint/config";
 import { fileContents } from "../fileContents.js";
-import { describe, expect, it, beforeEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, vi, MockInstance } from "vitest";
 
 const EXPECTED_FOO_FILE = "hello world";
 
 describe.each(HOST_FACTORIES)("fileContents ($name)", (hostFactory) => {
   describe("fix: true", () => {
     let workspace: TestingWorkspace;
-    let spy: jest.SpiedFunction<(opts: AddErrorOptions) => void>;
+    let spy: MockInstance<(opts: AddErrorOptions) => void>;
 
     beforeEach(async () => {
       workspace = await createTestingWorkspace({
@@ -25,7 +25,7 @@ describe.each(HOST_FACTORIES)("fileContents ($name)", (hostFactory) => {
       });
       workspace.writeFile("shared/foo-template.txt", EXPECTED_FOO_FILE);
 
-      spy = jest.spyOn(workspace.context, "addError");
+      spy = vi.spyOn(workspace.context, "addError");
     });
 
     it("works with async generator", async () => {

package/src/__tests__/mustSatisfyPeerDependencies.spec.ts

@@ -21,7 +21,7 @@ import {
   RANGE_REGEX,
 } from "../mustSatisfyPeerDependencies.js";
 import { makeDirectoryRecursively } from "../util/makeDirectory.js";
-import { describe, expect, it, beforeEach, afterEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, afterEach, vi } from "vitest";
 
 const doesASatisfyB = (a: string, b: string) => {
   if (!isValidRange(a)) {
@@ -54,7 +54,7 @@ describe("mustSatisfyPeerDependencies", () => {
     cleanupJobs.push(() => dir.removeCallback());
     cwd = dir.name;
 
-    const spy = jest.spyOn(process, "cwd");
+    const spy = vi.spyOn(process, "cwd");
     spy.mockReturnValue(cwd);
   });
 
@@ -77,7 +77,7 @@ describe("mustSatisfyPeerDependencies", () => {
       },
       host
     );
-    const addErrorSpy = jest.spyOn(workspaceContext, "addError");
+    const addErrorSpy = vi.spyOn(workspaceContext, "addError");
 
     async function check(options: Options) {
       await mustSatisfyPeerDependencies({ options }).check(workspaceContext);

package/src/__tests__/nestedWorkspaces.spec.ts

@@ -12,7 +12,7 @@ import * as tmp from "tmp";
 import { nestedWorkspaces } from "../nestedWorkspaces.js";
 import { makeDirectoryRecursively } from "../util/makeDirectory.js";
 import { jsonToString } from "./utils.js";
-import { describe, expect, it, beforeEach, afterEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, afterEach, vi } from "vitest";
 
 const EMPTY_PACKAGE = jsonToString({});
 
@@ -45,7 +45,7 @@ describe("nestedWorkspaces", () => {
     cleanupJobs.push(() => dir.removeCallback());
     cwd = dir.name;
 
-    const spy = jest.spyOn(process, "cwd");
+    const spy = vi.spyOn(process, "cwd");
     spy.mockReturnValue(cwd);
   });
 
@@ -70,7 +70,7 @@ describe("nestedWorkspaces", () => {
     );
 
     async function checkAndSpy() {
-      const addErrorSpy = jest.spyOn(workspaceContext, "addError");
+      const addErrorSpy = vi.spyOn(workspaceContext, "addError");
 
       await nestedWorkspaces({}).check(workspaceContext);
       return { addErrorSpy };

package/src/__tests__/packageEntry.spec.ts

@@ -10,7 +10,7 @@
 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";
+import { describe, expect, it, beforeEach, afterEach, vi } from "vitest";
 
 const PACKAGE_MISSING_ENTRY =
   JSON.stringify(
@@ -66,7 +66,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(() => {

package/src/__tests__/packageOrder.spec.ts

@@ -9,7 +9,7 @@
 import { AddErrorSpy, createTestingWorkspace, HOST_FACTORIES, TestingWorkspace } from "./utils.js";
 import { Context, Failure } from "@monorepolint/config";
 import { packageOrder } from "../packageOrder.js";
-import { describe, expect, it, beforeEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, vi } from "vitest";
 
 const PACKAGE_UNORDERED =
   JSON.stringify(
@@ -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", () => {

package/src/__tests__/packageScript.spec.ts

@@ -6,7 +6,7 @@
  */
 
 // tslint:disable:no-console
-import { describe, expect, it, beforeEach, jest } from "@jest/globals";
+import { describe, expect, it, beforeEach, vi } from "vitest";
 import { Context, Failure } from "@monorepolint/config";
 import { packageScript } from "../packageScript.js";
 import { AddErrorSpy, createTestingWorkspace, HOST_FACTORIES, TestingWorkspace } from "./utils.js";
@@ -41,7 +41,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", () => {
@@ -79,7 +79,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
     });
 

package/src/__tests__/requireDependency.spec.ts

@@ -12,7 +12,7 @@ import * as tmp from "tmp";
 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";
+import { describe, expect, it, afterEach, vi } from "vitest";
 
 const PACKAGE_ROOT = jsonToString({
   workspaces: {
@@ -88,7 +88,7 @@ describe("requireDependency", () => {
 
     function checkAndSpy(q: string) {
       const context = workspaceContext.createChildContext(path.resolve(dir.name, q));
-      const addErrorSpy = jest.spyOn(context, "addError");
+      const addErrorSpy = vi.spyOn(context, "addError");
       requireDependency({ options: OPTIONS }).check(context);
       return { context, addErrorSpy };
     }

package/src/__tests__/utils.ts

@@ -8,7 +8,7 @@
 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 { expect, MockInstance } from "vitest";
 import * as path from "node:path";
 import * as tmp from "tmp";
 
@@ -67,7 +67,7 @@ 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;
@@ -122,7 +122,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() },

package/src/fileContents.ts

@@ -21,7 +21,7 @@ const Options = r.Union(
   r.Record({
     file: r.String,
     generator: r.Undefined.optional(),
-    template: r.String,
+    template: r.String.Or(r.Undefined),
     templateFile: r.Undefined.optional(),
   }),
 
@@ -44,10 +44,16 @@ export const fileContents = createRuleFactory<Options>({
     const pathExists = context.host.exists(fullPath);
     const actualContent = pathExists ? context.host.readFile(fullPath, { encoding: "utf-8" }) : undefined;
     if (actualContent !== expectedContent) {
+      const longMessage =
+        pathExists && expectedContent == undefined ? undefined : diff(expectedContent, actualContent, { expand: true });
+
+      const message =
+        pathExists && expectedContent == undefined ? "File should not exist" : "Expect file contents to match";
+
       context.addError({
         file: fullPath,
-        message: "Expect file contents to match",
-        longMessage: diff(expectedContent, actualContent, { expand: true }),
+        message,
+        longMessage,
         fixer: () => {
           if (expectedContent === undefined) {
             if (pathExists) context.host.deleteFile(fullPath);

package/src/standardTsconfig.ts

@@ -39,6 +39,7 @@ const Options = r
     return count === 1 || "Expect one of { generator, template, templateFile }";
   });
 
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface Options extends r.Static<typeof Options> {}
 
 export const standardTsconfig = createRuleFactory<Options>({

package/vitest.config.mjs

@@ -0,0 +1,14 @@
+
+import { coverageConfigDefaults, defineProject, defaultExclude } from 'vitest/config'
+
+export default defineProject({
+  test: {
+   exclude: [...defaultExclude, "**/build/**"],
+    coverage: {
+      provider: "v8",
+      enabled: true,
+      exclude: [...coverageConfigDefaults.exclude, "vitest.config.*"]
+    }
+  },
+})
+          

package/jest.config.cjs

@@ -1,4 +0,0 @@
-// STOP!
-// WAIT!
-// Unless this is the version inside of "templates", you are editing a generated file. 
-module.exports = require("../../jest.config.base");