@backtickjs/language-plugin 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jean-François Bisson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,23 @@
-# Temporary Holding Version
+# @backtickjs/language-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The [Volar](https://volarjs.dev) language plugin that shows TypeScript what a [Backtick](https://backtickjs.com) client script means.
+
+## Internal
+
+You don't install this package directly. It is used by [`@backtickjs/tsc`](https://github.com/backtickjs/backtick/tree/main/packages/tsc) (`backtick-tsc`), [`@backtickjs/language-service`](https://github.com/backtickjs/backtick/tree/main/packages/language-service), [`@backtickjs/typescript-plugin`](https://github.com/backtickjs/backtick/tree/main/packages/typescript-plugin) and [`@backtickjs/language-server`](https://github.com/backtickjs/backtick/tree/main/packages/language-server).
+
+## What it does
+
+For every `.ts`, `.tsx`, `.js` and `.jsx` file (declaration files excepted), it runs the compiler's `virtualize` and hands TypeScript the result: a virtual copy of the file in which each `` cs`…` `` script is real code, with its splices typed against the host values they refer to. Source mappings tie the virtual code back to the original file, so errors, hovers, completions and go-to-definition land on the script you wrote. It also keeps Backtick's own compiler diagnostics, such as unsupported syntax in a script, for [`@backtickjs/language-service`](https://github.com/backtickjs/backtick/tree/main/packages/language-service) to report.
+
+The package exports `getBacktickLanguagePlugin(ts, getFileName)` and the `BacktickVirtualCode` class.
+
+## Related
+
+- [`@backtickjs/compiler`](https://github.com/backtickjs/backtick/tree/main/packages/compiler): produces the virtual code
+- [Backtick for VS Code](https://marketplace.visualstudio.com/items?itemName=backtickjs.backtick-vscode)
+- [Documentation](https://backtickjs.com/docs)
+
+## License
+
+MIT

package/dist/BacktickVirtualCode.d.ts

@@ -0,0 +1,12 @@
+import type { Diagnostic } from "@backtickjs/compiler";
+import type { CodeMapping, VirtualCode } from "@volar/language-core";
+import type ts from "typescript";
+export declare class BacktickVirtualCode implements VirtualCode {
+    id: string;
+    languageId: string;
+    mappings: CodeMapping[];
+    snapshot: ts.IScriptSnapshot;
+    embeddedCodes: VirtualCode[];
+    diagnostics: Diagnostic[];
+    constructor(ts: typeof import("typescript"), fileName: string, languageId: string, snapshot: ts.IScriptSnapshot);
+}

package/dist/BacktickVirtualCode.js

@@ -0,0 +1,51 @@
+import { virtualize } from "@backtickjs/compiler";
+export class BacktickVirtualCode {
+    id = "backtick-source";
+    languageId;
+    mappings;
+    snapshot;
+    embeddedCodes;
+    diagnostics;
+    constructor(ts, fileName, languageId, snapshot) {
+        const sourceText = snapshot.getText(0, snapshot.getLength());
+        const { virtualCode, mappings, diagnostics } = virtualize(ts, fileName, sourceText);
+        this.languageId = languageId;
+        this.diagnostics = diagnostics;
+        this.snapshot = snapshot;
+        this.mappings = [
+            {
+                sourceOffsets: [0],
+                generatedOffsets: [0],
+                lengths: [sourceText.length],
+                data: { format: false, verification: true },
+            },
+        ];
+        this.embeddedCodes = [
+            {
+                id: "backtick-virtual",
+                languageId,
+                snapshot: {
+                    getText: (start, end) => virtualCode.substring(start, end),
+                    getLength: () => virtualCode.length,
+                    getChangeRange: () => undefined,
+                },
+                mappings: mappings.map((mapping) => ({
+                    ...mapping,
+                    // The compiler's own flags (e.g. `semantic: false` on a
+                    // `cs.splice(...)` wrapper, so hover doesn't resolve through it)
+                    // override the defaults.
+                    data: {
+                        completion: true,
+                        format: false,
+                        navigation: true,
+                        semantic: true,
+                        structure: true,
+                        verification: true,
+                        ...mapping.data,
+                    },
+                })),
+            },
+        ];
+    }
+}
+//# sourceMappingURL=BacktickVirtualCode.js.map

package/dist/BacktickVirtualCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BacktickVirtualCode.js","sourceRoot":"","sources":["../src/BacktickVirtualCode.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAIlD,MAAM,OAAO,mBAAmB;IAC9B,EAAE,GAAG,iBAAiB,CAAC;IACvB,UAAU,CAAS;IACnB,QAAQ,CAAgB;IACxB,QAAQ,CAAqB;IAC7B,aAAa,CAAgB;IAC7B,WAAW,CAAe;IAE1B,YACE,EAA+B,EAC/B,QAAgB,EAChB,UAAkB,EAClB,QAA4B;QAE5B,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7D,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,UAAU,CACvD,EAAE,EACF,QAAQ,EACR,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAE/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG;YACd;gBACE,aAAa,EAAE,CAAC,CAAC,CAAC;gBAClB,gBAAgB,EAAE,CAAC,CAAC,CAAC;gBACrB,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;gBAC5B,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE;aAC5C;SACF,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG;YACnB;gBACE,EAAE,EAAE,kBAAkB;gBACtB,UAAU;gBACV,QAAQ,EAAE;oBACR,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;oBAC1D,SAAS,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM;oBACnC,cAAc,EAAE,GAAG,EAAE,CAAC,SAAS;iBAChC;gBACD,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACnC,GAAG,OAAO;oBACV,wDAAwD;oBACxD,iEAAiE;oBACjE,yBAAyB;oBACzB,IAAI,EAAE;wBACJ,UAAU,EAAE,IAAI;wBAChB,MAAM,EAAE,KAAK;wBACb,UAAU,EAAE,IAAI;wBAChB,QAAQ,EAAE,IAAI;wBACd,SAAS,EAAE,IAAI;wBACf,YAAY,EAAE,IAAI;wBAClB,GAAG,OAAO,CAAC,IAAI;qBAChB;iBACF,CAAC,CAAC;aACJ;SACF,CAAC;IACJ,CAAC;CACF"}

package/dist/getBacktickLanguagePlugin.d.ts

@@ -0,0 +1,3 @@
+import type { LanguagePlugin } from "@volar/language-core";
+import { BacktickVirtualCode } from "./BacktickVirtualCode.js";
+export declare function getBacktickLanguagePlugin<T>(ts: typeof import("typescript"), getFileName: (uri: T) => string): LanguagePlugin<T, BacktickVirtualCode>;

package/dist/getBacktickLanguagePlugin.js

@@ -0,0 +1,63 @@
+import { BacktickVirtualCode } from "./BacktickVirtualCode.js";
+export function getBacktickLanguagePlugin(ts, getFileName) {
+    return {
+        getLanguageId() {
+            // Keep as-is
+        },
+        createVirtualCode(uri, languageId, snapshot) {
+            switch (languageId) {
+                case "javascript":
+                case "javascriptreact":
+                case "typescript":
+                case "typescriptreact": {
+                    const fileName = getFileName(uri);
+                    if (fileName.endsWith(".d.ts")) {
+                        return;
+                    }
+                    return new BacktickVirtualCode(ts, fileName, languageId, snapshot);
+                }
+                default:
+                    return;
+            }
+        },
+        typescript: {
+            extraFileExtensions: [],
+            getServiceScript(root) {
+                // TypeScript reads the compiled embedded code, not the source root.
+                const code = root.embeddedCodes?.[0];
+                if (!code) {
+                    return;
+                }
+                switch (root.languageId) {
+                    case "javascript":
+                        return {
+                            code,
+                            extension: ".js",
+                            scriptKind: 1,
+                        };
+                    case "javascriptreact":
+                        return {
+                            code,
+                            extension: ".jsx",
+                            scriptKind: 2,
+                        };
+                    case "typescript":
+                        return {
+                            code,
+                            extension: ".ts",
+                            scriptKind: 3,
+                        };
+                    case "typescriptreact":
+                        return {
+                            code,
+                            extension: ".tsx",
+                            scriptKind: 4,
+                        };
+                    default:
+                        return;
+                }
+            },
+        },
+    };
+}
+//# sourceMappingURL=getBacktickLanguagePlugin.js.map

package/dist/getBacktickLanguagePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBacktickLanguagePlugin.js","sourceRoot":"","sources":["../src/getBacktickLanguagePlugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,MAAM,UAAU,yBAAyB,CACvC,EAA+B,EAC/B,WAA+B;IAE/B,OAAO;QACL,aAAa;YACX,aAAa;QACf,CAAC;QACD,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ;YACzC,QAAQ,UAAU,EAAE,CAAC;gBACnB,KAAK,YAAY,CAAC;gBAClB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,YAAY,CAAC;gBAClB,KAAK,iBAAiB,CAAC,CAAC,CAAC;oBACvB,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;oBAClC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;wBAC/B,OAAO;oBACT,CAAC;oBACD,OAAO,IAAI,mBAAmB,CAAC,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;gBACrE,CAAC;gBACD;oBACE,OAAO;YACX,CAAC;QACH,CAAC;QACD,UAAU,EAAE;YACV,mBAAmB,EAAE,EAAE;YACvB,gBAAgB,CAAC,IAAI;gBACnB,oEAAoE;gBACpE,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,OAAO;gBACT,CAAC;gBACD,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;oBACxB,KAAK,YAAY;wBACf,OAAO;4BACL,IAAI;4BACJ,SAAS,EAAE,KAAK;4BAChB,UAAU,EAAE,CAA4B;yBACzC,CAAC;oBACJ,KAAK,iBAAiB;wBACpB,OAAO;4BACL,IAAI;4BACJ,SAAS,EAAE,MAAM;4BACjB,UAAU,EAAE,CAA6B;yBAC1C,CAAC;oBACJ,KAAK,YAAY;wBACf,OAAO;4BACL,IAAI;4BACJ,SAAS,EAAE,KAAK;4BAChB,UAAU,EAAE,CAA4B;yBACzC,CAAC;oBACJ,KAAK,iBAAiB;wBACpB,OAAO;4BACL,IAAI;4BACJ,SAAS,EAAE,MAAM;4BACjB,UAAU,EAAE,CAA6B;yBAC1C,CAAC;oBACJ;wBACE,OAAO;gBACX,CAAC;YACH,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { BacktickVirtualCode } from "./BacktickVirtualCode.js";
+export { getBacktickLanguagePlugin } from "./getBacktickLanguagePlugin.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { BacktickVirtualCode } from "./BacktickVirtualCode.js";
+export { getBacktickLanguagePlugin } from "./getBacktickLanguagePlugin.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC"}

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@backtickjs/language-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "Internal: the Volar language plugin that shows TypeScript what a Backtick client script means",
+  "keywords": [
+    "backtick",
+    "react-native",
+    "server-driven-ui",
+    "server-components",
+    "volar",
+    "typescript",
+    "language-tools"
+  ],
+  "homepage": "https://backtickjs.com",
+  "bugs": {
+    "url": "https://github.com/backtickjs/backtick/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/backtickjs/backtick.git",
+    "directory": "packages/language-plugin"
+  },
+  "license": "MIT",
+  "author": "Jean-François Bisson <jf@backtickjs.com>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/._cache",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@volar/language-core": "^2.4.28",
+    "@backtickjs/compiler": "0.1.1"
+  },
+  "devDependencies": {
+    "@volar/typescript": "^2.4.28",
+    "prettier": "^3.6.2",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "typescript": "^6.0.3"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "tsc -b --watch",
+    "format": "prettier --write --ignore-unknown .",
+    "format:check": "prettier --check --ignore-unknown .",
+    "clean": "rm -rf node_modules dist .turbo"
+  }
 }

package/src/BacktickVirtualCode.ts

@@ -0,0 +1,67 @@
+import type { Diagnostic } from "@backtickjs/compiler";
+import { virtualize } from "@backtickjs/compiler";
+import type { CodeMapping, VirtualCode } from "@volar/language-core";
+import type ts from "typescript";
+
+export class BacktickVirtualCode implements VirtualCode {
+  id = "backtick-source";
+  languageId: string;
+  mappings: CodeMapping[];
+  snapshot: ts.IScriptSnapshot;
+  embeddedCodes: VirtualCode[];
+  diagnostics: Diagnostic[];
+
+  constructor(
+    ts: typeof import("typescript"),
+    fileName: string,
+    languageId: string,
+    snapshot: ts.IScriptSnapshot,
+  ) {
+    const sourceText = snapshot.getText(0, snapshot.getLength());
+    const { virtualCode, mappings, diagnostics } = virtualize(
+      ts,
+      fileName,
+      sourceText,
+    );
+
+    this.languageId = languageId;
+    this.diagnostics = diagnostics;
+
+    this.snapshot = snapshot;
+    this.mappings = [
+      {
+        sourceOffsets: [0],
+        generatedOffsets: [0],
+        lengths: [sourceText.length],
+        data: { format: false, verification: true },
+      },
+    ];
+
+    this.embeddedCodes = [
+      {
+        id: "backtick-virtual",
+        languageId,
+        snapshot: {
+          getText: (start, end) => virtualCode.substring(start, end),
+          getLength: () => virtualCode.length,
+          getChangeRange: () => undefined,
+        },
+        mappings: mappings.map((mapping) => ({
+          ...mapping,
+          // The compiler's own flags (e.g. `semantic: false` on a
+          // `cs.splice(...)` wrapper, so hover doesn't resolve through it)
+          // override the defaults.
+          data: {
+            completion: true,
+            format: false,
+            navigation: true,
+            semantic: true,
+            structure: true,
+            verification: true,
+            ...mapping.data,
+          },
+        })),
+      },
+    ];
+  }
+}

package/src/getBacktickLanguagePlugin.ts

@@ -0,0 +1,69 @@
+/// <reference types="@volar/typescript" />
+import type { LanguagePlugin } from "@volar/language-core";
+import type ts from "typescript";
+import { BacktickVirtualCode } from "./BacktickVirtualCode.js";
+
+export function getBacktickLanguagePlugin<T>(
+  ts: typeof import("typescript"),
+  getFileName: (uri: T) => string,
+): LanguagePlugin<T, BacktickVirtualCode> {
+  return {
+    getLanguageId() {
+      // Keep as-is
+    },
+    createVirtualCode(uri, languageId, snapshot) {
+      switch (languageId) {
+        case "javascript":
+        case "javascriptreact":
+        case "typescript":
+        case "typescriptreact": {
+          const fileName = getFileName(uri);
+          if (fileName.endsWith(".d.ts")) {
+            return;
+          }
+          return new BacktickVirtualCode(ts, fileName, languageId, snapshot);
+        }
+        default:
+          return;
+      }
+    },
+    typescript: {
+      extraFileExtensions: [],
+      getServiceScript(root) {
+        // TypeScript reads the compiled embedded code, not the source root.
+        const code = root.embeddedCodes?.[0];
+        if (!code) {
+          return;
+        }
+        switch (root.languageId) {
+          case "javascript":
+            return {
+              code,
+              extension: ".js",
+              scriptKind: 1 satisfies ts.ScriptKind.JS,
+            };
+          case "javascriptreact":
+            return {
+              code,
+              extension: ".jsx",
+              scriptKind: 2 satisfies ts.ScriptKind.JSX,
+            };
+          case "typescript":
+            return {
+              code,
+              extension: ".ts",
+              scriptKind: 3 satisfies ts.ScriptKind.TS,
+            };
+          case "typescriptreact":
+            return {
+              code,
+              extension: ".tsx",
+              scriptKind: 4 satisfies ts.ScriptKind.TSX,
+            };
+          default:
+            return;
+        }
+      },
+    },
+  };
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { BacktickVirtualCode } from "./BacktickVirtualCode.js";
+export { getBacktickLanguagePlugin } from "./getBacktickLanguagePlugin.js";