oh-my-opencode 5.0.0-beta.23 → 5.0.0-beta.25
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/dist/cli/index.js +141 -184
- package/dist/cli-node/index.js +141 -184
- package/dist/index.js +1508 -1567
- package/dist/skills/debugging/SKILL.md +0 -2
- package/dist/skills/debugging/references/methodology/00-setup.md +0 -12
- package/dist/skills/debugging/references/methodology/02-investigate.md +0 -21
- package/dist/skills/debugging/references/runtimes/go.md +1 -15
- package/dist/skills/debugging/references/runtimes/native-binary.md +0 -38
- package/dist/skills/debugging/references/runtimes/node.md +0 -25
- package/dist/skills/debugging/references/runtimes/python.md +0 -13
- package/dist/skills/debugging/references/runtimes/rust.md +0 -41
- package/dist/tools/delegate-task/types.d.ts +0 -3
- package/dist/tui.js +0 -25
- package/package.json +15 -18
- package/packages/lsp-core/src/index.ts +0 -1
- package/packages/lsp-core/src/lsp/client-wrapper.ts +5 -25
- package/packages/lsp-core/src/lsp/client.ts +0 -26
- package/packages/lsp-core/src/lsp/connection.ts +0 -16
- package/packages/lsp-core/src/lsp/constants.ts +0 -1
- package/packages/lsp-core/src/lsp/manager.ts +1 -34
- package/packages/lsp-core/src/lsp/server-definitions.ts +0 -29
- package/packages/lsp-core/src/lsp/server-installation.ts +27 -200
- package/packages/lsp-core/src/lsp/server-resolution.ts +5 -18
- package/packages/lsp-core/src/lsp/transport.ts +0 -9
- package/packages/lsp-core/src/lsp/types.ts +0 -8
- package/packages/lsp-core/src/tool-surface.test.ts +1 -13
- package/packages/lsp-core/src/tools/definitions.ts +0 -14
- package/packages/lsp-core/src/tools/index.ts +0 -1
- package/packages/lsp-core/src/tools/types.ts +0 -10
- package/packages/lsp-daemon/dist/cli.js +144 -432
- package/packages/lsp-daemon/dist/client.d.ts +0 -10
- package/packages/lsp-daemon/dist/client.js +107 -401
- package/packages/lsp-daemon/dist/daemon-client.d.ts +0 -1
- package/packages/lsp-daemon/dist/daemon-client.js +0 -3
- package/packages/lsp-daemon/dist/index.js +107 -395
- package/packages/lsp-tools-mcp/dist/cli.js +99 -384
- package/packages/lsp-tools-mcp/dist/lsp/manager.js +0 -53
- package/packages/lsp-tools-mcp/dist/mcp.js +99 -384
- package/packages/lsp-tools-mcp/dist/tools.js +99 -385
- package/packages/omo-codex/plugin/.codex-plugin/plugin.json +1 -1
- package/packages/omo-codex/plugin/components/bootstrap/dist/cli.js +2 -2
- package/packages/omo-codex/plugin/components/bootstrap/hooks/hooks.json +1 -1
- package/packages/omo-codex/plugin/components/bootstrap/package.json +1 -1
- package/packages/omo-codex/plugin/components/codegraph/dist/cli.js +35 -69
- package/packages/omo-codex/plugin/components/codegraph/dist/serve.js +2 -21
- package/packages/omo-codex/plugin/components/codegraph/package.json +1 -1
- package/packages/omo-codex/plugin/components/comment-checker/hooks/hooks.json +1 -1
- package/packages/omo-codex/plugin/components/comment-checker/package.json +1 -1
- package/packages/omo-codex/plugin/components/git-bash/hooks/hooks.json +2 -2
- package/packages/omo-codex/plugin/components/git-bash/package.json +1 -1
- package/packages/omo-codex/plugin/components/lazycodex-executor-verify/hooks/hooks.json +1 -1
- package/packages/omo-codex/plugin/components/lazycodex-executor-verify/package.json +1 -1
- package/packages/omo-codex/plugin/components/lsp/dist/.omo-runtime-manifest.json +3 -3
- package/packages/omo-codex/plugin/components/lsp/dist/cli.js +121 -404
- package/packages/omo-codex/plugin/components/lsp/hooks/hooks.json +2 -2
- package/packages/omo-codex/plugin/components/lsp/package.json +1 -1
- package/packages/omo-codex/plugin/components/rules/dist/cli.js +3 -3
- package/packages/omo-codex/plugin/components/rules/hooks/hooks.json +4 -4
- package/packages/omo-codex/plugin/components/rules/package.json +1 -1
- package/packages/omo-codex/plugin/components/rules/src/post-compact-budget.ts +3 -3
- package/packages/omo-codex/plugin/components/rules/test/post-compact-budget.test.ts +4 -4
- package/packages/omo-codex/plugin/components/teammode/hooks/hooks.json +1 -1
- package/packages/omo-codex/plugin/components/teammode/package.json +1 -1
- package/packages/omo-codex/plugin/components/telemetry/dist/cli.js +15 -30
- package/packages/omo-codex/plugin/components/telemetry/dist/posthog.js +15 -30
- package/packages/omo-codex/plugin/components/telemetry/hooks/hooks.json +1 -1
- package/packages/omo-codex/plugin/components/telemetry/package.json +1 -1
- package/packages/omo-codex/plugin/components/ultrawork/hooks/hooks.json +1 -1
- package/packages/omo-codex/plugin/components/ultrawork/package.json +1 -1
- package/packages/omo-codex/plugin/components/ulw-execute-continuation/hooks/hooks.json +2 -2
- package/packages/omo-codex/plugin/components/ulw-execute-continuation/package.json +1 -1
- package/packages/omo-codex/plugin/components/ulw-loop/hooks/hooks.json +4 -4
- package/packages/omo-codex/plugin/components/ulw-loop/package.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-compact-resetting-git-bash-mcp-reminder.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-compact-resetting-lsp-diagnostics-cache.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-compact-resetting-project-rule-cache.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-tool-use-checking-codegraph-init-guidance.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-tool-use-checking-comments.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-tool-use-checking-lsp-diagnostics.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-tool-use-checking-thread-title-hygiene.json +1 -1
- package/packages/omo-codex/plugin/hooks/post-tool-use-matching-project-rules.json +1 -1
- package/packages/omo-codex/plugin/hooks/pre-tool-use-enforcing-unlimited-goal-budget.json +1 -1
- package/packages/omo-codex/plugin/hooks/pre-tool-use-guarding-ulw-loop-spawns.json +1 -1
- package/packages/omo-codex/plugin/hooks/pre-tool-use-recommending-git-bash-mcp.json +1 -1
- package/packages/omo-codex/plugin/hooks/session-start-checking-auto-update.json +1 -1
- package/packages/omo-codex/plugin/hooks/session-start-checking-bootstrap-provisioning.json +1 -1
- package/packages/omo-codex/plugin/hooks/session-start-checking-codegraph-bootstrap.json +1 -1
- package/packages/omo-codex/plugin/hooks/session-start-loading-project-rules.json +1 -1
- package/packages/omo-codex/plugin/hooks/session-start-recording-session-telemetry.json +1 -1
- package/packages/omo-codex/plugin/hooks/stop-checking-ulw-execute-continuation.json +1 -1
- package/packages/omo-codex/plugin/hooks/stop-checking-ulw-loop-resume.json +1 -1
- package/packages/omo-codex/plugin/hooks/subagent-stop-checking-ulw-execute-continuation.json +1 -1
- package/packages/omo-codex/plugin/hooks/subagent-stop-verifying-lazycodex-executor-evidence.json +1 -1
- package/packages/omo-codex/plugin/hooks/user-prompt-submit-checking-ultrawork-trigger.json +1 -1
- package/packages/omo-codex/plugin/hooks/user-prompt-submit-checking-ulw-loop-steering.json +1 -1
- package/packages/omo-codex/plugin/hooks/user-prompt-submit-loading-project-rules.json +1 -1
- package/packages/omo-codex/plugin/model-catalog.json +3 -3
- package/packages/omo-codex/plugin/package-lock.json +13 -13
- package/packages/omo-codex/plugin/package.json +1 -1
- package/packages/omo-codex/plugin/scripts/migrate-codex-config/catalog.mjs +3 -3
- package/packages/omo-codex/plugin/skills/debugging/SKILL.md +0 -2
- package/packages/omo-codex/plugin/skills/debugging/references/methodology/00-setup.md +0 -12
- package/packages/omo-codex/plugin/skills/debugging/references/methodology/02-investigate.md +0 -21
- package/packages/omo-codex/plugin/skills/debugging/references/runtimes/go.md +1 -15
- package/packages/omo-codex/plugin/skills/debugging/references/runtimes/native-binary.md +0 -38
- package/packages/omo-codex/plugin/skills/debugging/references/runtimes/node.md +0 -25
- package/packages/omo-codex/plugin/skills/debugging/references/runtimes/python.md +0 -13
- package/packages/omo-codex/plugin/skills/debugging/references/runtimes/rust.md +0 -41
- package/packages/omo-codex/plugin/test/aggregate-model-catalog.test.mjs +1 -1
- package/packages/omo-codex/plugin/test/auto-update.test.mjs +2 -2
- package/packages/omo-codex/plugin/test/migrate-codex-config.test.mjs +8 -8
- package/packages/omo-codex/scripts/install-config-reasoning.test.mjs +2 -2
- package/packages/omo-codex/scripts/install-dist/install-local.mjs +23 -38
- package/packages/shared-skills/skills/debugging/SKILL.md +0 -2
- package/packages/shared-skills/skills/debugging/references/methodology/00-setup.md +0 -12
- package/packages/shared-skills/skills/debugging/references/methodology/02-investigate.md +0 -21
- package/packages/shared-skills/skills/debugging/references/runtimes/go.md +1 -15
- package/packages/shared-skills/skills/debugging/references/runtimes/native-binary.md +0 -38
- package/packages/shared-skills/skills/debugging/references/runtimes/node.md +0 -25
- package/packages/shared-skills/skills/debugging/references/runtimes/python.md +0 -13
- package/packages/shared-skills/skills/debugging/references/runtimes/rust.md +0 -41
- package/dist/skills/debugging/references/scripts/dap.mjs +0 -267
- package/dist/skills/debugging/references/scripts/dap.test.ts +0 -86
- package/dist/skills/debugging/references/scripts/fixture-adapter.mjs +0 -59
- package/dist/skills/debugging/references/tools/dap.md +0 -103
- package/dist/skills/debugging/references/tools/frida.md +0 -193
- package/packages/lsp-core/src/lsp/format-document.test.ts +0 -143
- package/packages/lsp-core/src/lsp/format-document.ts +0 -90
- package/packages/lsp-core/src/lsp/manager-max-clients.test.ts +0 -151
- package/packages/lsp-core/src/lsp/server-installation.test.ts +0 -376
- package/packages/lsp-core/src/lsp/server-resolution-local-binary.test.ts +0 -170
- package/packages/lsp-core/src/tools/format.test.ts +0 -56
- package/packages/lsp-core/src/tools/format.ts +0 -56
- package/packages/omo-codex/plugin/skills/debugging/references/scripts/dap.mjs +0 -267
- package/packages/omo-codex/plugin/skills/debugging/references/scripts/fixture-adapter.mjs +0 -59
- package/packages/omo-codex/plugin/skills/debugging/references/tools/dap.md +0 -103
- package/packages/omo-codex/plugin/skills/debugging/references/tools/frida.md +0 -193
- package/packages/shared-skills/skills/debugging/references/scripts/dap.mjs +0 -267
- package/packages/shared-skills/skills/debugging/references/scripts/dap.test.ts +0 -86
- package/packages/shared-skills/skills/debugging/references/scripts/fixture-adapter.mjs +0 -59
- package/packages/shared-skills/skills/debugging/references/tools/dap.md +0 -103
- package/packages/shared-skills/skills/debugging/references/tools/frida.md +0 -193
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import { test, expect, describe } from "bun:test";
|
|
2
|
-
import { spawn } from "node:child_process";
|
|
3
|
-
import { join } from "node:path";
|
|
4
|
-
|
|
5
|
-
const dir = import.meta.dir;
|
|
6
|
-
const client = join(dir, "dap.mjs");
|
|
7
|
-
const fixture = join(dir, "fixture-adapter.mjs");
|
|
8
|
-
|
|
9
|
-
test("treats Windows drive-letter paths as executable specs, not host-port specs", async () => {
|
|
10
|
-
const { isTcpAdapterSpec } = await import("./dap.mjs");
|
|
11
|
-
expect(isTcpAdapterSpec("C:\\workspace\\fixture-adapter.mjs")).toBe(false);
|
|
12
|
-
expect(isTcpAdapterSpec("127.0.0.1:5678")).toBe(true);
|
|
13
|
-
});
|
|
14
|
-
|
|
15
|
-
function frame(message: unknown) {
|
|
16
|
-
const body = Buffer.from(JSON.stringify(message));
|
|
17
|
-
return Buffer.concat([Buffer.from(`Content-Length: ${body.length}\r\n\r\n`), body]);
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
describe("DAP framing", () => {
|
|
21
|
-
test("parses multiple frames and frames split across chunks", async () => {
|
|
22
|
-
const { DapFrameParser } = await import("./dap.mjs");
|
|
23
|
-
const parser = new DapFrameParser();
|
|
24
|
-
const first = frame({ type: "event", event: "one" });
|
|
25
|
-
const second = frame({ type: "event", event: "two", body: { ok: true } });
|
|
26
|
-
expect(parser.push(Buffer.concat([first, second]))).toEqual([{ type: "event", event: "one" }, { type: "event", event: "two", body: { ok: true } }]);
|
|
27
|
-
const third = frame({ type: "response", seq: 3 });
|
|
28
|
-
expect(parser.push(third.subarray(0, 9))).toEqual([]);
|
|
29
|
-
expect(parser.push(third.subarray(9, 17))).toEqual([]);
|
|
30
|
-
expect(parser.push(third.subarray(17))).toEqual([{ type: "response", seq: 3 }]);
|
|
31
|
-
});
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
function session(...fixtureArgs: string[]) {
|
|
35
|
-
// 300ms request timeout ONLY for the --no-answer session, whose test asserts the
|
|
36
|
-
// timeout classification and needs it to fire fast. Answering sessions get 5s:
|
|
37
|
-
// the vars-8 fixture response is ~130KB over a pipe, and on a loaded Windows CI
|
|
38
|
-
// runner that transfer exceeded 300ms, so the request timed out and TRUNCATED
|
|
39
|
-
// output could never appear (run 33065571760: byte-cap test burned its full
|
|
40
|
-
// 15s wait while vars-7's ~5KB response stayed under 300ms and passed).
|
|
41
|
-
const noAnswer = fixtureArgs.includes("--no-answer");
|
|
42
|
-
const child = spawn("bun", [client], { cwd: dir, env: { ...process.env, DAP_TIMEOUT_MS: noAnswer ? "300" : "5000", ...(noAnswer ? { DAP_FIXTURE_NO_ANSWER: "1" } : {}) } });
|
|
43
|
-
let output = "";
|
|
44
|
-
child.stdout.on("data", data => { output += data.toString(); });
|
|
45
|
-
const api = { child, get output() { return output; }, command(line: string) { child.stdin.write(`${line}\n`); } };
|
|
46
|
-
api.command(`launch ${fixture} /tmp/program.py`);
|
|
47
|
-
return api;
|
|
48
|
-
}
|
|
49
|
-
async function until(s: ReturnType<typeof session>, predicate: (out: string) => boolean) {
|
|
50
|
-
// 15s, not 3s: the file's first `spawn("bun", ...)` on a cold Windows CI runner
|
|
51
|
-
// (bun.exe cold launch + AV scan + fixture adapter spawn) was observed at just
|
|
52
|
-
// over 3s (dev run 33064234392: first READY wait failed at 3024ms while the
|
|
53
|
-
// warm sessions of later tests passed). `until` returns as soon as the
|
|
54
|
-
// predicate holds, so the raise costs nothing on the green path.
|
|
55
|
-
const deadline = Date.now() + 15_000;
|
|
56
|
-
while (!predicate(s.output) && Date.now() < deadline) await Bun.sleep(10);
|
|
57
|
-
expect(predicate(s.output)).toBe(true);
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
test("full session emits stop snapshot, stack and capped variables", async () => {
|
|
61
|
-
const s = session();
|
|
62
|
-
await until(s, out => out.includes("READY: launch"));
|
|
63
|
-
s.command("break /tmp/program.py:12"); await until(s, out => out.includes("BREAK:"));
|
|
64
|
-
s.command("continue"); await until(s, out => out.includes("STOP: stopped reason=breakpoint threadId=1 main at /tmp/program.py:12:3"));
|
|
65
|
-
s.command("stack"); await until(s, out => out.includes("FRAME\t"));
|
|
66
|
-
s.command("vars 7"); await until(s, out => out.includes("TRUNCATED: rows dropped=150"));
|
|
67
|
-
expect((s.output.match(/^v\d+\t/gm) ?? []).length).toBe(100);
|
|
68
|
-
s.command("terminate"); await until(s, out => out.includes("EXIT:"));
|
|
69
|
-
s.command("quit");
|
|
70
|
-
}, 60_000);
|
|
71
|
-
|
|
72
|
-
test("byte cap reports dropped bytes", async () => {
|
|
73
|
-
const s = session();
|
|
74
|
-
await until(s, out => out.includes("READY: launch"));
|
|
75
|
-
s.command("vars 8"); await until(s, out => out.includes("TRUNCATED: rows dropped=") && out.includes("bytes dropped="));
|
|
76
|
-
s.command("quit");
|
|
77
|
-
}, 60_000);
|
|
78
|
-
|
|
79
|
-
test("unverified breakpoint and timeout are classified", async () => {
|
|
80
|
-
const s = session();
|
|
81
|
-
await until(s, out => out.includes("READY: launch"));
|
|
82
|
-
s.command("break /tmp/unverified.py:9"); await until(s, out => out.includes("ERR: unverified-breakpoint"));
|
|
83
|
-
const t = session("--no-answer");
|
|
84
|
-
await until(t, out => out.includes("ERR: timeout"));
|
|
85
|
-
s.command("quit"); t.command("quit");
|
|
86
|
-
}, 60_000);
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
// Deterministic DAP fixture used by dap.test.ts.
|
|
3
|
-
import { stdin, stdout, argv } from "node:process";
|
|
4
|
-
|
|
5
|
-
let seq = 1;
|
|
6
|
-
let buffer = Buffer.alloc(0);
|
|
7
|
-
const noAnswer = argv.includes("--no-answer") || process.env.DAP_FIXTURE_NO_ANSWER === "1";
|
|
8
|
-
|
|
9
|
-
function send(message) {
|
|
10
|
-
const body = Buffer.from(JSON.stringify(message));
|
|
11
|
-
stdout.write(`Content-Length: ${body.length}\r\n\r\n`);
|
|
12
|
-
stdout.write(body);
|
|
13
|
-
}
|
|
14
|
-
function response(request, body = {}, success = true, message) {
|
|
15
|
-
send({ type: "response", seq: seq++, request_seq: request.seq, success, command: request.command, body, ...(message ? { message } : {}) });
|
|
16
|
-
}
|
|
17
|
-
function event(event, body = {}) { send({ type: "event", seq: seq++, event, body }); }
|
|
18
|
-
function handle(request) {
|
|
19
|
-
if (noAnswer && request.command === "initialize") return;
|
|
20
|
-
switch (request.command) {
|
|
21
|
-
case "initialize":
|
|
22
|
-
response(request, { supportsConfigurationDoneRequest: true, supportsEvaluateForHovers: true });
|
|
23
|
-
event("initialized");
|
|
24
|
-
break;
|
|
25
|
-
case "setBreakpoints": {
|
|
26
|
-
const bps = request.arguments?.breakpoints ?? [];
|
|
27
|
-
response(request, { breakpoints: bps.map((bp, i) => ({ id: i + 1, verified: !request.arguments?.source?.path?.includes("unverified"), line: bp.line, column: bp.column ?? 1, message: "fixture" })) });
|
|
28
|
-
break;
|
|
29
|
-
}
|
|
30
|
-
case "configurationDone": response(request); break;
|
|
31
|
-
case "launch": response(request); break;
|
|
32
|
-
case "continue": response(request, { allThreadsContinued: true }); event("stopped", { reason: "breakpoint", threadId: 1, allThreadsStopped: true }); break;
|
|
33
|
-
case "next": case "stepIn": case "stepOut": response(request); event("stopped", { reason: "step", threadId: 1 }); break;
|
|
34
|
-
case "pause": response(request); event("stopped", { reason: "pause", threadId: 1 }); break;
|
|
35
|
-
case "threads": response(request, { threads: [{ id: 1, name: "main" }] }); break;
|
|
36
|
-
case "stackTrace": response(request, { stackFrames: [{ id: 42, name: "main", source: { path: "/tmp/program.py" }, line: 12, column: 3 }] }); break;
|
|
37
|
-
case "scopes": response(request, { scopes: [{ name: "Locals", variablesReference: 7, expensive: false }] }); break;
|
|
38
|
-
case "variables": response(request, { variables: Array.from({ length: 250 }, (_, i) => ({ name: `v${i + 1}`, value: request.arguments?.variablesReference === 8 ? `${String(i + 1)} ${"x".repeat(500)}` : String(i + 1), variablesReference: 0 })) }); break;
|
|
39
|
-
case "evaluate": response(request, { result: "42", type: "int", variablesReference: 0 }); break;
|
|
40
|
-
case "terminate": response(request); event("terminated", {}); break;
|
|
41
|
-
default: response(request, {}, false, `unsupported ${request.command}`);
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
stdin.on("data", chunk => {
|
|
45
|
-
buffer = Buffer.concat([buffer, chunk]);
|
|
46
|
-
while (true) {
|
|
47
|
-
const marker = buffer.indexOf(Buffer.from("\r\n\r\n"));
|
|
48
|
-
if (marker < 0) return;
|
|
49
|
-
const header = buffer.subarray(0, marker).toString();
|
|
50
|
-
const match = header.match(/Content-Length:\s*(\d+)/i);
|
|
51
|
-
if (!match) { buffer = buffer.subarray(marker + 4); continue; }
|
|
52
|
-
const length = Number(match[1]);
|
|
53
|
-
const start = marker + 4;
|
|
54
|
-
if (buffer.length < start + length) return;
|
|
55
|
-
const body = buffer.subarray(start, start + length);
|
|
56
|
-
buffer = buffer.subarray(start + length);
|
|
57
|
-
try { handle(JSON.parse(body.toString("utf8"))); } catch { /* fixture input is controlled */ }
|
|
58
|
-
}
|
|
59
|
-
});
|
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
# DAP Client (`dap.mjs`) — Drive the Debugger's Protocol, Not Its Text
|
|
2
|
-
|
|
3
|
-
**Design modeled on the `debug` tool of oh-my-pi (https://github.com/can1357/oh-my-pi, branch omp2).** Their harness proved the shape: one structured debug surface with bounded output, stop snapshots, and classified errors. This script brings the same discipline to any agent with a shell — no harness tool registration required.
|
|
4
|
-
|
|
5
|
-
Debuggers already speak the Debug Adapter Protocol (DAP), a machine-readable JSON protocol. Driving DAP beats screen-scraping a PTY for the same reason an API beats OCR: structured stops, structured variables, structured errors. **If the debugger speaks DAP, use this script instead of parsing `gdb`/`pdb` output.**
|
|
6
|
-
|
|
7
|
-
The script is at `references/scripts/dap.mjs` — zero dependencies, runs under Bun or Node.
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## When to use which interface
|
|
12
|
-
|
|
13
|
-
| Situation | Use |
|
|
14
|
-
|---|---|
|
|
15
|
-
| Source-level debugging of Python / Go / Node / native code, and you need breakpoints, stepping, variables | `dap.mjs` (this file) |
|
|
16
|
-
| Browser-served JS, or anything already in Chrome | Scripted CDP — see `references/runtimes/node.md` |
|
|
17
|
-
| Stripped binary, no source, no symbols | Ghidra (static) + Frida (live) — see `references/tools/` |
|
|
18
|
-
| The debugger has no DAP mode (plain gdb on an exotic target) | pwndbg, with the output-budget rule from `references/methodology/00-setup.md` |
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## How to drive it
|
|
23
|
-
|
|
24
|
-
`dap.mjs` is a **REPL**, not a one-shot command: a debug session is long-lived, so the script runs as a persistent process reading one command per line on stdin and writing bounded text on stdout. Run it as a background shell session, send commands to its stdin, and subscribe to its output.
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
bun references/scripts/dap.mjs
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
Every execution-control answer prints a single snapshot line beginning with `STOP:` — subscribe your watcher to that exact prefix so a breakpoint hit wakes you instead of you polling.
|
|
31
|
-
|
|
32
|
-
### Commands
|
|
33
|
-
|
|
34
|
-
| Command | Effect |
|
|
35
|
-
|---|---|
|
|
36
|
-
| `launch <adapter> <program> [args...]` | Spawn a stdio adapter (path to executable or `.mjs` adapter) and launch the program under it |
|
|
37
|
-
| `attach <host:port>` | Connect to a listening adapter over TCP and attach |
|
|
38
|
-
| `break <file>:<line>` / `rmbreak <file>:<line>` | Set / remove a source breakpoint |
|
|
39
|
-
| `continue` / `step` / `next` / `stepin` / `stepout` / `pause` | Execution control; each prints a `STOP:` snapshot when the debuggee next stops |
|
|
40
|
-
| `stack [limit]` | TSV backtrace, bounded |
|
|
41
|
-
| `scopes` | Scopes of the top frame with their variablesReferences |
|
|
42
|
-
| `vars <ref>` | Variables under a variablesReference from `scopes` — refs are session-scoped; always chain `scopes` first |
|
|
43
|
-
| `eval <expr>` | Evaluate in the top frame |
|
|
44
|
-
| `threads` / `sessions` | Thread list / session state |
|
|
45
|
-
| `terminate` / `quit` | End the debuggee / exit the REPL |
|
|
46
|
-
|
|
47
|
-
### Output contract (what keeps your context alive)
|
|
48
|
-
|
|
49
|
-
- Tabular results are TSV with a header row.
|
|
50
|
-
- Hard caps: `MAX_ROWS = 100`, `MAX_OUTPUT_BYTES = 32 KB`. Overflow prints an explicit `TRUNCATED: rows dropped=N bytes dropped=M` line — never a silent cut.
|
|
51
|
-
- After every continue/step: `STOP: stopped reason=<why> threadId=<id> <frame> at <file>:<line>:<col>`. On debuggee exit: `EXIT: terminated`.
|
|
52
|
-
- Errors are one line, classified: `ERR: invalid-args | no-session | adapter-failed | unverified-breakpoint | timeout | terminated | adapter-error`. The token tells you the recovery — see the failure taxonomy in `references/methodology/02-investigate.md`.
|
|
53
|
-
- Every request times out after 15 s (override with `DAP_TIMEOUT_MS`) and the session stays alive.
|
|
54
|
-
- `DAP_DEBUG=1` logs raw protocol traffic to stderr for diagnosing a misbehaving adapter.
|
|
55
|
-
|
|
56
|
-
### Adapter quirks this client already handles
|
|
57
|
-
|
|
58
|
-
- **debugpy** requires `console: "internalConsole"` in the launch request, and withholds the `initialized` event for unrecognized `adapterID`s — the client sends both correctly. It also flushes `initialized` lazily, so the client launches first and awaits the event after.
|
|
59
|
-
- **lldb-dap** reports the launch response's `success` unreliably (`false` even when the process started and stopped) and reports `threadId: 0` on the entry stop. The events are the real signal; the client tolerates the response flag.
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## Adapter matrix
|
|
64
|
-
|
|
65
|
-
Translated from oh-my-pi's `builtin_adapters()` (omp2 `crates/docserver/src/dap_adapter.rs`). Install the one matching your runtime; the client speaks to all of them the same way.
|
|
66
|
-
|
|
67
|
-
| Runtime | Adapter | Install | Launch mode |
|
|
68
|
-
|---|---|---|---|
|
|
69
|
-
| Python | debugpy | `pip install debugpy` | `python -m debugpy.adapter` (stdio) |
|
|
70
|
-
| Go | dlv | `go install github.com/go-delve/delve/cmd/dlv@latest` | `dlv dap` (stdio) |
|
|
71
|
-
| C/C++/Swift/Rust/Zig | lldb-dap | ships with Xcode CLT / LLVM | `lldb-dap` (stdio) |
|
|
72
|
-
| C/C++/Rust/Zig | codelldb | VS Code extension binary | stdio |
|
|
73
|
-
| C/C++/Rust | gdb | `brew install gdb` / apt | via gdb's DAP mode where available |
|
|
74
|
-
| JS/TS | js-debug | `npm i -g @vscode/js-debug` | stdio |
|
|
75
|
-
| .NET | netcoredbg | GitHub releases | stdio |
|
|
76
|
-
| Ruby | rdbg | `gem install debug` | stdio |
|
|
77
|
-
| Kotlin | kotlin-debug-adapter | GitHub releases | stdio |
|
|
78
|
-
| PHP | php-debug-adapter | composer | stdio |
|
|
79
|
-
| Bash | bash-debug-adapter | GitHub releases | stdio |
|
|
80
|
-
| Dart/Flutter | dart debug adapter | ships with Dart SDK | `dart` (stdio) |
|
|
81
|
-
| Elixir | elixir-ls debugger | GitHub releases | stdio |
|
|
82
|
-
|
|
83
|
-
If an adapter is missing, the install line is the fix — do not fall back to scraping a REPL.
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## Worked example (Python)
|
|
88
|
-
|
|
89
|
-
```
|
|
90
|
-
launch /path/to/python -m debugpy.adapter myscript.py # or a wrapper script path
|
|
91
|
-
break myscript.py:12
|
|
92
|
-
continue
|
|
93
|
-
STOP: stopped reason=breakpoint threadId=1 compute at myscript.py:12:1
|
|
94
|
-
stack
|
|
95
|
-
scopes
|
|
96
|
-
vars 6 # the variablesReference scopes just printed for Locals
|
|
97
|
-
eval total
|
|
98
|
-
continue
|
|
99
|
-
terminate
|
|
100
|
-
quit
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
Cleanup is part of the session: `terminate` the debuggee, `quit` the REPL, and journal any wrapper scripts you created per the skill's cleanup phase.
|
|
@@ -1,193 +0,0 @@
|
|
|
1
|
-
# Frida — Hook a Live Process and See Real Values at Runtime
|
|
2
|
-
|
|
3
|
-
**https://frida.re**
|
|
4
|
-
|
|
5
|
-
Frida injects a JavaScript engine into a running process and lets you intercept function calls, read arguments, patch return values, and trace execution without touching the binary on disk. **When static analysis in Ghidra shows you *what* a function does, Frida shows you what it does *right now*, with real inputs.** The two compose naturally: use Ghidra to find the target function and its offset, then use Frida to hook it and watch live traffic.
|
|
6
|
-
|
|
7
|
-
Choose Frida over Ghidra when you need runtime values (actual arguments, return codes, heap contents) or when the binary's control flow is too obfuscated for static analysis to resolve.
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Install
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
pip install frida-tools # Python 3 required
|
|
15
|
-
frida --version # verify
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
On macOS, attaching to another user's process needs root (`sudo frida ...`). SIP-protected system binaries (`/usr/bin/*`, `/usr/sbin/*`) are off-limits entirely. On Linux, you may need `ptrace` permissions: run as root or set `kernel.yama.ptrace_scope=0`.
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Target discovery with `frida-ps`
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
frida-ps # list local processes
|
|
26
|
-
frida-ps -U # USB-connected device (iOS/Android)
|
|
27
|
-
frida-ps | grep -i target # find your target by name
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## `frida-trace` — zero-code entry point
|
|
33
|
-
|
|
34
|
-
`frida-trace` auto-generates JavaScript handler stubs for every matched function. You don't write any code to start.
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
frida-trace -p <pid> -i "recv*" # trace exported functions by glob
|
|
38
|
-
frida-trace -p <pid> -m "-[NSURLSession dataTaskWithRequest:*]" # Objective-C method
|
|
39
|
-
frida-trace -U -p <pid> -j "com.example.App!login*" # Java method (Android)
|
|
40
|
-
frida-trace -f ./target -i "open" # spawn + trace from start
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Generated handler files land in `__handlers__/`. Each looks like:
|
|
44
|
-
|
|
45
|
-
```js
|
|
46
|
-
// __handlers__/libSystem.B.dylib/open.js
|
|
47
|
-
{
|
|
48
|
-
onEnter(log, args, state) {
|
|
49
|
-
// args[0] is the first argument (a pointer)
|
|
50
|
-
log(`open("${args[0].readUtf8String()}")`);
|
|
51
|
-
},
|
|
52
|
-
onLeave(log, retval, state) {
|
|
53
|
-
log(` => ${retval}`);
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
Edit that file, save, and `frida-trace` hot-reloads it. This is the fastest path from "I wonder what this function receives" to a concrete answer.
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## The JS agent API
|
|
63
|
-
|
|
64
|
-
When `frida-trace` isn't enough, you write a JS agent and load it with `frida` or from a Python host script. These are the building blocks.
|
|
65
|
-
|
|
66
|
-
### Find a function
|
|
67
|
-
|
|
68
|
-
```js
|
|
69
|
-
// By exported symbol name
|
|
70
|
-
const openPtr = Module.getExportByName(null, "open"); // null = any module
|
|
71
|
-
const sslWritePtr = Module.getExportByName("libssl.so", "SSL_write");
|
|
72
|
-
|
|
73
|
-
// By offset in a stripped binary (get the offset from Ghidra)
|
|
74
|
-
const base = Module.getBaseAddress("target");
|
|
75
|
-
const funcPtr = base.add(0x1a3c);
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Intercept calls
|
|
79
|
-
|
|
80
|
-
```js
|
|
81
|
-
Interceptor.attach(openPtr, {
|
|
82
|
-
onEnter(args) {
|
|
83
|
-
// args[0], args[1], ... are NativePointer objects
|
|
84
|
-
const path = args[0].readUtf8String();
|
|
85
|
-
const flags = args[1].toInt32();
|
|
86
|
-
send({ event: "open", path: path, flags: flags });
|
|
87
|
-
},
|
|
88
|
-
onLeave(retval) {
|
|
89
|
-
// retval is the return value as a NativePointer
|
|
90
|
-
send({ event: "open_ret", fd: retval.toInt32() });
|
|
91
|
-
}
|
|
92
|
-
});
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### Read memory
|
|
96
|
-
|
|
97
|
-
```js
|
|
98
|
-
args[0].readUtf8String() // read a UTF-8 C string from a pointer
|
|
99
|
-
args[0].readCString() // read a raw C string (stops at null)
|
|
100
|
-
args[1].readByteArray(len) // read len raw bytes (returns ArrayBuffer)
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### Replace / stub a function
|
|
104
|
-
|
|
105
|
-
```js
|
|
106
|
-
// Force a function to always return 0 (e.g. bypass a license check)
|
|
107
|
-
Interceptor.replace(checkLicensePtr, new NativeCallback(function () {
|
|
108
|
-
return 0;
|
|
109
|
-
}, 'int', []));
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Use `Interceptor.replace` sparingly. It changes program behavior, so always note in your journal that you patched something and why.
|
|
113
|
-
|
|
114
|
-
---
|
|
115
|
-
|
|
116
|
-
## Python host script
|
|
117
|
-
|
|
118
|
-
A host script lets you load a JS agent, receive `send()` messages, and post-process results from the Python side.
|
|
119
|
-
|
|
120
|
-
```python
|
|
121
|
-
import frida, sys
|
|
122
|
-
|
|
123
|
-
with open("agent.js") as f:
|
|
124
|
-
agent_source = f.read()
|
|
125
|
-
|
|
126
|
-
def on_message(message, data):
|
|
127
|
-
if message["type"] == "send":
|
|
128
|
-
print(f"[*] {message['payload']}")
|
|
129
|
-
else:
|
|
130
|
-
print(f"[!] {message}")
|
|
131
|
-
|
|
132
|
-
session = frida.attach(int(sys.argv[1]))
|
|
133
|
-
script = session.create_script(agent_source)
|
|
134
|
-
script.on("message", on_message)
|
|
135
|
-
script.load()
|
|
136
|
-
|
|
137
|
-
try:
|
|
138
|
-
sys.stdin.read() # block until Ctrl+C
|
|
139
|
-
except KeyboardInterrupt:
|
|
140
|
-
session.detach()
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
The agent runs inside the target; the host script stays in your terminal and prints structured output.
|
|
144
|
-
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
## Output-budget discipline
|
|
148
|
-
|
|
149
|
-
**Hooking a hot function (e.g. `malloc`, `read`) will flood your context with thousands of lines.** Don't print every call. Aggregate in the agent and report a summary.
|
|
150
|
-
|
|
151
|
-
```js
|
|
152
|
-
// Count calls, report every 1000
|
|
153
|
-
let callCount = 0;
|
|
154
|
-
Interceptor.attach(mallocPtr, {
|
|
155
|
-
onEnter(args) {
|
|
156
|
-
callCount++;
|
|
157
|
-
if (callCount % 1000 === 0) {
|
|
158
|
-
send({ event: "malloc_summary", total_calls: callCount });
|
|
159
|
-
}
|
|
160
|
-
}
|
|
161
|
-
});
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
Alternatives: filter by argument value, only log calls from a specific caller module, or batch into an array and `send()` on a timer.
|
|
165
|
-
|
|
166
|
-
---
|
|
167
|
-
|
|
168
|
-
## ⚠️ Gotchas
|
|
169
|
-
|
|
170
|
-
**Attach vs. spawn.** `frida -p <pid>` attaches to an already-running process. If you need to catch early initialization (constructors, `main` entry), spawn the process with `frida -f ./target`. Frida pauses it at startup. Resume with `%resume` in the REPL or by calling `device.resume(pid)` from Python.
|
|
171
|
-
|
|
172
|
-
**Stripped binaries have no symbol names.** `Module.getExportByName` returns null for internal functions. You must find the function offset in Ghidra, then compute the address at runtime:
|
|
173
|
-
|
|
174
|
-
```js
|
|
175
|
-
const addr = Module.getBaseAddress("target").add(0x4a20);
|
|
176
|
-
Interceptor.attach(addr, { /* ... */ });
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
**A crashing target kills your session.** If the target segfaults or aborts, Frida's agent dies with it. Script a respawn loop on the Python side if you expect crashes.
|
|
180
|
-
|
|
181
|
-
**Thread safety.** `onEnter`/`onLeave` fire on multiple threads. Keep shared state to simple counters.
|
|
182
|
-
|
|
183
|
-
---
|
|
184
|
-
|
|
185
|
-
## Cleanup
|
|
186
|
-
|
|
187
|
-
```bash
|
|
188
|
-
kill <pid> # kill any process you spawned with -f
|
|
189
|
-
rm -rf __handlers__/ # remove generated handler stubs
|
|
190
|
-
rm -f agent.js host.py # remove session-specific scripts
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
Always note in your journal which processes you attached to and whether you replaced any functions. A forgotten `Interceptor.replace` in a long-running target will cause confusing behavior later.
|
|
@@ -1,143 +0,0 @@
|
|
|
1
|
-
import { mkdtempSync, readFileSync, rmSync, statSync, writeFileSync } from "node:fs";
|
|
2
|
-
import { tmpdir } from "node:os";
|
|
3
|
-
import { join } from "node:path";
|
|
4
|
-
|
|
5
|
-
import { afterEach, describe, expect, it } from "bun:test";
|
|
6
|
-
|
|
7
|
-
import type { LspClient } from "./client.js";
|
|
8
|
-
import { formatDocumentWithClient } from "./format-document.js";
|
|
9
|
-
import type { TextEdit } from "./types.js";
|
|
10
|
-
|
|
11
|
-
const workspaces: string[] = [];
|
|
12
|
-
|
|
13
|
-
afterEach(() => {
|
|
14
|
-
for (const workspace of workspaces.splice(0)) rmSync(workspace, { recursive: true, force: true });
|
|
15
|
-
});
|
|
16
|
-
|
|
17
|
-
function workspaceWith(fileName: string, content: string): { readonly root: string; readonly filePath: string } {
|
|
18
|
-
const root = mkdtempSync(join(tmpdir(), "lsp-format-"));
|
|
19
|
-
workspaces.push(root);
|
|
20
|
-
const filePath = join(root, fileName);
|
|
21
|
-
writeFileSync(filePath, content, "utf-8");
|
|
22
|
-
return { root, filePath };
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
function stubClient(edits: TextEdit[] | null): LspClient {
|
|
26
|
-
return {
|
|
27
|
-
async formatDocument() {
|
|
28
|
-
return edits;
|
|
29
|
-
},
|
|
30
|
-
async openFile() {},
|
|
31
|
-
} as Pick<LspClient, "formatDocument" | "openFile"> as LspClient;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
describe("formatDocumentWithClient", () => {
|
|
35
|
-
it("#given a server returning text edits #when the document is formatted #then the file is rewritten and line deltas are reported", async () => {
|
|
36
|
-
// given
|
|
37
|
-
const { filePath } = workspaceWith("sample.ts", "const a=1\nconst b =2\nconst c=3\n");
|
|
38
|
-
const edits: TextEdit[] = [
|
|
39
|
-
{ range: { start: { line: 0, character: 0 }, end: { line: 1, character: 12 } }, newText: "const a = 1;\nconst b = 2;" },
|
|
40
|
-
];
|
|
41
|
-
|
|
42
|
-
// when
|
|
43
|
-
const result = await formatDocumentWithClient(stubClient(edits), filePath);
|
|
44
|
-
|
|
45
|
-
// then
|
|
46
|
-
expect(result.status).toBe("formatted");
|
|
47
|
-
expect(readFileSync(filePath, "utf-8")).toBe("const a = 1;\nconst b = 2;\nconst c=3\n");
|
|
48
|
-
expect(result).toMatchObject({ status: "formatted", linesAdded: 2, linesRemoved: 2 });
|
|
49
|
-
});
|
|
50
|
-
|
|
51
|
-
it("#given a server returning an edit that adds lines #when the document is formatted #then the added and removed line counts differ", async () => {
|
|
52
|
-
// given
|
|
53
|
-
const { filePath } = workspaceWith("sample.ts", "const a=1;const b=2\n");
|
|
54
|
-
const edits: TextEdit[] = [
|
|
55
|
-
{ range: { start: { line: 0, character: 0 }, end: { line: 0, character: 19 } }, newText: "const a = 1;\nconst b = 2;" },
|
|
56
|
-
];
|
|
57
|
-
|
|
58
|
-
// when
|
|
59
|
-
const result = await formatDocumentWithClient(stubClient(edits), filePath);
|
|
60
|
-
|
|
61
|
-
// then
|
|
62
|
-
expect(result).toMatchObject({ status: "formatted", linesAdded: 2, linesRemoved: 1 });
|
|
63
|
-
expect(readFileSync(filePath, "utf-8")).toBe("const a = 1;\nconst b = 2;\n");
|
|
64
|
-
});
|
|
65
|
-
|
|
66
|
-
it("#given a server that does not advertise document formatting #when the document is formatted #then the result is unavailable and the file bytes are untouched", async () => {
|
|
67
|
-
// given
|
|
68
|
-
const original = "const a=1\n";
|
|
69
|
-
const { filePath } = workspaceWith("sample.ts", original);
|
|
70
|
-
const before = statSync(filePath);
|
|
71
|
-
|
|
72
|
-
// when
|
|
73
|
-
const result = await formatDocumentWithClient(stubClient(null), filePath);
|
|
74
|
-
|
|
75
|
-
// then
|
|
76
|
-
expect(result).toEqual({ status: "unavailable", reason: "capability_not_advertised" });
|
|
77
|
-
expect(readFileSync(filePath)).toEqual(Buffer.from(original));
|
|
78
|
-
expect(statSync(filePath).mtimeMs).toBe(before.mtimeMs);
|
|
79
|
-
});
|
|
80
|
-
|
|
81
|
-
it("#given a server returning no edits #when the document is formatted #then the result is unchanged and the file bytes are untouched", async () => {
|
|
82
|
-
// given
|
|
83
|
-
const original = "const a = 1;\n";
|
|
84
|
-
const { filePath } = workspaceWith("sample.ts", original);
|
|
85
|
-
|
|
86
|
-
// when
|
|
87
|
-
const result = await formatDocumentWithClient(stubClient([]), filePath);
|
|
88
|
-
|
|
89
|
-
// then
|
|
90
|
-
expect(result).toEqual({ status: "unchanged", linesAdded: 0, linesRemoved: 0 });
|
|
91
|
-
expect(readFileSync(filePath)).toEqual(Buffer.from(original));
|
|
92
|
-
});
|
|
93
|
-
|
|
94
|
-
it("#given edits that reproduce the current bytes #when the document is formatted #then the result is unchanged", async () => {
|
|
95
|
-
// given
|
|
96
|
-
const original = "const a = 1;\n";
|
|
97
|
-
const { filePath } = workspaceWith("sample.ts", original);
|
|
98
|
-
const edits: TextEdit[] = [
|
|
99
|
-
{ range: { start: { line: 0, character: 0 }, end: { line: 0, character: 12 } }, newText: "const a = 1;" },
|
|
100
|
-
];
|
|
101
|
-
|
|
102
|
-
// when
|
|
103
|
-
const result = await formatDocumentWithClient(stubClient(edits), filePath);
|
|
104
|
-
|
|
105
|
-
// then
|
|
106
|
-
expect(result.status).toBe("unchanged");
|
|
107
|
-
expect(readFileSync(filePath, "utf-8")).toBe(original);
|
|
108
|
-
});
|
|
109
|
-
|
|
110
|
-
it("#given the file shrinks after the server computed its edits #when the edits are applied #then the stale edit is rejected instead of corrupting the file", async () => {
|
|
111
|
-
// given
|
|
112
|
-
const { filePath } = workspaceWith("sample.ts", "const a=1\nconst b=2\n");
|
|
113
|
-
const staleEdits: TextEdit[] = [
|
|
114
|
-
{ range: { start: { line: 1, character: 0 }, end: { line: 1, character: 9 } }, newText: "const b = 2;" },
|
|
115
|
-
];
|
|
116
|
-
const racingClient = {
|
|
117
|
-
async formatDocument() {
|
|
118
|
-
writeFileSync(filePath, "short\n", "utf-8");
|
|
119
|
-
return staleEdits;
|
|
120
|
-
},
|
|
121
|
-
async openFile() {},
|
|
122
|
-
} as Pick<LspClient, "formatDocument" | "openFile"> as LspClient;
|
|
123
|
-
|
|
124
|
-
// when / then
|
|
125
|
-
await expect(formatDocumentWithClient(racingClient, filePath)).rejects.toThrow(/outside line/);
|
|
126
|
-
expect(readFileSync(filePath, "utf-8")).toBe("short\n");
|
|
127
|
-
});
|
|
128
|
-
|
|
129
|
-
it("#given a formatted document #when the write completes #then no temporary file is left behind", async () => {
|
|
130
|
-
// given
|
|
131
|
-
const { root, filePath } = workspaceWith("sample.ts", "const a=1\n");
|
|
132
|
-
const edits: TextEdit[] = [
|
|
133
|
-
{ range: { start: { line: 0, character: 0 }, end: { line: 0, character: 9 } }, newText: "const a = 1;" },
|
|
134
|
-
];
|
|
135
|
-
|
|
136
|
-
// when
|
|
137
|
-
await formatDocumentWithClient(stubClient(edits), filePath);
|
|
138
|
-
|
|
139
|
-
// then
|
|
140
|
-
expect(readFileSync(filePath, "utf-8")).toBe("const a = 1;\n");
|
|
141
|
-
expect(() => statSync(join(root, "sample.ts.tmp"))).toThrow();
|
|
142
|
-
});
|
|
143
|
-
});
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
import { readFileSync, renameSync, unlinkSync, writeFileSync } from "node:fs";
|
|
2
|
-
|
|
3
|
-
import type { LspClient } from "./client.js";
|
|
4
|
-
import type { FormattingOptions, TextEdit } from "./types.js";
|
|
5
|
-
import { normalizeTextEdits } from "./workspace-edit-text.js";
|
|
6
|
-
|
|
7
|
-
export const DEFAULT_FORMATTING_OPTIONS: FormattingOptions = {
|
|
8
|
-
tabSize: 4,
|
|
9
|
-
insertSpaces: false,
|
|
10
|
-
trimTrailingWhitespace: true,
|
|
11
|
-
insertFinalNewline: true,
|
|
12
|
-
trimFinalNewlines: true,
|
|
13
|
-
};
|
|
14
|
-
|
|
15
|
-
export type FormatDocumentResult =
|
|
16
|
-
| { readonly status: "formatted"; readonly linesAdded: number; readonly linesRemoved: number }
|
|
17
|
-
| { readonly status: "unchanged"; readonly linesAdded: 0; readonly linesRemoved: 0 }
|
|
18
|
-
| { readonly status: "unavailable"; readonly reason: "capability_not_advertised" };
|
|
19
|
-
|
|
20
|
-
export interface FormatDocumentOptions {
|
|
21
|
-
readonly formattingOptions?: FormattingOptions;
|
|
22
|
-
readonly signal?: AbortSignal;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
const UNCHANGED: FormatDocumentResult = { status: "unchanged", linesAdded: 0, linesRemoved: 0 };
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Formats one document through the resident language server and commits the result to disk.
|
|
29
|
-
*
|
|
30
|
-
* The server is asked for whole-document edits rather than formatted text, so the edits are
|
|
31
|
-
* validated and applied with the same normalization the workspace-edit path uses. Nothing is
|
|
32
|
-
* written when the server declines the capability or when the edits reproduce the current bytes,
|
|
33
|
-
* which keeps a no-op format from touching file mtimes that downstream tooling watches.
|
|
34
|
-
*/
|
|
35
|
-
export async function formatDocumentWithClient(
|
|
36
|
-
client: LspClient,
|
|
37
|
-
filePath: string,
|
|
38
|
-
options: FormatDocumentOptions = {},
|
|
39
|
-
): Promise<FormatDocumentResult> {
|
|
40
|
-
const edits = await client.formatDocument(
|
|
41
|
-
filePath,
|
|
42
|
-
options.formattingOptions ?? DEFAULT_FORMATTING_OPTIONS,
|
|
43
|
-
options.signal,
|
|
44
|
-
);
|
|
45
|
-
if (edits === null) return { status: "unavailable", reason: "capability_not_advertised" };
|
|
46
|
-
if (edits.length === 0) return UNCHANGED;
|
|
47
|
-
|
|
48
|
-
const before = readFileSync(filePath, "utf-8");
|
|
49
|
-
const normalized = normalizeTextEdits(before, edits, 0);
|
|
50
|
-
if (normalized.text === before) return UNCHANGED;
|
|
51
|
-
|
|
52
|
-
writeAtomically(filePath, normalized.text);
|
|
53
|
-
await client.openFile(filePath);
|
|
54
|
-
|
|
55
|
-
return {
|
|
56
|
-
status: "formatted",
|
|
57
|
-
...lineDelta(normalized.edits),
|
|
58
|
-
};
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* Counts the lines each edit removes from the document and adds back in its place.
|
|
63
|
-
*
|
|
64
|
-
* Counting from the edits instead of diffing the whole file keeps the report proportional to what
|
|
65
|
-
* the server actually rewrote, so an unrelated line never shows up as churn.
|
|
66
|
-
*/
|
|
67
|
-
function lineDelta(edits: readonly TextEdit[]): { readonly linesAdded: number; readonly linesRemoved: number } {
|
|
68
|
-
let linesAdded = 0;
|
|
69
|
-
let linesRemoved = 0;
|
|
70
|
-
for (const edit of edits) {
|
|
71
|
-
linesRemoved += edit.range.end.line - edit.range.start.line + 1;
|
|
72
|
-
linesAdded += edit.newText.split("\n").length;
|
|
73
|
-
}
|
|
74
|
-
return { linesAdded, linesRemoved };
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
function writeAtomically(filePath: string, content: string): void {
|
|
78
|
-
const tempPath = `${filePath}.omo-format.tmp`;
|
|
79
|
-
writeFileSync(tempPath, content, "utf-8");
|
|
80
|
-
try {
|
|
81
|
-
renameSync(tempPath, filePath);
|
|
82
|
-
} catch (error) {
|
|
83
|
-
try {
|
|
84
|
-
unlinkSync(tempPath);
|
|
85
|
-
} catch {
|
|
86
|
-
// The rename failure is the actionable error; a leftover temp file must not mask it.
|
|
87
|
-
}
|
|
88
|
-
throw error;
|
|
89
|
-
}
|
|
90
|
-
}
|