@manypkg/cli/src/checks/__tests__/EXTERNAL_MISMATCH.test.ts

Manypkg is a linter for `package.json` files in Yarn, npm, Lerna, pnpm or Rush monorepos.

import { expect, it } from "vitest";
import internalMismatch from "../EXTERNAL_MISMATCH.ts";
import { getWS, getFakeWS, getRootWS } from "./test-helpers.ts";

let rootWorkspace = getRootWS();

it("should error if the ranges are valid and they are not equal", () => {
  let ws = getWS();

  ws.get("pkg-1")!.packageJson.dependencies = { something: "1.0.0" };

  let pkg2 = getFakeWS("pkg-2");
  pkg2.packageJson.dependencies = {
    something: "2.0.0",
  };
  ws.set("pkg-2", pkg2);

  let errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
  expect(errors.length).toEqual(0);

  errors = internalMismatch.validate(ws.get("pkg-1")!, ws, rootWorkspace, {});
  expect(errors.length).toEqual(1);
  expect(errors).toMatchInlineSnapshot(`
    [
      {
        "dependencyName": "something",
        "dependencyRange": "1.0.0",
        "mostCommonDependencyRange": "2.0.0",
        "type": "EXTERNAL_MISMATCH",
        "workspace": {
          "dir": "fake/monorepo/packages/pkg-1",
          "packageJson": {
            "dependencies": {
              "something": "1.0.0",
            },
            "name": "pkg-1",
            "version": "1.0.0",
          },
          "relativeDir": "packages/pkg-1",
        },
      },
    ]
  `);
});

it("should error and return the correct mostCommonDependencyRange when the ranges are valid, they are not equal and there are more than 2", () => {
  let ws = getWS();

  ws.get("pkg-1")!.packageJson.dependencies = { something: "1.0.0" };

  let pkg2 = getFakeWS("pkg-2");
  pkg2.packageJson.dependencies = {
    something: "2.0.0",
  };
  ws.set("pkg-2", pkg2);

  let pkg3 = getFakeWS("pkg-3");
  pkg3.packageJson.dependencies = {
    something: "1.0.0",
  };

  ws.set("pkg-3", pkg3);
  let errors = internalMismatch.validate(
    ws.get("pkg-1")!,
    ws,
    rootWorkspace,
    {}
  );
  expect(errors.length).toEqual(0);

  errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
  expect(errors.length).toEqual(1);
  expect(errors).toMatchInlineSnapshot(`
    [
      {
        "dependencyName": "something",
        "dependencyRange": "2.0.0",
        "mostCommonDependencyRange": "1.0.0",
        "type": "EXTERNAL_MISMATCH",
        "workspace": {
          "dir": "fake/monorepo/packages/pkg-2",
          "packageJson": {
            "dependencies": {
              "something": "2.0.0",
            },
            "name": "pkg-2",
            "version": "1.0.0",
          },
          "relativeDir": "packages/pkg-2",
        },
      },
    ]
  `);
});

it("should error and return the correct mostCommonDependencyRange when the ranges are valid, but the 2nd dependnecy is most common", () => {
  let ws = getWS();

  ws.get("pkg-1")!.packageJson.dependencies = { something: "2.0.0" };

  let pkg2 = getFakeWS("pkg-2");
  pkg2.packageJson.dependencies = {
    something: "1.0.0",
  };
  ws.set("pkg-2", pkg2);

  let pkg3 = getFakeWS("pkg-3");
  pkg3.packageJson.dependencies = {
    something: "1.0.0",
  };

  ws.set("pkg-3", pkg3);
  let errors = internalMismatch.validate(
    ws.get("pkg-1")!,
    ws,
    rootWorkspace,
    {}
  );

  expect(errors.length).toEqual(1);
  expect(errors).toMatchInlineSnapshot(`
    [
      {
        "dependencyName": "something",
        "dependencyRange": "2.0.0",
        "mostCommonDependencyRange": "1.0.0",
        "type": "EXTERNAL_MISMATCH",
        "workspace": {
          "dir": "fake/monorepo/packages/pkg-1",
          "packageJson": {
            "dependencies": {
              "something": "2.0.0",
            },
            "name": "pkg-1",
            "version": "1.0.0",
          },
          "relativeDir": "packages/pkg-1",
        },
      },
    ]
  `);

  errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
  expect(errors.length).toEqual(0);
});

it("should error and return the correct mostCommonDependencyRange when the ranges are valid, but everything wants a different version", () => {
  let ws = getWS();

  ws.get("pkg-1")!.packageJson.dependencies = { something: "1.0.0" };

  let pkg2 = getFakeWS("pkg-2");
  pkg2.packageJson.dependencies = {
    something: "2.0.0",
  };
  ws.set("pkg-2", pkg2);

  let pkg3 = getFakeWS("pkg-3");
  pkg3.packageJson.dependencies = {
    something: "3.0.0",
  };

  ws.set("pkg-3", pkg3);
  let errors = internalMismatch.validate(
    ws.get("pkg-1")!,
    ws,
    rootWorkspace,
    {}
  );
  expect(errors.length).toEqual(1);
  expect(errors).toMatchInlineSnapshot(`
    [
      {
        "dependencyName": "something",
        "dependencyRange": "1.0.0",
        "mostCommonDependencyRange": "3.0.0",
        "type": "EXTERNAL_MISMATCH",
        "workspace": {
          "dir": "fake/monorepo/packages/pkg-1",
          "packageJson": {
            "dependencies": {
              "something": "1.0.0",
            },
            "name": "pkg-1",
            "version": "1.0.0",
          },
          "relativeDir": "packages/pkg-1",
        },
      },
    ]
  `);

  errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
  expect(errors.length).toEqual(1);
  expect(errors).toMatchInlineSnapshot(`
    [
      {
        "dependencyName": "something",
        "dependencyRange": "2.0.0",
        "mostCommonDependencyRange": "3.0.0",
        "type": "EXTERNAL_MISMATCH",
        "workspace": {
          "dir": "fake/monorepo/packages/pkg-2",
          "packageJson": {
            "dependencies": {
              "something": "2.0.0",
            },
            "name": "pkg-2",
            "version": "1.0.0",
          },
          "relativeDir": "packages/pkg-2",
        },
      },
    ]
  `);

  errors = internalMismatch.validate(pkg3, ws, rootWorkspace, {});
  expect(errors.length).toEqual(0);
});

it("should not error if the value is not a valid semver range", () => {
  let ws = getWS();

  ws.get("pkg-1")!.packageJson.dependencies = { something: "1.0.0" };

  let pkg2 = getFakeWS("pkg-2");
  pkg2.packageJson.dependencies = {
    something: "git:x",
  };
  ws.set("pkg-2", pkg2);

  let errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
  expect(errors.length).toEqual(0);

  errors = internalMismatch.validate(ws.get("pkg-1")!, ws, rootWorkspace, {});
  expect(errors.length).toEqual(0);
});