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

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

import { describe, expect, it } from "vitest";
import { getFakeWS, getRootWS, getWS } from "./test-helpers.ts";
import makeCheck, { type ErrorType } from "../INTERNAL_MISMATCH.ts";

let rootWorkspace = getRootWS();

describe("internal mismatch", () => {
  it("should not error if internal version is compatible", () => {
    let ws = getWS();
    let dependsOnOne = getFakeWS("depends-on-one");
    dependsOnOne.packageJson.dependencies = {
      "pkg-1": "^1.0.0",
    };
    ws.set("depends-on-one", dependsOnOne);
    let errors = makeCheck.validate(dependsOnOne, ws, rootWorkspace, {});
    expect(errors.length).toEqual(0);
  });
  it("should allow workspace: protocol", () => {
    let ws = getWS();
    let dependsOnOne = getFakeWS("depends-on-one");
    dependsOnOne.packageJson.dependencies = {
      "pkg-1": "workspace:^",
    };
    ws.set("depends-on-one", dependsOnOne);
    let errors = makeCheck.validate(dependsOnOne, ws, rootWorkspace, {});
    expect(errors.length).toEqual(0);
  });
  it("should error if internal version is not compatible", () => {
    let ws = getWS();
    let dependsOnOne = getFakeWS("depends-on-one");
    dependsOnOne.packageJson.dependencies = {
      "pkg-1": "^0.1.0",
    };
    ws.set("depends-on-one", dependsOnOne);
    let errors = makeCheck.validate(dependsOnOne, ws, rootWorkspace, {});
    expect(errors[0]).toMatchObject({
      type: "INTERNAL_MISMATCH",
      dependencyWorkspace: ws.get("pkg-1"),
      workspace: dependsOnOne,
      dependencyRange: "^0.1.0",
    });
    expect(errors.length).toEqual(1);
  });
  it("should fix an incompatible version", () => {
    let workspace = getFakeWS("depends-on-one");
    workspace.packageJson.dependencies = {
      "pkg-1": "^0.1.0",
    };

    let error: ErrorType = {
      type: "INTERNAL_MISMATCH",
      workspace,
      dependencyWorkspace: getFakeWS(),
      dependencyRange: "^0.1.0",
    };

    let fixed = makeCheck.fix!(error, {});
    expect(fixed).toMatchObject({ requiresInstall: true });
    expect(workspace.packageJson.dependencies).toMatchObject({
      "pkg-1": "^1.0.0",
    });
  });
  it("should check dev dependencies", () => {
    let ws = getWS();
    let dependsOnOne = getFakeWS("depends-on-one");
    dependsOnOne.packageJson.devDependencies = {
      "pkg-1": "^0.1.0",
    };
    ws.set("depends-on-one", dependsOnOne);
    let errors = makeCheck.validate(dependsOnOne, ws, rootWorkspace, {});
    expect(errors).toMatchInlineSnapshot(`
      [
        {
          "dependencyRange": "^0.1.0",
          "dependencyWorkspace": {
            "dir": "fake/monorepo/packages/pkg-1",
            "packageJson": {
              "name": "pkg-1",
              "version": "1.0.0",
            },
            "relativeDir": "packages/pkg-1",
          },
          "type": "INTERNAL_MISMATCH",
          "workspace": {
            "dir": "fake/monorepo/packages/depends-on-one",
            "packageJson": {
              "devDependencies": {
                "pkg-1": "^0.1.0",
              },
              "name": "depends-on-one",
              "version": "1.0.0",
            },
            "relativeDir": "packages/depends-on-one",
          },
        },
      ]
    `);
  });

  // regression test for https://github.com/Thinkmill/manypkg/issues/193
  it.each(["npm:pkg-1@sometag", "npm:@someorg/pkg-1@sometag"])(
    "should not error when using tag %s",
    (range) => {
      let ws = getWS();
      let dependsOnOne = getFakeWS("depends-on-one");
      dependsOnOne.packageJson.dependencies = {
        "pkg-1": range,
      };
      ws.set("depends-on-one", dependsOnOne);
      let errors = makeCheck.validate(dependsOnOne, ws, rootWorkspace, {});
      expect(errors.length).toEqual(0);
    }
  );
});