opencode-mermaid-renderer 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# opencode-mermaid-renderer
+
+Render mermaid diagrams as beautiful ASCII art directly in OpenCode.
+
+Powered by [beautiful-mermaid](https://github.com/lukilabs/beautiful-mermaid) from Craft.
+
+## Usage
+
+Add the plugin to your `.opencode/opencode.jsonc`:
+
+```jsonc
+{
+  "plugin": ["opencode-mermaid-renderer@0.0.1"]
+}
+```
+
+## Example
+
+When the AI generates a mermaid diagram:
+
+````markdown
+```mermaid
+graph TD
+  A[Start] --> B{Decision}
+  B -->|Yes| C[Process]
+  B -->|No| D[End]
+```
+````
+
+The plugin automatically renders it as ASCII art:
+
+```
+┌──────────┐            
+│          │            
+│  Start   │            
+│          │            
+└─────┬────┘            
+      │                 
+      │                 
+      │                 
+      │                 
+      ▼                 
+┌──────────┐            
+│          │            
+│ Decision ├──No────┐   
+│          │        │   
+└─────┬────┘        │   
+      │             │   
+      │             │   
+     Yes            │   
+      │             │   
+      ▼             ▼   
+┌──────────┐     ┌─────┐
+│          │     │     │
+│ Process  │     │ End │
+│          │     │     │
+└──────────┘     └─────┘
+```
+
+## Supported Diagram Types
+
+- **Flowcharts** - `graph TD`, `graph LR`, `graph BT`, `graph RL`
+- **State diagrams** - `stateDiagram-v2`
+- **Sequence diagrams** - `sequenceDiagram`
+- **Class diagrams** - `classDiagram`
+- **ER diagrams** - `erDiagram`
+
+## Error Handling
+
+If a mermaid diagram fails to render (invalid syntax, unsupported features), the plugin keeps the original code block and adds an HTML comment with the error:
+
+```markdown
+```mermaid
+invalid syntax here
+```
+<!-- mermaid render failed: Parse error... -->
+```
+
+## Requirements
+
+- OpenCode >= 1.0.137
+
+## License
+
+MIT
+
+## Credits
+
+- [beautiful-mermaid](https://github.com/lukilabs/beautiful-mermaid) by Craft/Lukilabs
+- Inspired by [@franlol/opencode-md-table-formatter](https://github.com/franlol/opencode-md-table-formatter)

package/index.ts

@@ -0,0 +1,81 @@
+import type { Plugin, Hooks } from "@opencode-ai/plugin"
+import { renderMermaidAscii } from "beautiful-mermaid"
+
+/**
+ * Regex to match mermaid code blocks
+ * Matches: ```mermaid\n..content..\n```
+ */
+const MERMAID_BLOCK_REGEX = /```mermaid\n([\s\S]*?)```/g
+
+/**
+ * OpenCode plugin that renders mermaid diagrams as ASCII art
+ * 
+ * Supported diagram types:
+ * - Flowcharts (graph TD/LR/BT/RL)
+ * - State diagrams (stateDiagram-v2)
+ * - Sequence diagrams (sequenceDiagram)
+ * - Class diagrams (classDiagram)
+ * - ER diagrams (erDiagram)
+ */
+export const MermaidRenderer: Plugin = async () => {
+  return {
+    "experimental.text.complete": async (
+      _input: { sessionID: string; messageID: string; partID: string },
+      output: { text: string }
+    ) => {
+      try {
+        output.text = renderMermaidBlocks(output.text)
+      } catch (error) {
+        // If something goes catastrophically wrong, keep original text
+        // and add a comment for debugging
+        output.text =
+          output.text +
+          "\n\n<!-- mermaid-renderer: unexpected error - " +
+          (error as Error).message +
+          " -->"
+      }
+    },
+  } as Hooks
+}
+
+/**
+ * Find and render all mermaid code blocks in the text
+ */
+function renderMermaidBlocks(text: string): string {
+  return text.replace(MERMAID_BLOCK_REGEX, (_match, mermaidCode: string) => {
+    return renderSingleBlock(mermaidCode.trim())
+  })
+}
+
+/**
+ * Render a single mermaid diagram to ASCII
+ * On error, returns the original code block with an error comment
+ */
+function renderSingleBlock(mermaidCode: string): string {
+  try {
+    const ascii = renderMermaidAscii(mermaidCode)
+    
+    // Wrap in a code block for proper formatting
+    return "```\n" + ascii + "\n```"
+  } catch (error) {
+    // Keep original mermaid block and add error as comment
+    const errorMessage = (error as Error).message || "Unknown error"
+    return (
+      "```mermaid\n" +
+      mermaidCode +
+      "\n```\n<!-- mermaid render failed: " +
+      escapeHtmlComment(errorMessage) +
+      " -->"
+    )
+  }
+}
+
+/**
+ * Escape characters that could break HTML comments
+ */
+function escapeHtmlComment(text: string): string {
+  return text.replace(/--/g, "- -").replace(/>/g, "&gt;")
+}
+
+// Default export for OpenCode plugin system
+export default MermaidRenderer

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "opencode-mermaid-renderer",
+  "version": "0.0.1",
+  "description": "Render mermaid diagrams as beautiful ASCII art in OpenCode",
+  "keywords": [
+    "opencode",
+    "plugin",
+    "mermaid",
+    "diagram",
+    "ascii",
+    "flowchart",
+    "sequence-diagram",
+    "state-diagram",
+    "class-diagram",
+    "er-diagram"
+  ],
+  "homepage": "https://github.com/anis-dr/opencode-mermaid-renderer#readme",
+  "bugs": {
+    "url": "https://github.com/anis-dr/opencode-mermaid-renderer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anis-dr/opencode-mermaid-renderer.git"
+  },
+  "license": "MIT",
+  "author": "anis-dr",
+  "type": "module",
+  "main": "index.ts",
+  "files": [
+    "index.ts",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "beautiful-mermaid": "^0.1.3"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": ">=0.13.7"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}