Skip to content

Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.

3.1 KB
Raw Blame
// SPDX-License-Identifier: AGPL-3.0-only
// Carbon (github.com/crbnos/carbon). Modified or adapted versions of this file,
// including ports, remain AGPLv3; serving them over a network requires releasing their source.

import { describe, expect, it } from "vitest";
import type { ModuleDir } from "../check";
import { moduleShape } from "./module-shape";

const mod = (name: string, entries: string[]): ModuleDir => ({
  name,
  dir: `/x/${name}`,
  entries
});

const COMPLIANT = [
  "sales.service.ts",
  "sales.models.ts",
  "types.ts",
  "ui",
  "sales.server.ts"
];

describe("moduleShape", () => {
  it("passes a compliant module", () => {
    expect(moduleShape.inspect(mod("sales", COMPLIANT))).toHaveLength(0);
  });

  it("flags a missing required entry (types.ts)", () => {
    const v = moduleShape.inspect(
      mod("sales", ["sales.service.ts", "sales.models.ts", "ui"])
    );
    expect(v).toHaveLength(1);
    expect(v[0]?.snippet).toBe("missing:types.ts");
  });

  it("flags an extra service file", () => {
    const v = moduleShape.inspect(
      mod("settings", [
        ...COMPLIANT.map((e) => e.replace("sales", "settings")),
        "backups.service.ts"
      ])
    );
    expect(v.map((x) => x.snippet)).toContain(
      "extra-service:backups.service.ts"
    );
  });

  it("accepts the .ee-licensed service/server variant as the primary file", () => {
    const v = moduleShape.inspect(
      mod("widget", [
        "widget.ee.service.ts",
        "widget.models.ts",
        "types.ts",
        "ui",
        "widget.ee.server.ts"
      ])
    );
    expect(v).toHaveLength(0);
  });

  it("still flags a second service file alongside the .ee variant", () => {
    const v = moduleShape.inspect(
      mod("widget", [
        "widget.ee.service.ts",
        "widget.models.ts",
        "types.ts",
        "ui",
        "extra.service.ts"
      ])
    );
    expect(v.map((x) => x.snippet)).toContain("extra-service:extra.service.ts");
  });

  it("flags a missing primary service file", () => {
    const v = moduleShape.inspect(
      mod("sales", ["sales.models.ts", "types.ts", "ui"])
    );
    expect(v.map((x) => x.snippet)).toContain("missing:sales.service.ts");
  });

  it("allows utils and test files", () => {
    const v = moduleShape.inspect(
      mod("quality", [
        "quality.service.ts",
        "quality.models.ts",
        "types.ts",
        "ui",
        "quality.server.ts",
        "quality.utils.ts",
        "quality.utils.test.ts"
      ])
    );
    expect(v).toHaveLength(0);
  });

  it("flags a barrel", () => {
    const v = moduleShape.inspect(
      mod("sales", [...COMPLIANT, "index.ts", "index.server.ts"])
    );
    expect(v.map((x) => x.snippet)).toEqual([
      "barrel:index.ts",
      "barrel:index.server.ts"
    ]);
  });

  it("allows one server file, and its tests", () => {
    const v = moduleShape.inspect(
      mod("sales", [
        ...COMPLIANT,
        "sales.server.test.ts",
        "sales.documents.server.tsx",
        "timezone.server.ts"
      ])
    );
    expect(v.map((x) => x.snippet)).toEqual([
      "extra-server:sales.documents.server.tsx",
      "extra-server:timezone.server.ts"
    ]);
  });
});