isolate-package/src/lib/manifest/validate-manifest.test.ts

Isolate monorepo packages to form a self-contained deployable unit

import { describe, expect, it, vi } from "vitest";
import { validateManifestMandatoryFields } from "./validate-manifest";
import type { PackageManifest } from "../types";

/** Mock the logger to avoid console output during tests */
vi.mock("../logger", () => ({
  useLogger: () => ({
    debug: vi.fn(),
    error: vi.fn(),
  }),
}));

describe("validateManifestMandatoryFields", () => {
  const packagePath = "packages/test-package";

  it("should pass validation when all mandatory fields are present", () => {
    const validManifest: PackageManifest = {
      name: "test-package",
      version: "1.0.0",
      files: ["dist"],
    };

    expect(() =>
      validateManifestMandatoryFields(validManifest, packagePath),
    ).not.toThrow();
  });

  it("should pass validation for dev-only packages without files field", () => {
    const devPackageManifest: PackageManifest = {
      name: "eslint-config",
      version: "1.0.0",
    };

    expect(() =>
      validateManifestMandatoryFields(devPackageManifest, packagePath, false),
    ).not.toThrow();
  });

  it("should still require version for dev-only packages", () => {
    const invalidDevManifest = {
      name: "eslint-config",
    } as PackageManifest;

    expect(() =>
      validateManifestMandatoryFields(invalidDevManifest, packagePath, false),
    ).toThrow(/missing the "version" field/);
  });

  it("should throw error when version field is missing", () => {
    const invalidManifest = {
      name: "test-package",
      files: ["dist"],
    } as PackageManifest;

    expect(() =>
      validateManifestMandatoryFields(invalidManifest, packagePath),
    ).toThrow(/missing the "version" field/);
  });

  it("should throw error when files field is missing", () => {
    const invalidManifest = {
      name: "test-package",
      version: "1.0.0",
    } as PackageManifest;

    expect(() =>
      validateManifestMandatoryFields(invalidManifest, packagePath),
    ).toThrow(/missing the "files" field/);
  });

  it("should throw error when files field is empty array", () => {
    const invalidManifest: PackageManifest = {
      name: "test-package",
      version: "1.0.0",
      files: [],
    };

    expect(() =>
      validateManifestMandatoryFields(invalidManifest, packagePath),
    ).toThrow(/missing the "files" field/);
  });

  it("should throw error when files field is not an array", () => {
    const invalidManifest: PackageManifest = {
      name: "test-package",
      version: "1.0.0",
      files: "dist" as unknown as string[],
    };

    expect(() =>
      validateManifestMandatoryFields(invalidManifest, packagePath),
    ).toThrow(/missing the "files" field/);
  });

  it("should throw error when both fields are missing", () => {
    const invalidManifest = {
      name: "test-package",
    } as PackageManifest;

    expect(() =>
      validateManifestMandatoryFields(invalidManifest, packagePath),
    ).toThrow(/missing mandatory fields in its package\.json: version, files/);
  });

  it("should include documentation URL in error message", () => {
    const invalidManifest = {
      name: "test-package",
    } as PackageManifest;

    expect(() =>
      validateManifestMandatoryFields(invalidManifest, packagePath),
    ).toThrow(
      /See https:\/\/isolate-package\.codecompose\.dev\/getting-started#prerequisites/,
    );

    const singleFieldManifest = {
      name: "test-package",
      version: "1.0.0",
    } as PackageManifest;

    expect(() =>
      validateManifestMandatoryFields(singleFieldManifest, packagePath),
    ).toThrow(
      /See https:\/\/isolate-package\.codecompose\.dev\/getting-started#define-files-field-in-each-package-manifest/,
    );
  });
});