Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/CODE_MAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,14 @@ Graph-to-code rule: there is one `CodeModal`. Opening from the graph resolves th

### Symbol graph (server)

Plan: `docs/intent/symbol-graph/`. Backlog area `area-symbol-graph` in `pgm/data`.
Design rules:

- Matching is name-based first, and every edge says how sure it is: `resolution` is `exact`, `typed` or `name`. The client draws `name` edges as partial proof. The intended upgrade is to re-resolve a neighbourhood with the data-flow engine's checker.
- The server holds the index. The client asks only for a neighbourhood (up to 4 hops). Past 400 symbols the answer says `truncated`, and the client offers filters.
- Symbol ids are `file#Qualified.name`. A top-level symbol's id equals the import graph's id, so `at`, Open code and Trace work on it. Members add `.member`.
- Symbols is a third mode of the graph view. It reuses the dependency canvas, layout, palette, node menus and rail through an adapter. Nothing new is drawn by hand.

Open work: backlog area `area-symbol-graph` in `pgm/data`.

| Feature | Where |
| --- | --- |
Expand Down
15 changes: 15 additions & 0 deletions docs/initiative-history.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,20 @@
],
"revision": "0bfb05ba",
"follow_ups": []
},
{
"title": "Symbol graph",
"slug": "symbol-graph",
"outcome": "completed",
"retired_at": "2026-11-12",
"summary": "A symbol reference graph shipped for TypeScript and Python: a server index with a neighbourhood API, Symbols mode in the graph view, a path between two symbols, dead and hub overlays, and the HTTP seam between client requests and server routes. This folder had no initiative map; a minimal one was written only to run the retirement check. Reconciled against origin/main 0bfb05ba.",
"reason": "All six PRs of the shape brief's stack merged on 2026-11-05 (#348, #349, #352, #353, #354, #358).",
"documentation": [
"docs/CODE_MAP.md"
],
"revision": "0bfb05ba",
"follow_ups": [
"Re-resolve name and typed edges with the data-flow engine's checker. The backlog area area-symbol-graph in pgm/data holds any open work."
]
}
]
65 changes: 0 additions & 65 deletions docs/intent/symbol-graph/intent-brief.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/intent/symbol-graph/shape-brief.md

This file was deleted.

2 changes: 1 addition & 1 deletion pgm/data/projects/srcly-backlog/nodes/area-symbol-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ label: "Symbol graph"
type: area
status: planned
---
A symbol reference graph (functions, classes, methods, fields, variables, types; call / instantiate / read / write / type / extends / implements edges with lines and resolution) built by name from tree-sitter, served as neighbourhoods, drawn as the Symbols mode of the graph view. Intent and shape: `docs/intent/symbol-graph/`.
A symbol reference graph (functions, classes, methods, fields, variables, types; call / instantiate / read / write / type / extends / implements edges with lines and resolution) built by name from tree-sitter, served as neighbourhoods, drawn as the Symbols mode of the graph view. Design rules: `docs/CODE_MAP.md` (Symbol graph). Closure record: `docs/initiative-history.json`.
2 changes: 1 addition & 1 deletion site/src/docs/pages/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This prevents missing analysis from looking like improvement. Rankings can use d

The TypeScript and TSX dependency graph shows imports. Data flow traces modeled values, function effects, or supported routes. An import edge does not prove value movement; a data-flow edge is not a general runtime trace. The [integration brief](https://github.com/byronwall/srcly/blob/main/docs/intent/tsx-dataflow-integration/intent-brief.md) and [logic visibility brief](https://github.com/byronwall/srcly/blob/main/docs/intent/dataflow-logic-visibility/intent-brief.md) explain the boundary.

Symbols mode shows which functions, classes, fields, or types reference a symbol. Edges carry a resolution label: exact, typed, or name-based. This gives more detail than imports without claiming value flow. See the [symbol graph brief](https://github.com/byronwall/srcly/blob/main/docs/intent/symbol-graph/intent-brief.md).
Symbols mode shows which functions, classes, fields, or types reference a symbol. Edges carry a resolution label: exact, typed, or name-based. This gives more detail than imports without claiming value flow. See the [symbol graph brief](https://github.com/byronwall/srcly/blob/0bfb05ba/docs/intent/symbol-graph/intent-brief.md).

Data flow is optional. It runs through a bundled engine that requires Node.js 18 or newer. The engine's results carry outcomes and provenance, including partial, assumed, stale, and unavailable states. The rest of the scan does not depend on that engine. This keeps the base map usable when the optional analysis cannot run. Read [Data-flow analysis](../data-flow/) before relying on a trace.

Expand Down
Loading