How aqav/obsidian-canvas-links works
Project Type and Purpose
• This is an Obsidian plugin named “Canvas Links.”
• It runs entirely inside the Obsidian host application, extends the Canvas feature, and visualizes connections between Canvas nodes and vault files.
High-Level Architecture Components
a. Obsidian Host Environment
• Provides core APIs for plugins: command registration, Canvas access, vault/file access, UI panes.
b. Canvas Links Plugin
• Entry point (main.js compiled from main.ts)
• Manifest (plugin metadata)
• Styles (styles.css for link styling)
c. Internal Modules
• Command Handler: registers “Canvas Links: Open” and listens for invocation
• File Metadata Service: reads vault files & metadata via Obsidian’s Vault API
• Link Resolver & Renderer: computes relationships (file ↔ canvas node) and draws SVG/HTML overlays on Canvas
d. Build & Release Pipeline
• esbuild.config.mjs: bundles TypeScript into main.js
• version-bump.mjs & versions.json: manages plugin versioning
• GitHub Releases / Community Plugins: distribution
Relationships and Data Flows
• Obsidian → Plugin Loader: at startup, loads main.js, manifest.json, styles.css
• User invokes command → Command Handler
• Command Handler → Canvas Data Service & File Metadata Service (parallel calls)
• Services return data → Link Resolver processes relationships
• Renderer draws link overlays on Canvas using DOM/SVG (styled by styles.css)
• Build Pipeline (out-of-band): esbuild transforms source (main.ts, modules) → distributable main.js
Architectural Patterns & Principles
• Modular single-responsibility modules (command, data, rendering)
• Observer/Listener pattern for Obsidian commands & Canvas events
• Separation of concerns: data retrieval vs. UI rendering vs. build tasks
• Plugin manifest-driven metadata for safe loading by host