Add README.md into plugin package

Author: f8thl3ss

package.json

@@ -41,14 +41,20 @@
     "glob": "11.0.1",
     "jiti": "2.4.2",
     "jszip": "3.10.1",
-    "ws": "8.18.0",
-    "zod": "3.24.1",
+    "remark": "^15.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-stringify": "^11.0.0",
+    "tsup": "8.3.5",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.1.0",
     "vite": "6.0.7",
-    "tsup": "8.3.5"
+    "ws": "8.18.0",
+    "zod": "3.24.1"
   },
   "devDependencies": {
     "@caido/eslint-config": "0.0.6",
     "@types/express": "5.0.0",
+    "@types/mdast": "^4.0.4",
     "@types/node": "22.10.2",
     "@types/ws": "8.5.13",
     "eslint": "9.17.0",

playgrounds/build-backend/README.md

@@ -0,0 +1,8 @@
+# Backend Plugin Playground
+
+This is a test playground for building backend plugins.
+
+![Test Asset](assets/test.txt)
+![External Image](https://example.com/image.png)
+
+The plugin includes a backend plugin with assets.

playgrounds/build-backend/__tests__/build-backend.spec.ts

@@ -83,4 +83,31 @@ describe("build-backend", () => {
 
     expect(assetContent).toBeUndefined();
   });
+
+  it("should have README.md file", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    expect(readmeContent).toContain("Backend Plugin Playground");
+  });
+
+  it("should transform README image links to GitHub raw URLs", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // Verify that the image link was transformed to a GitHub raw URL
+    expect(readmeContent).toMatch(
+      /https:\/\/raw\.githubusercontent\.com\/.*\/assets\/test\.txt/,
+    );
+  });
+
+  it("should remove external image URLs (http, https, data)", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // Verify that external URLs are removed (set to empty string)
+    // The README has: ![External Image](https://example.com/image.png)
+    // After transformation, it should be: ![](...)
+    expect(readmeContent).toMatch(/!\[External Image\]\(\)/);
+  });
 });

playgrounds/build-backend/package.json

@@ -9,5 +9,6 @@
     "email": "hello@caido.com",
     "url": "https://caido.com"
   },
+  "repository": "https://github.com/caido-community/dev",
   "license": "ISC"
 }

playgrounds/build-frontend/README.md

@@ -0,0 +1,58 @@
+# Frontend Build Playground
+
+This directory serves as a test fixture for validating frontend plugin build behavior in `@caido-community/dev`.
+
+## Purpose
+
+It demonstrates a minimal frontend Caido plugin configuration and is used in integration tests to verify:
+
+- Vite-based frontend builds
+- Asset bundling
+- README and referenced asset inclusion in final plugin packages
+
+## Test Asset Reference
+
+The following image reference is used to test automatic asset detection from README content:
+
+![Test Asset](assets/test.txt)
+
+## Link Test Cases
+
+Local link that should be transformed to a GitHub raw URL:
+
+[Local Doc](assets/test.txt)
+
+External link that should be removed:
+
+[External Link](https://example.com/docs)
+
+Fragment-only link that should be preserved:
+
+[Jump to section](#purpose)
+
+## Reference-Style Definition Test Cases
+
+Reference-style image and link using definitions:
+
+![Ref Image][ref-image]
+[Ref Link][ref-link]
+
+[ref-image]: assets/test.txt
+[ref-link]: https://example.com/docs
+
+## HTML Test Cases
+
+Raw HTML with local and external URLs:
+
+<img src="assets/test.txt" alt="HTML Local Image" />
+<img src="https://example.com/image.png" alt="HTML External Image" />
+<a href="assets/test.txt">HTML Local Link</a>
+<a href="https://example.com/docs">HTML External Link</a>
+
+## External URL Test Cases
+
+The following images test external URL handling (should be removed):
+
+![External HTTP](http://example.com/image.png)
+![External HTTPS](https://example.com/image.png)
+![Data URI](data:image/png;base64,abc123)

playgrounds/build-frontend/__tests__/build-frontend.spec.ts

@@ -5,6 +5,100 @@ import { describe, expect, it } from "vitest";
 import { getZipFileContent } from "../../../playgrounds/utils";
 
 describe("build-frontend", () => {
+  it("should have README.md file", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    expect(readmeContent).toContain("Frontend Build Playground");
+  });
+
+  it("should transform README image links to GitHub raw URLs", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    expect(readmeContent).toContain("raw.githubusercontent.com");
+    expect(readmeContent).toContain("assets/test.txt");
+  });
+
+  it("should remove external image URLs", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // External URLs should be removed (set to empty string)
+    expect(readmeContent).not.toContain("http://example.com/image.png");
+    expect(readmeContent).not.toContain("https://example.com/image.png");
+    // data: URIs should be kept as-is (not removed)
+    expect(readmeContent).toContain("data:image/png;base64,abc123");
+    // Image syntax should still exist but with empty URLs (alt text preserved)
+    expect(readmeContent).toContain("![External HTTP]()");
+    expect(readmeContent).toContain("![External HTTPS]()");
+    expect(readmeContent).toContain(
+      "![Data URI](data:image/png;base64,abc123)",
+    );
+  });
+
+  it("should transform local markdown links to GitHub raw URLs", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // [Local Doc](assets/test.txt) should become a GitHub raw URL
+    expect(readmeContent).toMatch(
+      /\[Local Doc\]\(https:\/\/raw\.githubusercontent\.com\/.*\/assets\/test\.txt\)/,
+    );
+  });
+
+  it("should remove external markdown link URLs", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // External link URL should be removed but link text preserved
+    expect(readmeContent).not.toContain("https://example.com/docs");
+    expect(readmeContent).toContain("[External Link]()");
+  });
+
+  it("should preserve fragment-only links", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // Same-document anchors should be preserved as-is
+    expect(readmeContent).toContain("[Jump to section](#purpose)");
+  });
+
+  it("should transform reference-style definition URLs", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // [ref-image]: assets/test.txt should be transformed to a GitHub raw URL
+    expect(readmeContent).toMatch(
+      /\[ref-image\]:\s*https:\/\/raw\.githubusercontent\.com\/.*\/assets\/test\.txt/,
+    );
+    // [ref-link]: https://example.com/docs is external and should be removed
+    expect(readmeContent).not.toContain("https://example.com/docs");
+  });
+
+  it("should transform local HTML src/href attributes", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // HTML <img src="assets/test.txt"> and <a href="assets/test.txt"> should be transformed
+    expect(readmeContent).toMatch(
+      /src="https:\/\/raw\.githubusercontent\.com\/.*\/assets\/test\.txt"/,
+    );
+    expect(readmeContent).toMatch(
+      /href="https:\/\/raw\.githubusercontent\.com\/.*\/assets\/test\.txt"/,
+    );
+  });
+
+  it("should remove external URLs in HTML attributes", async () => {
+    const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
+    const readmeContent = await getZipFileContent(zipPath, "README.md");
+    expect(readmeContent).toBeDefined();
+    // External URLs in HTML should be emptied
+    expect(readmeContent).not.toContain("https://example.com/image.png");
+    expect(readmeContent).not.toContain("https://example.com/docs");
+    expect(readmeContent).toContain('src=""');
+    expect(readmeContent).toContain('href=""');
+  });
   it("should have manifest.json file", async () => {
     const zipPath = path.resolve(__dirname, "../dist/plugin_package.zip");
 

playgrounds/build-frontend/package.json

@@ -9,5 +9,6 @@
     "email": "hello@caido.com",
     "url": "https://caido.com"
   },
+  "repository": "https://github.com/caido-community/dev",
   "license": "ISC"
 }