@magic5644/graph-it-live 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,13 +9,14 @@
9
9
 
10
10
  </div>
11
11
 
12
- [![Version](https://img.shields.io/visual-studio-marketplace/v/magic5644.graph-it-live?label=VS%20Code%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=magic5644.graph-it-live)
12
+ [![Version](https://vsmarketplacebadges.dev/version/magic5644.graph-it-live.svg)](https://marketplace.visualstudio.com/items?itemName=magic5644.graph-it-live)
13
+ [![vscode installs](https://vsmarketplacebadges.dev/installs-short/magic5644.graph-it-live.svg?label=vscode+installs)](https://marketplace.visualstudio.com/items?itemName=magic5644.graph-it-live)
13
14
  [![Open VSX Version](https://img.shields.io/open-vsx/v/magic5644/graph-it-live?label=Open%20VSX&logo=eclipse&logoColor=white)](https://open-vsx.org/extension/magic5644/graph-it-live)
15
+ [![Open VSX Downloads](https://img.shields.io/open-vsx/dt/magic5644/graph-it-live?label=Open%20VSX%20Downloads)](https://open-vsx.org/extension/magic5644/graph-it-live)
16
+ [![npm](https://img.shields.io/npm/v/%40magic5644%2Fgraph-it-live?label=npm%20CLI&logo=npm&logoColor=white)](https://www.npmjs.com/package/@magic5644/graph-it-live)
14
17
  [![AI Ready](https://img.shields.io/badge/AI%20Ready-MCP%20Server-blue?logo=modelcontextprotocol&logoColor=white)](https://modelcontextprotocol.io)
15
18
  [![License](https://img.shields.io/github/license/magic5644/Graph-It-Live)](https://github.com/magic5644/Graph-It-Live/blob/main/LICENSE)
16
19
  [![Github stars](https://img.shields.io/github/stars/magic5644/graph-it-live?style=flat&color=gold&logo=github)](https://github.com/magic5644/Graph-It-Live)
17
- [![vscode downloads](https://img.shields.io/visual-studio-marketplace/d/magic5644.graph-it-live?label=vscode%20Marketplace%20Downloads)](https://marketplace.visualstudio.com/items?itemName=magic5644.graph-it-live)
18
- [![Open VSX Downloads](https://img.shields.io/open-vsx/dt/magic5644/graph-it-live?label=Open%20VSX%20Downloads)](https://open-vsx.org/extension/magic5644/graph-it-live)
19
20
 
20
21
  ---
21
22
 
@@ -51,18 +52,49 @@ All three layers are also exposed to AI via a **20-tool MCP server**, so your as
51
52
 
52
53
  ## Table of Contents
53
54
 
54
- - [For AI — MCP Server](#-supercharge-your-ai-assistant)
55
- - [Codemap Generation](#-codemap-generation-new)
56
- - [All 21 MCP Tools](#available-tools)
57
- - [TOON Format (Token Savings)](#toon-format-token-optimized-output)
58
- - [For Humans Visual Features](#-features-for-humans)
55
+ - [Why Graph-It-Live?](#why-graph-it-live)
56
+ - [Table of Contents](#table-of-contents)
57
+ - [🤖 Supercharge Your AI Assistant](#-supercharge-your-ai-assistant)
58
+ - [What your AI can do with Graph-It-Live](#what-your-ai-can-do-with-graph-it-live)
59
+ - [🗺️ Codemap Generation *(New)*](#️-codemap-generation-new)
60
+ - [📊 File Logic Analysis *(New)*](#-file-logic-analysis-new)
61
+ - [👁️ Features for Humans](#️-features-for-humans)
59
62
  - [File Dependency Graph](#file-dependency-graph)
60
63
  - [Symbol-Level Drill-Down](#symbol-level-drill-down)
61
- - [Live Call Graph](#-live-call-graph-new)
64
+ - [🔷 Live Call Graph *(New)*](#-live-call-graph-new)
62
65
  - [Unused Dependency Filter](#unused-dependency-filter)
63
- - [Installation & Usage](#installation)
66
+ - [Prerequisites](#prerequisites)
67
+ - [Installation](#installation)
68
+ - [From Marketplace](#from-marketplace)
69
+ - [From Open VSX Registry](#from-open-vsx-registry)
70
+ - [Usage](#usage)
64
71
  - [Configuration](#configuration)
72
+ - [Performance Profiles](#performance-profiles)
73
+ - [All Settings](#all-settings)
74
+ - [Standalone CLI](#standalone-cli)
75
+ - [MCP Server (AI/LLM Integration)](#mcp-server-aillm-integration)
76
+ - [Setup](#setup)
77
+ - [Available Tools](#available-tools)
78
+ - [TOON Format (Token-Optimized Output)](#toon-format-token-optimized-output)
79
+ - [Native LM Tools (Copilot Agent Mode)](#native-lm-tools-copilot-agent-mode)
80
+ - [Manual MCP Server Configuration](#manual-mcp-server-configuration)
81
+ - [VS Code / VS Code Insiders](#vs-code--vs-code-insiders)
82
+ - [Cursor](#cursor)
83
+ - [Claude Desktop](#claude-desktop)
84
+ - [Development / Local Testing](#development--local-testing)
85
+ - [Windsurf](#windsurf)
86
+ - [Antigravity](#antigravity)
65
87
  - [Development](#development)
88
+ - [Quick Start](#quick-start)
89
+ - [Project Structure](#project-structure)
90
+ - [Build \& Test Commands](#build--test-commands)
91
+ - [WASM Architecture](#wasm-architecture)
92
+ - [Architecture](#architecture)
93
+ - [Testing](#testing)
94
+ - [Troubleshooting](#troubleshooting)
95
+ - [License](#license)
96
+ - [Acknowledgements](#acknowledgements)
97
+ - [Author](#author)
66
98
 
67
99
  ---
68
100
 
@@ -155,7 +187,7 @@ Entry points: initializeServer(), main()
155
187
 
156
188
  The core of Graph-It-Live: a **real-time interactive graph** showing file-to-file import relationships across your project.
157
189
 
158
- - **Multi-language:** TypeScript, JavaScript, Python, Rust, Vue, Svelte, GraphQL
190
+ - **Multi-language:** TypeScript, JavaScript, Python, Rust, C#, Go, Java, Vue, Svelte, GraphQL
159
191
  - **Cycle detection:** Circular dependencies highlighted with red dashed lines and badges
160
192
  - **Smart navigation:** Click any node to open the file; expand/collapse dependencies dynamically
161
193
  - **Reverse lookup:** Right-click → "Find Referencing Files" for instant reverse dependency discovery
@@ -183,11 +215,13 @@ Go beyond file dependencies — **drill into any file to visualize function-to-f
183
215
  3. **Click-to-navigate:** Click any symbol to jump to its definition
184
216
  4. **Breadcrumb nav:** `Project > folder > file.ts` — one click to return to file view
185
217
 
186
- **Multi-language support:**
218
+ **Multi-language support (symbol drill-down):**
187
219
  - TypeScript / JavaScript (ts-morph AST)
188
220
  - Python (tree-sitter WASM)
189
221
  - Rust (tree-sitter WASM)
190
222
 
223
+ > **Note:** C#, Go, and Java are supported at the **file dependency graph level** (L1). Symbol drill-down is not yet available for these languages.
224
+
191
225
  **Benefits:**
192
226
  - **Understand code flow** without reading every line
193
227
  - **See who calls your exports** — incoming dependencies from other files
@@ -272,7 +306,7 @@ Also available on the [Open VSX Registry](https://open-vsx.org/extension/magic56
272
306
 
273
307
  ## Usage
274
308
 
275
- 1. **Open a Project** — TypeScript, JavaScript, Python, Rust, Vue, Svelte, or GraphQL
309
+ 1. **Open a Project** — TypeScript, JavaScript, Python, Rust, C#, Go, Java, Vue, Svelte, or GraphQL
276
310
  2. **Open the Graph** — Click the Graph-It-Live icon in the Activity Bar, or run `Graph-It-Live: Show Dependency Graph`
277
311
  3. **Interact:**
278
312
  - **Click** a node → open the file
@@ -355,9 +389,10 @@ graph-it trace src/index.ts#main # Trace execution flow
355
389
  graph-it explain src/utils.ts # File logic analysis
356
390
  graph-it path src/index.ts # Dependency graph from file
357
391
  graph-it check src/api.ts # Unused exported symbols
358
- graph-it serve # Launch MCP stdio server
359
- graph-it tool --list # List all 20 MCP tools
392
+ graph-it serve # Launch MCP stdio server (for AI clients)
393
+ graph-it tool --list # List all 21 MCP tools
360
394
  graph-it tool analyze_dependencies --filePath=/abs/path/file.ts
395
+ graph-it update # Update graph-it to the latest version
361
396
  ```
362
397
 
363
398
  **Without installing globally:**
@@ -367,6 +402,28 @@ npx @magic5644/graph-it-live scan
367
402
  npx @magic5644/graph-it-live serve
368
403
  ```
369
404
 
405
+ **Output formats:** All analysis commands support `--format json|toon|markdown`. Use `toon` for AI consumption (30–60% token savings). The `trace` and `path` commands additionally support `--format mermaid` to generate a Mermaid diagram of the call or dependency flow:
406
+
407
+ ```bash
408
+ graph-it summary src/api.ts --format toon
409
+ graph-it path src/index.ts --format markdown
410
+ graph-it path src/index.ts --format mermaid # → Mermaid flowchart of dependency graph
411
+ graph-it trace src/index.ts#main --format mermaid # → Mermaid sequence/flowchart of execution trace
412
+ ```
413
+
414
+ Example `--format mermaid` output for `graph-it path src/index.ts`:
415
+
416
+ ```mermaid
417
+ graph LR
418
+ src/index.ts --> src/app.ts
419
+ src/app.ts --> src/router.ts
420
+ src/app.ts --> src/db.ts
421
+ ```
422
+
423
+ This output can be pasted directly into any Markdown renderer (GitHub, Notion, VS Code Preview, etc.) or piped to a diagramming tool.
424
+
425
+ **Use as MCP server (no VS Code):** Run `graph-it serve` and point your AI client at it — see [Manual MCP Server Configuration](#manual-mcp-server-configuration).
426
+
370
427
  ---
371
428
 
372
429
  ## MCP Server (AI/LLM Integration)
@@ -375,10 +432,18 @@ Graph-It-Live includes an optional **MCP server** that exposes its full analysis
375
432
 
376
433
  ### Setup
377
434
 
435
+ **Option A — VS Code extension:**
436
+
378
437
  1. Set `graph-it-live.enableMcpServer` to `true` in VS Code settings
379
438
  2. The server starts automatically when the extension activates
380
439
  3. Your AI assistant detects the tools via MCP auto-discovery
381
440
 
441
+ **Option B — Standalone CLI (no VS Code required):**
442
+
443
+ 1. Install: `npm install -g @magic5644/graph-it-live`
444
+ 2. Run `graph-it serve` — starts an MCP stdio server pointing at your current directory
445
+ 3. Configure your AI client to invoke `graph-it serve` as the MCP server command (see [Manual MCP Server Configuration](#manual-mcp-server-configuration))
446
+
382
447
  <div align="center">
383
448
  <img src="media/enable-mcp-server-tools.gif" alt="Enable MCP Server in VS Code Settings" width="800"/>
384
449
  </div>
@@ -431,7 +496,7 @@ All tools support an optional `format` parameter to reduce token consumption:
431
496
  | `toon` | Compact Token-Oriented Object Notation | 30-60% |
432
497
  | `markdown` | JSON wrapped in markdown code blocks | — |
433
498
 
434
- See [TOON Format Documentation](./docs/TOON_FORMAT.md) for full specifications.
499
+ See [TOON Format Documentation](./docs/architecture/TOON_FORMAT.md) for full specifications.
435
500
 
436
501
  ### Native LM Tools (Copilot Agent Mode)
437
502
 
@@ -608,7 +673,11 @@ Create or edit `.antigravity/mcp.json` in your workspace or configure globally:
608
673
  For comprehensive development instructions, see:
609
674
 
610
675
  - **[DEVELOPMENT.md](DEVELOPMENT.md)** — Setup, build, testing, WASM architecture
611
- - **[CONTRIBUTING.md](CONTRIBUTING.md)** — Contribution guidelines and workflow
676
+ - **[CONTRIBUTING.md](CONTRIBUTING.md)** — Contribution guidelines, branch naming, commit conventions
677
+ - **[docs/development/CODING_STANDARDS.md](docs/development/CODING_STANDARDS.md)** — TypeScript conventions and code style rules
678
+ - **[docs/development/CROSS_PLATFORM_TESTING.md](docs/development/CROSS_PLATFORM_TESTING.md)** — Cross-platform compatibility requirements (Windows/Linux/macOS)
679
+ - **[docs/architecture/TOON_FORMAT.md](docs/architecture/TOON_FORMAT.md)** — Token-Optimized Output format specification for AI tools
680
+ - **[docs/architecture/PERFORMANCE_OPTIMIZATIONS.md](docs/architecture/PERFORMANCE_OPTIMIZATIONS.md)** — Performance tuning and caching strategies
612
681
 
613
682
  ### Quick Start
614
683
 
@@ -646,8 +715,10 @@ Graph-It-Live/
646
715
  | Command | Description |
647
716
  |---------|-------------|
648
717
  | `npm run build` | Bundle via esbuild + copy WASM files |
718
+ | `npm run build:cli` | Build standalone CLI only (`dist/graph-it.js`) |
649
719
  | `npm run watch` | Rebuild on change |
650
720
  | `npm test` | Run unit tests (Vitest, mocked parsers) |
721
+ | `npm run test:cli` | Run CLI unit tests |
651
722
  | `npm run test:vscode` | E2E tests from source with real WASM |
652
723
  | `npm run test:vscode:vsix` | E2E tests from .vsix (pre-release) |
653
724
  | `npm run lint` | Lint TypeScript (ESLint) |