Plugins

Headless npm packages that teach the Core Package new language, framework, engine, document, and visual semantics. The extension renders the Relationship Graph they help build.

Plugin API v3 provides typed contracts, validated metadata, workspace-local enablement, and Core-owned lifecycle hooks.

More meaning, without a heavier Core.

Plugins enrich the Relationship Graph through a typed, headless contract while the Core Package keeps Indexing, caching, queries, and lifecycle behavior consistent.

Analysis

Contribute per-file symbols and Relationships during Indexing, including custom Node Types and Edge Types the Plugin owns.

Incremental updates

React to file-change hooks so cross-file indexes stay fresh without re-reading the whole CodeGraphy Workspace on every save.

Static metadata

Declare package identity, Plugin ID, API compatibility, supported extensions, defaults, Filters, and capability disclosures.

Workspace settings

Read Plugin options through the Plugin context and store workspace-local Plugin data under the Plugin-owned namespace.

Graph View roles

Ship Node and Edge styling, Filter defaults, file colors, and webview assets without importing VS Code.

Official Plugins, maintained with the product.

Install a package globally, register it once, enable its Plugin ID for a CodeGraphy Workspace, then run Indexing to add its graph understanding.

codegraphy.typescript

Core web app and library support for imports, exports, aliases, symbols, and inheritance Edges.

Supports: imports · exports · path aliases · symbols · inheritance

npm i -g @codegraphy-dev/plugin-typescript

codegraphy.vue

Vue single-file component support for script blocks, component imports, type imports, and lazy component Edges.

Supports: SFC scripts · component imports · type imports · lazy imports

npm i -g @codegraphy-dev/plugin-vue

codegraphy.svelte

Svelte component support for module scripts, instance scripts, type imports, and lazy module imports.

Supports: components · module scripts · type imports · lazy imports

npm i -g @codegraphy-dev/plugin-svelte

codegraphy.gdscript

Godot project support for scenes, resources, autoloads, GDScript inheritance, and class_name symbols.

Supports: scenes · resources · autoloads · GDScript · class_name

npm i -g @codegraphy-dev/plugin-godot

codegraphy.unity

Unity project support for scenes, prefabs, GameObjects, Components, ScriptableObjects, and resolved script references.

Supports: scenes · prefabs · GameObjects · Components · ScriptableObjects

npm i -g @codegraphy-dev/plugin-unity

codegraphy.markdown

Document Relationship Graph support for Markdown links, wiki-style notes, mixed docs/code Relationships, and references.

Supports: links · wikilinks · documents · references

npm i -g @codegraphy-dev/plugin-markdown

codegraphy.particles

Visual Relationship Graph background effects and Plugin-provided webview assets for customizing the graph stage.

Supports: effects · presets · webview assets · Plugin API

npm i -g @codegraphy-dev/plugin-particles

Install once. Enable per workspace.

Install and register the package once. Enable it in each CodeGraphy Workspace that needs it.

npm i -g @codegraphy-dev/plugin-vue
codegraphy plugins register @codegraphy-dev/plugin-vue
codegraphy plugins enable @codegraphy-dev/plugin-vue

Build your own

Plugins are headless npm packages. Start from the typed contracts in the Plugin API package, describe your metadata, and let the Core Package handle loading, Indexing, and rendering.

  1. 01

    Start with the Plugin API package

    Install @codegraphy-dev/plugin-api as a development dependency and use type-only imports for the public Plugin contracts.

  2. 02

    Describe package metadata before runtime code

    The Core Package validates package.json#codegraphy and codegraphy.json before importing a Plugin runtime, so registration can stay safe and deterministic.

  3. 03

    Keep the Plugin headless

    Plugins communicate with @codegraphy-dev/core. The VS Code extension handles VS Code lifecycle, editor integration, and Relationship Graph rendering.