Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

3.7 KB
Raw Blame
import { describe, expect, it } from "vitest";

import {
  createReadmeHeadingIdsPlugin,
  createResolveReadmeLinksPlugin,
  resolveReadmeHref,
  sanitizeReadmeHref,
} from "./readme-links";

const sourceRevisionHref =
  "https://github.com/vercel/eve/tree/0123456789abcdef/apps/fixtures/weather-agent";

describe("resolveReadmeHref", () => {
  it("resolves relative links from the template directory", () => {
    expect(resolveReadmeHref("docs/setup.md", sourceRevisionHref)).toBe(
      `${sourceRevisionHref}/docs/setup.md`,
    );
  });

  it("resolves repository-root links from the pinned revision", () => {
    expect(resolveReadmeHref("/CONTRIBUTING.md", sourceRevisionHref)).toBe(
      "https://github.com/vercel/eve/tree/0123456789abcdef/CONTRIBUTING.md",
    );
  });

  it("targets rendered heading IDs and preserves safe absolute links", () => {
    expect(resolveReadmeHref("#quick-start", sourceRevisionHref)).toBe("#user-content-quick-start");
    expect(resolveReadmeHref("https://eve.dev/docs", sourceRevisionHref)).toBe(
      "https://eve.dev/docs",
    );
  });

  it("rejects relative links when the source is not a pinned GitHub tree", () => {
    expect(resolveReadmeHref("docs/setup.md", "https://example.com/template")).toBeUndefined();
  });
});

describe("createReadmeHeadingIdsPlugin", () => {
  it("adds GitHub-compatible heading IDs, including duplicate headings", () => {
    const tree = {
      type: "root",
      children: [
        {
          type: "heading",
          depth: 2,
          children: [{ type: "text", value: "Link wallet" }],
        },
        { type: "heading", depth: 3, children: [{ type: "text", value: "Link wallet" }] },
        { type: "heading", depth: 3, children: [{ type: "text", value: "Link wallet-1" }] },
        { type: "heading", depth: 3, children: [{ type: "text", value: "Node.js" }] },
        { type: "heading", depth: 3, children: [{ type: "text", value: "Next.js setup" }] },
      ],
    };

    createReadmeHeadingIdsPlugin()()(tree);

    expect(tree.children[0]).toHaveProperty("data.hProperties.id", "link-wallet");
    expect(tree.children[1]).toHaveProperty("data.hProperties.id", "link-wallet-1");
    expect(tree.children[2]).toHaveProperty("data.hProperties.id", "link-wallet-1-1");
    expect(tree.children[3]).toHaveProperty("data.hProperties.id", "nodejs");
    expect(tree.children[4]).toHaveProperty("data.hProperties.id", "nextjs-setup");
  });
});

describe("createResolveReadmeLinksPlugin", () => {
  it("resolves links before the markdown renderer sanitizes relative URLs", () => {
    const tree = {
      type: "root",
      children: [
        { type: "link", url: "docs/setup.md", children: [{ type: "text", value: "Setup" }] },
        { type: "paragraph", children: [{ type: "text", value: "No link" }] },
      ],
    };

    createResolveReadmeLinksPlugin(sourceRevisionHref)()(tree);

    expect(tree.children[0].url).toBe(`${sourceRevisionHref}/docs/setup.md`);
  });
});

describe("sanitizeReadmeHref", () => {
  it("allows web, email, telephone, relative, and anchor links", () => {
    expect(sanitizeReadmeHref("https://eve.dev")).toBe("https://eve.dev/");
    expect(sanitizeReadmeHref("mailto:[email protected]")).toBe("mailto:[email protected]");
    expect(sanitizeReadmeHref("tel:+15555555555")).toBe("tel:+15555555555");
    expect(sanitizeReadmeHref("docs/setup.md")).toBe("docs/setup.md");
    expect(sanitizeReadmeHref("#setup")).toBe("#setup");
  });

  it("rejects unsafe and protocol-relative URLs", () => {
    expect(sanitizeReadmeHref("javascript:alert(1)")).toBeUndefined();
    expect(sanitizeReadmeHref("data:text/html,hello")).toBeUndefined();
    expect(sanitizeReadmeHref("//example.com/path")).toBeUndefined();
  });
});