@ttsc/graph 0.16.4 → 0.16.6

package/lib/view.js

@@ -0,0 +1,140 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runView = runView;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_http_1 = __importDefault(require("node:http"));
+const node_path_1 = __importDefault(require("node:path"));
+const reduce_1 = require("./reduce");
+const resolveGraphBinary_1 = require("./resolveGraphBinary");
+function parseViewArgs(argv) {
+    const opts = {
+        cwd: process.cwd(),
+        tsconfig: "tsconfig.json",
+        port: 0,
+        open: true,
+        maxNodes: 1200,
+    };
+    for (let i = 0; i < argv.length; i++) {
+        const arg = argv[i];
+        if (arg === "--cwd")
+            opts.cwd = argv[++i] ?? opts.cwd;
+        else if (arg.startsWith("--cwd="))
+            opts.cwd = arg.slice("--cwd=".length);
+        else if (arg === "--tsconfig" || arg === "-p")
+            opts.tsconfig = argv[++i] ?? opts.tsconfig;
+        else if (arg.startsWith("--tsconfig="))
+            opts.tsconfig = arg.slice("--tsconfig=".length);
+        else if (arg === "--port")
+            opts.port = Number(argv[++i]);
+        else if (arg.startsWith("--port="))
+            opts.port = Number(arg.slice("--port=".length));
+        else if (arg === "--no-open")
+            opts.open = false;
+        else if (arg === "--max-nodes")
+            opts.maxNodes = Number(argv[++i]);
+        else if (arg.startsWith("--max-nodes="))
+            opts.maxNodes = Number(arg.slice("--max-nodes=".length));
+    }
+    return opts;
+}
+/**
+ * `ttsc-graph view`: build the project's code graph, reduce it, and serve a
+ * self-contained 3D viewer on a localhost port, opening the browser. The native
+ * binary produces the graph (the same `dump` the docs document); everything
+ * else is local and offline. The process stays alive serving until Ctrl+C.
+ */
+function runView(argv) {
+    const opts = parseViewArgs(argv);
+    const binary = (0, resolveGraphBinary_1.resolveGraphBinary)();
+    if (binary === null) {
+        process.stderr.write("@ttsc/graph: could not resolve the ttscgraph binary. " +
+            "Install `ttsc` so its platform package is present, " +
+            "or set TTSC_GRAPH_BINARY to an absolute path.\n");
+        return 1;
+    }
+    process.stderr.write(`@ttsc/graph: building the graph for ${opts.cwd} (${opts.tsconfig})...\n`);
+    const dump = (0, node_child_process_1.spawnSync)(binary, ["dump", "--cwd", opts.cwd, "--tsconfig", opts.tsconfig], { encoding: "utf8", maxBuffer: 1024 * 1024 * 1024 });
+    if (dump.error) {
+        process.stderr.write(`@ttsc/graph: ${dump.error.message}\n`);
+        return 1;
+    }
+    if (dump.status !== 0) {
+        process.stderr.write(dump.stderr || "@ttsc/graph: dump failed\n");
+        return dump.status ?? 1;
+    }
+    let raw;
+    try {
+        raw = JSON.parse(dump.stdout);
+    }
+    catch (err) {
+        process.stderr.write(`@ttsc/graph: could not parse the graph dump: ${String(err)}\n`);
+        return 1;
+    }
+    const payload = (0, reduce_1.reduce)(raw, { maxNodes: opts.maxNodes });
+    payload.project = node_path_1.default.basename(node_path_1.default.resolve(opts.cwd));
+    const graphJson = JSON.stringify(payload);
+    const viewerDir = node_path_1.default.join(__dirname, "viewer");
+    let indexHtml;
+    let viewerJs;
+    try {
+        indexHtml = node_fs_1.default.readFileSync(node_path_1.default.join(viewerDir, "index.html"));
+        viewerJs = node_fs_1.default.readFileSync(node_path_1.default.join(viewerDir, "viewer.js"));
+    }
+    catch (err) {
+        process.stderr.write(`@ttsc/graph: the bundled viewer is missing (${String(err)}). ` +
+            "Reinstall @ttsc/graph.\n");
+        return 1;
+    }
+    const server = node_http_1.default.createServer((req, res) => {
+        const url = (req.url ?? "/").split("?")[0];
+        if (url === "/graph.json") {
+            res.writeHead(200, { "content-type": "application/json" });
+            res.end(graphJson);
+        }
+        else if (url === "/viewer.js") {
+            res.writeHead(200, {
+                "content-type": "application/javascript; charset=utf-8",
+            });
+            res.end(viewerJs);
+        }
+        else {
+            res.writeHead(200, { "content-type": "text/html; charset=utf-8" });
+            res.end(indexHtml);
+        }
+    });
+    server.listen(opts.port, "127.0.0.1", () => {
+        const address = server.address();
+        const port = typeof address === "object" && address ? address.port : opts.port;
+        const url = `http://127.0.0.1:${port}/`;
+        const counts = payload.counts;
+        process.stderr.write(`@ttsc/graph: ${counts.nodes.toLocaleString()} nodes / ${counts.links.toLocaleString()} edges` +
+            ` (from ${counts.rawNodes.toLocaleString()} / ${counts.rawEdges.toLocaleString()})\n`);
+        process.stderr.write(`@ttsc/graph: serving the 3D viewer at ${url}\n`);
+        process.stderr.write("@ttsc/graph: press Ctrl+C to stop.\n");
+        if (opts.open)
+            openBrowser(url);
+    });
+    // No return: the listening server keeps the process alive until Ctrl+C.
+}
+/** Best-effort open the URL in the default browser; the URL is printed anyway. */
+function openBrowser(url) {
+    try {
+        if (process.platform === "win32")
+            (0, node_child_process_1.spawn)("cmd", ["/c", "start", "", url], {
+                stdio: "ignore",
+                detached: true,
+            }).unref();
+        else if (process.platform === "darwin")
+            (0, node_child_process_1.spawn)("open", [url], { stdio: "ignore", detached: true }).unref();
+        else
+            (0, node_child_process_1.spawn)("xdg-open", [url], { stdio: "ignore", detached: true }).unref();
+    }
+    catch {
+        /* the URL is printed; opening is a convenience */
+    }
+}
+//# sourceMappingURL=view.js.map

package/lib/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../src/view.ts"],"names":[],"mappings":";;;;;;AAAA,2DAAsD;AACtD,sDAAyB;AACzB,0DAA6B;AAC7B,0DAA6B;AAE7B,qCAAgD;AAChD,6DAA0D;AAU1D,SAAS,aAAa,CAAC,IAAuB;IAC5C,MAAM,IAAI,GAAgB;QACxB,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;QAClB,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,CAAC;QACP,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QACrB,IAAI,GAAG,KAAK,OAAO;YAAE,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC;aACjD,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACpE,IAAI,GAAG,KAAK,YAAY,IAAI,GAAG,KAAK,IAAI;YAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC;aACxC,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC;YACpC,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;aAC7C,IAAI,GAAG,KAAK,QAAQ;YAAE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aACpD,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC;YAChC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;aAC7C,IAAI,GAAG,KAAK,WAAW;YAAE,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;aAC3C,IAAI,GAAG,KAAK,aAAa;YAAE,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aAC7D,IAAI,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,iBAAwB,IAAuB;IAC7C,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAEjC,MAAM,MAAM,GAAG,IAAA,uCAAkB,GAAE,CAAC;IACpC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,uDAAuD;YACrD,qDAAqD;YACrD,iDAAiD,CACpD,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,uCAAuC,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,QAAQ,QAAQ,CAC1E,CAAC;IACF,MAAM,IAAI,GAAG,IAAA,8BAAS,EACpB,MAAM,EACN,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,EACxD,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,CACpD,CAAC;IACF,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;QAC7D,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,4BAA4B,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAY,CAAC;IAC3C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,gDAAgD,MAAM,CAAC,GAAG,CAAC,IAAI,CAChE,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,eAAM,EAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzD,OAAO,CAAC,OAAO,GAAG,mBAAI,CAAC,QAAQ,CAAC,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE1C,MAAM,SAAS,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACjD,IAAI,SAAiB,CAAC;IACtB,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,SAAS,GAAG,iBAAE,CAAC,YAAY,CAAC,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;QAChE,QAAQ,GAAG,iBAAE,CAAC,YAAY,CAAC,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,+CAA+C,MAAM,CAAC,GAAG,CAAC,KAAK;YAC7D,0BAA0B,CAC7B,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,mBAAI,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC5C,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YAC1B,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;YAC3D,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC;aAAM,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;YAChC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;gBACjB,cAAc,EAAE,uCAAuC;aACxD,CAAC,CAAC;YACH,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,0BAA0B,EAAE,CAAC,CAAC;YACnE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE;QACzC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,IAAI,GACR,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACpE,MAAM,GAAG,GAAG,oBAAoB,IAAI,GAAG,CAAC;QACxC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,gBAAgB,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,QAAQ;YAC5F,UAAU,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,CACxF,CAAC;QACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,yCAAyC,GAAG,IAAI,CAAC,CAAC;QACvE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC7D,IAAI,IAAI,CAAC,IAAI;YAAE,WAAW,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IACH,wEAAwE;AAC1E,CAAC;AAED,kFAAkF;AAClF,SAAS,WAAW,CAAC,GAAW;IAC9B,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO;YAC9B,IAAA,0BAAK,EAAC,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE;gBACrC,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC,KAAK,EAAE,CAAC;aACR,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ;YACpC,IAAA,0BAAK,EAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;;YAC/D,IAAA,0BAAK,EAAC,UAAU,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IAC7E,CAAC;IAAC,MAAM,CAAC;QACP,kDAAkD;IACpD,CAAC;AACH,CAAC"}

package/lib/viewer/index.html

@@ -0,0 +1,123 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>ttsc · code graph</title>
+    <style>
+      :root {
+        color-scheme: dark;
+      }
+      * {
+        box-sizing: border-box;
+      }
+      html,
+      body {
+        margin: 0;
+        height: 100%;
+        background: #0a0c10;
+        color: #e6edf3;
+        font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
+        overflow: hidden;
+      }
+      #app {
+        display: flex;
+        flex-direction: column;
+        height: 100vh;
+      }
+      header {
+        display: flex;
+        flex-wrap: wrap;
+        align-items: baseline;
+        gap: 0 14px;
+        padding: 10px 16px;
+        border-bottom: 1px solid #222834;
+        background: linear-gradient(to bottom, #13171f, #0e1116);
+      }
+      header .brand {
+        font-size: 13px;
+        font-weight: 600;
+        color: #f5f5f5;
+      }
+      header .brand b {
+        color: #36e2ee;
+      }
+      header #project {
+        font-size: 12px;
+        color: #9ca3af;
+      }
+      header #counts {
+        margin-left: auto;
+        font-size: 11px;
+        color: #6b7280;
+      }
+      #graph {
+        position: relative;
+        flex: 1;
+        min-height: 0;
+      }
+      #graph .tooltip {
+        position: absolute;
+        display: none;
+        pointer-events: none;
+        z-index: 10;
+        max-width: 24rem;
+        padding: 4px 7px;
+        border-radius: 6px;
+        background: rgba(12, 14, 19, 0.93);
+        border: 1px solid #2a313e;
+        font-size: 11px;
+        line-height: 1.4;
+      }
+      #graph .tooltip .muted {
+        color: #8b97a8;
+      }
+      footer {
+        display: flex;
+        flex-wrap: wrap;
+        gap: 6px 16px;
+        padding: 8px 16px;
+        border-top: 1px solid #222834;
+        font-size: 10px;
+        color: #6b7280;
+      }
+      footer .dot {
+        display: inline-flex;
+        align-items: center;
+        gap: 6px;
+      }
+      footer .swatch {
+        display: inline-block;
+        width: 16px;
+        height: 2px;
+        border-radius: 2px;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="app">
+      <header>
+        <span class="brand"><b>ttsc</b> · code graph</span>
+        <span id="project"></span>
+        <span id="counts"></span>
+      </header>
+      <div id="graph"></div>
+      <footer>
+        <span class="dot"
+          ><span class="swatch" style="background: #3fb950"></span
+          >value-call</span
+        >
+        <span class="dot"
+          ><span class="swatch" style="background: #f5b042"></span
+          >type-ref</span
+        >
+        <span class="dot"
+          ><span class="swatch" style="background: #6ea8ff"></span
+          >heritage</span
+        >
+        <span>node size = connection count · color = declaration kind</span>
+      </footer>
+    </div>
+    <script src="viewer.js"></script>
+  </body>
+</html>