chore: collapse Skulpt and Pyodide adapters into one

It's evident with testing so far that a separate adapter for each is not needed; they produce error messages / traces in the same format (currently).

Author: grega

README.md

@@ -21,16 +21,17 @@ It can be used in browser-based editors (like RPF's [Code Editor web component](
 import {
   loadCopydeckFor,
   registerAdapter,
-  skulptAdapter,
-  pyodideAdapter,
+  cpythonAdapter,
   friendlyExplain
 } from "python-friendly-error-messages";
 
 await loadCopydeckFor(navigator.language); // falls back to "en"
 
-// register runtimes
-registerAdapter("skulpt", skulptAdapter);
-registerAdapter("pyodide", pyodideAdapter);
+// register runtimes - Skulpt and Pyodide both appear to emit CPython-style tracebacks,
+// so the same adapter handles both. The runtime name you register under is
+// added onto the resulting trace
+registerAdapter("skulpt", cpythonAdapter);
+registerAdapter("pyodide", cpythonAdapter);
 
 // later, when you have an error string and some code:
 const result = friendlyExplain({

docs/index.html

@@ -57,7 +57,7 @@ <h1>Python Friendly Error Messages - Demo</h1>
       : './vendor/python-friendly-error-messages/index.browser.js';
     const libPath = cacheBust ? `${libPathBase}?cb=${encodeURIComponent(cacheBust)}` : libPathBase;
 
-    const { friendlyExplain, loadCopydeckFor, skulptAdapter, pyodideAdapter } = await import(libPath);
+    const { friendlyExplain, loadCopydeckFor, cpythonAdapter } = await import(libPath);
 
     async function initDemo() {
       const container = document.getElementById('demo-container');
@@ -97,8 +97,8 @@ <h1>Python Friendly Error Messages - Demo</h1>
         await loadCopydeckFor('en');
 
         const adaptersByRuntime = {
-          skulpt: skulptAdapter,
-          pyodide: pyodideAdapter
+          skulpt: cpythonAdapter,
+          pyodide: cpythonAdapter
         };
 
         const processedExamples = examples.map((example) => {

src/adapters/skulpt.ts src/adapters/cpython.tssrc/adapters/skulpt.ts renamed to src/adapters/cpython.ts

@@ -7,7 +7,18 @@ const lastLineTypeMessage = (raw: string) => {
   return { type: m ? m[1] : null, message: m ? m[2] : tail, tail, lines };
 };
 
-export const skulptAdapter: AdapterFn = (raw, code) => {
+/**
+ * Parses a CPython-shaped traceback (`File "...", line N`).
+ *
+ * Skulpt and Pyodide both emit this format, so a single adapter covers both.
+ * There is no current need for runtime-specific parsing . The `runtime` label on
+ * the returned trace is left as "unknown"; the engine adds the concrete runtime
+ * (the registration key it dispatched on) in `coerceTrace`. If the two runtimes
+ * ever diverge (e.g CPython 3.11+ caret ranges or "Did you mean?" hints that
+ * Pyodide surfaces but Skulpt does not), branch here on a passed-in runtime
+ * hint to parse those features out of the message
+ */
+export const cpythonAdapter: AdapterFn = (raw, code) => {
   const { type, message, tail, lines } = lastLineTypeMessage(raw);
   let file: string | undefined, line: number | undefined, col: number | undefined;
 
@@ -17,6 +28,8 @@ export const skulptAdapter: AdapterFn = (raw, code) => {
       file = mm[1];
       line = parseInt(mm[2], 10);
     }
+    const cc = L.match(/column\s+(\d+)/i);
+    if (cc) col = parseInt(cc[1], 10);
   }
   if (!line) {
     const loc = tail.match(/\b(?:on|at)\s+line\s+(\d+)\s+(?:of|in)\s+([^\s:]+)\b/i);
@@ -38,7 +51,7 @@ export const skulptAdapter: AdapterFn = (raw, code) => {
   // - name: quoted symbol from the message (helpful for NameError/KeyError/etc.)
   //
   // If none are present, the input is not parseable enough for this adapter,
-  // so we return null and let the caller handle that failure explicitly.
+  // so we return null and let the caller handle that failure explicitly
   const hasStructuredSignal = Boolean(type || line || name);
   if (!hasStructuredSignal) return null;
 
@@ -51,7 +64,7 @@ export const skulptAdapter: AdapterFn = (raw, code) => {
     col,
     frames: [],
     name,
-    runtime: "skulpt"
+    runtime: "unknown"
   };
 
   if (code && line) {

src/adapters/pyodide.ts

@@ -1,4 +1,4 @@
-import type { CopyDeck, ExplainOptions, ExplainResult, Section, Trace } from "./types";
+import type { CopyDeck, ExplainOptions, ExplainResult, Runtime, Section, Trace } from "./types";
 import { escapeHtml, safeRegexTest, tmpl } from "./utils";
 
 type InternalState = {
@@ -34,6 +34,9 @@ const coerceTrace = (input: string | Error | Trace, code?: string, runtime?: str
   if (!parsed) {
     throw new Error(`Could not parse error for runtime \"${runtime}\".`);
   }
+  // The runtime-agnostic adapter leaves `runtime: "unknown"`; this adds the concrete
+  // runtime we dispatched on so the trace carries the correct label
+  parsed.runtime = runtime as Runtime;
   return parsed;
 };
 

src/engine.ts

@@ -1,6 +1,5 @@
 export type { Trace, ExplainOptions, ExplainResult, CopyDeck, AdapterFn } from "./types.js";
 export { loadCopydeck, registerAdapter, friendlyExplain } from "./engine.js";
-export { skulptAdapter } from "./adapters/skulpt.js";
-export { pyodideAdapter } from "./adapters/pyodide.js";
+export { cpythonAdapter } from "./adapters/cpython.js";
 export { loadCopydeckFor } from "./loaders.browser.js";
 

src/index.browser.ts

@@ -1,5 +1,4 @@
 export type { Trace, ExplainOptions, ExplainResult, CopyDeck, AdapterFn } from "./types.js";
 export { loadCopydeck, registerAdapter, friendlyExplain } from "./engine.js";
-export { skulptAdapter } from "./adapters/skulpt.js";
-export { pyodideAdapter } from "./adapters/pyodide.js";
+export { cpythonAdapter } from "./adapters/cpython.js";
 export { loadCopydeckFor } from "./loaders.js";

src/index.ts

@@ -1,7 +1,6 @@
 import { describe, it, expect, beforeAll } from "vitest";
 import { friendlyExplain, loadCopydeck, registerAdapter } from "../src/engine";
-import { skulptAdapter } from "../src/adapters/skulpt";
-import { pyodideAdapter } from "../src/adapters/pyodide";
+import { cpythonAdapter } from "../src/adapters/cpython";
 import copydeck from "../copydecks/en/copydeck.json";
 import { examples } from "../docs/demo-examples.js";
 
@@ -14,15 +13,15 @@ type DemoExample = {
 };
 
 const adaptersByRuntime = {
-  skulpt: skulptAdapter,
-  pyodide: pyodideAdapter,
+  skulpt: cpythonAdapter,
+  pyodide: cpythonAdapter,
 };
 
 describe("copydeck/demo coverage", () => {
   beforeAll(() => {
     loadCopydeck(copydeck as any);
-    registerAdapter("skulpt", skulptAdapter);
-    registerAdapter("pyodide", pyodideAdapter);
+    registerAdapter("skulpt", cpythonAdapter);
+    registerAdapter("pyodide", cpythonAdapter);
   });
 
   it("maps each demo example to its expected variant", () => {

tests/copydeck-demo-coverage.test.ts

@@ -1,6 +1,6 @@
 import { describe, it, expect } from "vitest";
 import { friendlyExplain, loadCopydeck, registerAdapter } from "../src/engine";
-import { skulptAdapter } from "../src/adapters/skulpt";
+import { cpythonAdapter } from "../src/adapters/cpython";
 
 const copydeck = {
   meta: { language: "en", version: 1 },
@@ -62,7 +62,7 @@ const copydeck = {
 
 describe("engine", () => {
   loadCopydeck(copydeck as any);
-  registerAdapter("skulpt", skulptAdapter);
+  registerAdapter("skulpt", cpythonAdapter);
 
   it("explains NameError with name and patch", () => {
     const code = `print("Hello")\nprint(kittens)\n`;

tests/engine.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect, vi, beforeEach } from "vitest";
 import { loadCopydeckFor } from "../src/loaders";
 import { friendlyExplain, loadCopydeck, registerAdapter } from "../src/engine";
-import { skulptAdapter } from "../src/adapters/skulpt";
+import { cpythonAdapter } from "../src/adapters/cpython";
 
 const makeRes = (ok: boolean, data?: any) =>
   new Response(ok ? JSON.stringify(data) : "not found", { status: ok ? 200 : 404 });
@@ -23,7 +23,7 @@ describe("loadCopydeckFor", () => {
       .mockResolvedValueOnce(makeRes(true, minimalDeck)); // /copydecks/en/copydeck.json
 
     await loadCopydeckFor("en-GB");
-    registerAdapter("skulpt", skulptAdapter);
+    registerAdapter("skulpt", cpythonAdapter);
 
     const res = friendlyExplain({
       error: { type: "TypeError", message: "bad", raw: "TypeError: bad", runtime: "unknown" },
@@ -43,7 +43,7 @@ describe("loadCopydeckFor", () => {
 
   it("still supports manual loadCopydeck for tests without fetch", () => {
     loadCopydeck(minimalDeck as any);
-    registerAdapter("skulpt", skulptAdapter);
+    registerAdapter("skulpt", cpythonAdapter);
     const res = friendlyExplain({
       error: { type: "NameError", message: "name 'x' is not defined", raw: "NameError: name 'x' is not defined", runtime: "unknown" },
       code: ""