Deprecate api endpoint

Author: AndreasArvidsson

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to the "vscode-parse-tree" extension will be documented in this file.
 
+## 0.51.0 (12 Mar 2026)
+
+Removed deprecated api endpoints:
+
+- `getLanguage` - Replaced by `createQuery`
+- `getTreeForUri` - Replaced by `getTree`
+- `getNodeAtLocation` - No direct replacement. Use scm queries and `createQuery` instead.
+- `registerLanguage` - No replacement. We don't believe anyone is using this.
+
 ## 0.33.0 (22 Apr 2025)
 
 ### Enhancements

README.md

@@ -1,6 +1,6 @@
 # Parse tree
 
-Exposes an api function that can be used to get a parse tree node for a given file location.
+Exposes an api function that can be used to get a parse tree for a given file.
 
 ## Usage
 
@@ -13,25 +13,13 @@ if (parseTreeExtension == null) {
   throw new Error("Depends on pokey.parse-tree extension");
 }
 
-const { getNodeAtLocation } = await parseTreeExtension.activate();
+const { loadLanguage } = await parseTreeExtension.activate();
 ```
 
 Don't forget to add an `extensionDependencies`-entry to `package.json` as
 described in
 https://code.visualstudio.com/api/references/vscode-api#extensions.
 
-### Parsing a custom language
-
-If you'd like to add support for a new language, see the [Adding a new language](#adding-a-new-language) section below. Alternatively, your extension can register a custom language with this extension. Although this is not the preferred way to add a new language, it can be convenient when you have a parser that you don't believe belongs in the main extension.
-
-Parsing your own language is as simple as registering your `languageId` with an absolute path to your `.wasm` file:
-
-```ts
-const { registerLanguage } = await parseTreeExtension.activate();
-
-registerLanguage(languageId, wasmPath);
-```
-
 ## Contributing
 
 ### Setup

package-lock.json

@@ -2,7 +2,7 @@
   "name": "parse-tree",
   "displayName": "Parse tree",
   "description": "Access document syntax using tree-sitter",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "publisher": "pokey",
   "repository": {
     "type": "git",

package.json

@@ -13,3 +13,10 @@ export class LanguageStillLoadingError extends Error {
     this.name = "LanguageStillLoadingError";
   }
 }
+
+export class DeprecatedError extends Error {
+  constructor(name: string) {
+    super(`${name} is deprecated and has been removed from the API`);
+    this.name = "DeprecatedError";
+  }
+}

src/errors.ts

@@ -4,7 +4,11 @@ import * as semver from "semver";
 import * as vscode from "vscode";
 import * as treeSitter from "web-tree-sitter";
 import { Edit } from "web-tree-sitter";
-import { LanguageStillLoadingError, UnsupportedLanguageError } from "./errors";
+import {
+  DeprecatedError,
+  LanguageStillLoadingError,
+  UnsupportedLanguageError,
+} from "./errors";
 
 interface Language {
   module: string;
@@ -294,15 +298,8 @@ export function activate(context: vscode.ExtensionContext) {
   return {
     loadLanguage,
 
-    /**
-     * @deprecated
-     */
-    getLanguage(languageId: string): treeSitter.Language | undefined {
-      console.warn(
-        "vscode-parse-tree: getLanguage is deprecated, use createQuery(languageId, source) instead.",
-      );
-      validateGetLanguage(languageId);
-      return languages[languageId]?.parser?.language ?? undefined;
+    getTree(document: vscode.TextDocument) {
+      return getTreeForUri(document.uri);
     },
 
     createQuery(
@@ -317,34 +314,17 @@ export function activate(context: vscode.ExtensionContext) {
       return new treeSitter.Query(language, source);
     },
 
-    /**
-     * Register a parser wasm file for a language not supported by this
-     * extension. Note that {@link wasmPath} must be an absolute path, and
-     * {@link languageId} must not already have a registered parser.
-     * @param languageId The VSCode language id that you'd like to register a
-     * parser for
-     * @param wasmPath The absolute path to the wasm file for your parser
-     */
-    registerLanguage(languageId: string, wasmPath: string) {
-      if (languages[languageId] != null) {
-        throw new Error(`Language id '${languageId}' is already registered`);
-      }
-
-      languages[languageId] = { module: wasmPath };
-      void colorAllOpen();
+    getLanguage(): treeSitter.Language | undefined {
+      throw new DeprecatedError("getLanguage");
     },
-
-    getTree(document: vscode.TextDocument) {
-      return getTreeForUri(document.uri);
+    getTreeForUri() {
+      throw new DeprecatedError("getTreeForUri");
     },
-
-    getTreeForUri,
-
-    getNodeAtLocation(location: vscode.Location) {
-      return getTreeForUri(location.uri).rootNode.descendantForPosition({
-        row: location.range.start.line,
-        column: location.range.start.character,
-      });
+    getNodeAtLocation() {
+      throw new DeprecatedError("getNodeAtLocation");
+    },
+    registerLanguage() {
+      throw new DeprecatedError("registerLanguage");
     },
   };
 }