ts-wasms 1.1.0 → 3.0.0

package/README.md

@@ -1,16 +1,36 @@
-# ts-wasms
-Prebuilt WASM binaries for tree-sitter's language parsers.
-You can find a list of supported packages [here](https://app.unpkg.com/ts-wasms/files/out)
+# ts-wasms [![npm version](https://img.shields.io/npm/v/ts-wasms.svg?style=flat-square)](https://www.npmjs.com/package/ts-wasms)
+Prebuilt WASM binaries and query files(`.scm`) for tree-sitter's language parsers.
+You can find a list of supported languages [here](https://app.unpkg.com/ts-wasms/files/out)
 
 ## Installation
 ```bash
+npm install ts-wasms
+# or
 pnpm add ts-wasms
+# or
+yarn add ts-wasms
+# or
+bun install ts-wasms
 ```
 
 ## Usage
-```ts
-import pythonWasm from "ts-wasms/out/python/tree-sitter-python.wasm"
-import pythonHighlights from "ts-wasms/out/python/highlights.scm"
+A type-safe API is provided for accessing grammars and queries at runtime
+```typescript
+import { getWasmPath, getQueryPath } from "ts-wasms";
+
+const wasmPath = getWasmPath("python");
+const queryPath = getQueryPath("python", "highlights");
+const pythonQueries = getAvailableQueries("python");
+```
+
+You can also import the assets directly via your bundler
+```typescript
+import wasmUrl from "ts-wasms/python/tree-sitter-python.wasm?url";
+import wasmHighlights from "ts-wasms/python/highlights.scm?raw";
+
+// This JSON object acts as table of content for all available languages
+// and their queries.
+import manifest from "ts-wasms/manifest.json"
 ```
 
 Each language directory includes a `tree-sitter-<lang>.wasm` file but may also include:
@@ -20,14 +40,18 @@ Each language directory includes a `tree-sitter-<lang>.wasm` file but may also i
 - `tags.scm`
 - `folds.scm`
 - `indents.scm`
+Certain languages also contain special queries like: `nova-symbols`, please refer to the manifest.json or to the out dir in unpkg. 
 
 ```txt
-out/python/
+python/
 ├── tree-sitter-python.wasm
 ├── highlights.scm
 └── tags.scm
 ```
 
+
 ## Licenses
-Licenses belong to their respective upstream grammar authors, however this repo is MIT licensed.
-(If you have a problem with this licensing, please open an issue.)
+The licenses for the generated .wasm and .scm files belong to their respective upstream grammar authors and can be found on their github repos.
+
+The code in this repository is licensed under MIT.
+If you maintain an upstream grammar and have a problem with this licensing, please open an issue.

package/index.d.ts

@@ -0,0 +1,116 @@
+/** Standard Tree-sitter query categories mapped per language */
+export type QueryMap = {
+    "ada": "folds" | "highlights" | "injections" | "locals" | "textobjects";
+    "angular": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "arduino": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "asm": "highlights" | "injections";
+    "astro": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "awk": "highlights" | "injections";
+    "bash": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "bibtex": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "c": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "c_sharp_c_sharp": "highlights" | "tags";
+    "cairo": "folds" | "highlights" | "indents" | "injections" | "locals" | "textobjects";
+    "clojure": "folds" | "highlights" | "injections" | "locals";
+    "cmake": "folds" | "highlights" | "indents" | "injections";
+    "comment": "highlights";
+    "commonlisp": "folds" | "highlights" | "injections" | "locals" | "tags";
+    "cpp": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "css": "folds" | "highlights" | "indents" | "injections";
+    "csv": "highlights";
+    "cuda": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "d": "folds" | "helix-highlights" | "helix-indents" | "helix-injections" | "helix-textobjects" | "highlights" | "indents" | "injections" | "locals" | "nova-folds" | "nova-highlights" | "nova-symbols" | "tags" | "textobjects";
+    "dart": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "desktop": "folds" | "highlights" | "injections";
+    "devicetree": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "diff": "folds" | "highlights" | "injections";
+    "dockerfile": "highlights" | "injections";
+    "dtd": "folds" | "highlights" | "injections" | "locals";
+    "editorconfig": "folds" | "highlights" | "injections";
+    "elisp": "highlights" | "tags";
+    "elixir": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "elm": "folds" | "highlights" | "injections" | "locals" | "tags";
+    "embedded_template_embedded_template": "highlights" | "injections-ejs" | "injections-erb" | "injections-etlua";
+    "erlang": "folds" | "highlights" | "injections";
+    "fish": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "gdscript": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "gdshader": "highlights" | "injections" | "locals" | "tags";
+    "git_config": "folds" | "highlights" | "injections";
+    "git_rebase": "highlights" | "injections";
+    "gitattributes": "highlights" | "injections" | "locals";
+    "gitignore": "highlights" | "injections";
+    "gleam": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "glsl": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "go": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "godot_resource": "folds" | "highlights" | "injections" | "locals";
+    "graphql": "highlights" | "indents" | "injections";
+    "groovy": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "haskell": "folds" | "highlights" | "injections" | "locals";
+    "hcl": "folds" | "highlights" | "indents" | "injections";
+    "html": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "ini": "folds" | "highlights" | "injections";
+    "java": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "javascript": "folds" | "highlights" | "highlights-jsx" | "highlights-params" | "indents" | "injections" | "locals" | "tags";
+    "json": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "julia": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "kdl": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "kotlin": "folds" | "highlights" | "injections" | "locals";
+    "liquid": "highlights" | "injections";
+    "lua": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "markdown": "folds" | "highlights" | "indents" | "injections";
+    "markdown_inline": "highlights" | "injections";
+    "matlab": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "nim": "folds" | "highlights" | "injections" | "locals";
+    "nix": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "objc": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "ocaml": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "ocaml_interface": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "ocaml_type": "highlights" | "locals" | "tags";
+    "perl": "folds" | "highlights" | "injections" | "matchup";
+    "php": "folds" | "highlights" | "indents" | "injections" | "injections-text" | "locals" | "tags";
+    "php_only": "folds" | "highlights" | "indents" | "injections" | "injections-text" | "locals" | "tags";
+    "prisma": "folds" | "highlights" | "injections";
+    "psv": "highlights";
+    "python": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "qmljs": "folds" | "highlights" | "injections" | "locals";
+    "query": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "r": "highlights" | "indents" | "injections" | "locals" | "tags";
+    "racket": "folds" | "highlights" | "injections" | "locals" | "tags";
+    "regex": "highlights";
+    "ruby": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "rust": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "scala": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "scheme": "folds" | "highlights" | "injections";
+    "scss": "folds" | "highlights" | "indents" | "injections";
+    "solidity": "folds" | "highlights" | "highlights-nvim" | "injections" | "locals" | "tags";
+    "sql": "folds" | "highlights" | "indents" | "injections";
+    "swift": "folds" | "highlights" | "indents" | "injections" | "locals" | "outline" | "tags" | "textobjects";
+    "terraform": "folds" | "highlights" | "indents" | "injections";
+    "toml": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "tsv": "highlights";
+    "tsx": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "typescript": "folds" | "highlights" | "indents" | "injections" | "locals" | "tags";
+    "vim": "folds" | "highlights" | "injections" | "locals";
+    "vimdoc": "highlights" | "injections";
+    "vue": "folds" | "highlights" | "indents" | "injections";
+    "xml": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "yaml": "folds" | "highlights" | "indents" | "injections" | "locals";
+    "zig": "folds" | "highlights" | "indents" | "injections" | "locals";
+};
+
+/** Supported language identifiers compiled during build step */
+export type SupportedLanguage = keyof QueryMap;
+
+/** Resolves the absolute path to a specific language's WASM file. */
+export declare function getWasmPath(lang: SupportedLanguage): string;
+
+/** Resolves the absolute path to a specific language's query file. */
+export declare function getQueryPath<L extends SupportedLanguage>(
+    lang: L,
+    query: QueryMap[L],
+): string;
+
+/** Returns an object mapping available query types to their absolute file paths. */
+export declare function getAvailableQueries<L extends SupportedLanguage>(
+    lang: L,
+): Record<QueryMap[L], string>;

package/index.js

@@ -0,0 +1,48 @@
+import fs from "node:fs";
+import { fileURLToPath } from "node:url";
+
+const manifestUrl = new URL("./manifest.json", import.meta.url);
+const manifest = JSON.parse(
+	fs.readFileSync(fileURLToPath(manifestUrl), "utf8"),
+);
+
+/**
+ * Resolves the absolute path to a specific language's WASM file.
+ *
+ * @param {string} lang
+ * @returns {string}
+ */
+export function getWasmPath(lang) {
+	const url = new URL(
+		`./out/${lang}/tree-sitter-${lang}.wasm`,
+		import.meta.url,
+	);
+	return fileURLToPath(url);
+}
+
+/**
+ * Resolves the absolute path to a specific language's query file.
+ *
+ * @param {string} lang
+ * @param {string} query
+ * @returns {string}
+ */
+export function getQueryPath(lang, query) {
+	const url = new URL(`./out/${lang}/${query}.scm`, import.meta.url);
+	return fileURLToPath(url);
+}
+
+/**
+ * Returns an object mapping available query types to their absolute file paths.
+ *
+ * @param {string} lang
+ * @returns {Record<string, string>}
+ */
+export function getAvailableQueries(lang) {
+	const queries = manifest[lang] || [];
+	const result = {};
+	for (const query of queries) {
+		result[query] = getQueryPath(lang, query);
+	}
+	return result;
+}