@arborium/kdl 2.6.1 → 2.17.0

package/README.md

@@ -0,0 +1,65 @@
+# @arborium/kdl
+
+[![Part of Arborium](https://img.shields.io/badge/🌳_Arborium-grammar_collection-228B22)](https://github.com/bearcove/arborium)
+[![npm](https://img.shields.io/npm/v/@arborium/kdl)](https://www.npmjs.com/package/@arborium/kdl)
+[![license](https://img.shields.io/npm/l/@arborium/kdl)](https://github.com/bearcove/arborium)
+
+Syntax highlighting for [KDL](https://kdl.dev/), powered by WebAssembly and [tree-sitter](https://tree-sitter.github.io/).
+
+> A modern document language with the flexibility of XML and the simplicity of JSON and YAML. Your new favorite configuration language.
+
+
+| | |
+|---|---|
+| **Inventor** | Kat Marchán |
+| **Year** | 2020 |
+
+## Installation
+
+```bash
+npm install @arborium/kdl
+```
+
+## Usage
+
+```javascript
+import { createHighlighter } from '@arborium/arborium';
+import * as grammar from '@arborium/kdl';
+
+const highlighter = await createHighlighter();
+await highlighter.loadGrammar(grammar);
+
+const html = highlighter.highlight(code, 'kdl');
+```
+
+## What's included
+
+This package contains:
+
+- `grammar.js` - ES module that loads the WebAssembly grammar
+- `grammar.d.ts` - TypeScript type definitions
+- `grammar_bg.wasm` - The tree-sitter grammar compiled to WebAssembly
+
+## About Arborium
+
+This package is part of [**Arborium**](https://github.com/bearcove/arborium), a collection of tree-sitter grammars for syntax highlighting, maintained by [Amos Wenger](https://fasterthanli.me).
+
+Arborium provides:
+- **98+ language grammars** compiled to WebAssembly
+- **Browser and Node.js support** via ES modules
+- **TypeScript definitions** for all packages
+- **Consistent API** across all grammars
+
+## Related packages
+
+- [`@arborium/arborium`](https://www.npmjs.com/package/@arborium/arborium) - Core highlighter library
+- [All @arborium packages](https://www.npmjs.com/org/arborium)
+
+## License
+
+MIT OR Apache-2.0
+
+## Links
+
+- [GitHub](https://github.com/bearcove/arborium)
+- [Issues](https://github.com/bearcove/arborium/issues)

package/grammar.js

@@ -1,4 +1,172 @@
-let wasm;
+/* @ts-self-types="./arborium_kdl_plugin.d.ts" */
+
+/**
+ * Cancels an ongoing parse operation.
+ * @param {number} session
+ */
+export function cancel(session) {
+    wasm.cancel(session);
+}
+
+/**
+ * Creates a new parser session and returns its ID.
+ * @returns {number}
+ */
+export function create_session() {
+    const ret = wasm.create_session();
+    return ret >>> 0;
+}
+
+/**
+ * Frees a parser session.
+ * @param {number} session
+ */
+export function free_session(session) {
+    wasm.free_session(session);
+}
+
+/**
+ * Returns the list of languages this grammar can inject into (e.g., for embedded languages).
+ * Most grammars return an empty array.
+ * @returns {string[]}
+ */
+export function injection_languages() {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.injection_languages(retptr);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        var v1 = getArrayJsValueFromWasm0(r0, r1).slice();
+        wasm.__wbindgen_export(r0, r1 * 4, 4);
+        return v1;
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
+/**
+ * Returns the language ID for this grammar plugin.
+ * @returns {string}
+ */
+export function language_id() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.language_id(retptr);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred1_0 = r0;
+        deferred1_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred1_0, deferred1_1, 1);
+    }
+}
+
+/**
+ * Parses the text in a session and returns spans with UTF-8 byte offsets.
+ *
+ * Use this for Rust code that needs to slice strings with `&source[start..end]`.
+ * For JavaScript interop, use `parse_utf16` instead.
+ * @param {number} session
+ * @returns {any}
+ */
+export function parse(session) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.parse(retptr, session);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+        if (r2) {
+            throw takeObject(r1);
+        }
+        return takeObject(r0);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
+/**
+ * Parses the text in a session and returns spans with UTF-16 code unit indices.
+ *
+ * Use this for JavaScript code that needs to use `String.prototype.slice()`.
+ * The offsets are compatible with JavaScript string APIs.
+ * @param {number} session
+ * @returns {any}
+ */
+export function parse_utf16(session) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.parse_utf16(retptr, session);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+        if (r2) {
+            throw takeObject(r1);
+        }
+        return takeObject(r0);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+    }
+}
+
+/**
+ * Sets the text for a parser session.
+ * @param {number} session
+ * @param {string} text
+ */
+export function set_text(session, text) {
+    const ptr0 = passStringToWasm0(text, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+    const len0 = WASM_VECTOR_LEN;
+    wasm.set_text(session, ptr0, len0);
+}
+
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg___wbindgen_throw_6ddd609b62940d55: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbg_new_a70fbab9066b301f: function() {
+            const ret = new Array();
+            return addHeapObject(ret);
+        },
+        __wbg_new_ab79df5bd7c26067: function() {
+            const ret = new Object();
+            return addHeapObject(ret);
+        },
+        __wbg_set_282384002438957f: function(arg0, arg1, arg2) {
+            getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
+        },
+        __wbg_set_6be42768c690e380: function(arg0, arg1, arg2) {
+            getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
+        },
+        __wbindgen_cast_0000000000000001: function(arg0) {
+            // Cast intrinsic for `F64 -> Externref`.
+            const ret = arg0;
+            return addHeapObject(ret);
+        },
+        __wbindgen_cast_0000000000000002: function(arg0, arg1) {
+            // Cast intrinsic for `Ref(String) -> Externref`.
+            const ret = getStringFromWasm0(arg0, arg1);
+            return addHeapObject(ret);
+        },
+        __wbindgen_object_clone_ref: function(arg0) {
+            const ret = getObject(arg0);
+            return addHeapObject(ret);
+        },
+        __wbindgen_object_drop_ref: function(arg0) {
+            takeObject(arg0);
+        },
+    };
+    return {
+        __proto__: null,
+        "./arborium_kdl_plugin_bg.js": import0,
+    };
+}
 
 function addHeapObject(obj) {
     if (heap_next === heap.length) heap.push(heap.length + 1);
@@ -10,7 +178,7 @@ function addHeapObject(obj) {
 }
 
 function dropObject(idx) {
-    if (idx < 132) return;
+    if (idx < 1028) return;
     heap[idx] = heap_next;
     heap_next = idx;
 }
@@ -48,7 +216,7 @@ function getUint8ArrayMemory0() {
 
 function getObject(idx) { return heap[idx]; }
 
-let heap = new Array(128).fill(undefined);
+let heap = new Array(1024).fill(undefined);
 heap.push(undefined, null, true, false);
 
 let heap_next = heap.length;
@@ -120,126 +288,32 @@ if (!('encodeInto' in cachedTextEncoder)) {
             read: arg.length,
             written: buf.length
         };
-    }
+    };
 }
 
 let WASM_VECTOR_LEN = 0;
 
-/**
- * Cancels an ongoing parse operation.
- * @param {number} session
- */
-export function cancel(session) {
-    wasm.cancel(session);
-}
-
-/**
- * Creates a new parser session and returns its ID.
- * @returns {number}
- */
-export function create_session() {
-    const ret = wasm.create_session();
-    return ret >>> 0;
-}
-
-/**
- * Frees a parser session.
- * @param {number} session
- */
-export function free_session(session) {
-    wasm.free_session(session);
-}
-
-/**
- * Returns the list of languages this grammar can inject into (e.g., for embedded languages).
- * Most grammars return an empty array.
- * @returns {string[]}
- */
-export function injection_languages() {
-    try {
-        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.injection_languages(retptr);
-        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
-        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-        var v1 = getArrayJsValueFromWasm0(r0, r1).slice();
-        wasm.__wbindgen_export(r0, r1 * 4, 4);
-        return v1;
-    } finally {
-        wasm.__wbindgen_add_to_stack_pointer(16);
-    }
-}
-
-/**
- * Returns the language ID for this grammar plugin.
- * @returns {string}
- */
-export function language_id() {
-    let deferred1_0;
-    let deferred1_1;
-    try {
-        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.language_id(retptr);
-        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
-        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-        deferred1_0 = r0;
-        deferred1_1 = r1;
-        return getStringFromWasm0(r0, r1);
-    } finally {
-        wasm.__wbindgen_add_to_stack_pointer(16);
-        wasm.__wbindgen_export(deferred1_0, deferred1_1, 1);
-    }
-}
-
-/**
- * Parses the text in a session and returns the result as a JS value.
- *
- * The result is a JavaScript object representation of ParseResult containing spans and injections.
- * @param {number} session
- * @returns {any}
- */
-export function parse(session) {
-    try {
-        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.parse(retptr, session);
-        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
-        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-        var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
-        if (r2) {
-            throw takeObject(r1);
-        }
-        return takeObject(r0);
-    } finally {
-        wasm.__wbindgen_add_to_stack_pointer(16);
-    }
-}
-
-/**
- * Sets the text for a parser session.
- * @param {number} session
- * @param {string} text
- */
-export function set_text(session, text) {
-    const ptr0 = passStringToWasm0(text, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
-    const len0 = WASM_VECTOR_LEN;
-    wasm.set_text(session, ptr0, len0);
+let wasmModule, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedDataViewMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+    return wasm;
 }
 
-const EXPECTED_RESPONSE_TYPES = new Set(['basic', 'cors', 'default']);
-
 async function __wbg_load(module, imports) {
     if (typeof Response === 'function' && module instanceof Response) {
         if (typeof WebAssembly.instantiateStreaming === 'function') {
             try {
                 return await WebAssembly.instantiateStreaming(module, imports);
             } catch (e) {
-                const validResponse = module.ok && EXPECTED_RESPONSE_TYPES.has(module.type);
+                const validResponse = module.ok && expectedResponseType(module.type);
 
                 if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
                     console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
 
-                } else {
-                    throw e;
-                }
+                } else { throw e; }
             }
         }
 
@@ -254,65 +328,20 @@ async function __wbg_load(module, imports) {
             return instance;
         }
     }
-}
 
-function __wbg_get_imports() {
-    const imports = {};
-    imports.wbg = {};
-    imports.wbg.__wbg___wbindgen_throw_dd24417ed36fc46e = function(arg0, arg1) {
-        throw new Error(getStringFromWasm0(arg0, arg1));
-    };
-    imports.wbg.__wbg_new_1ba21ce319a06297 = function() {
-        const ret = new Object();
-        return addHeapObject(ret);
-    };
-    imports.wbg.__wbg_new_25f239778d6112b9 = function() {
-        const ret = new Array();
-        return addHeapObject(ret);
-    };
-    imports.wbg.__wbg_set_3f1d0b984ed272ed = function(arg0, arg1, arg2) {
-        getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
-    };
-    imports.wbg.__wbg_set_7df433eea03a5c14 = function(arg0, arg1, arg2) {
-        getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
-    };
-    imports.wbg.__wbindgen_cast_2241b6af4c4b2941 = function(arg0, arg1) {
-        // Cast intrinsic for `Ref(String) -> Externref`.
-        const ret = getStringFromWasm0(arg0, arg1);
-        return addHeapObject(ret);
-    };
-    imports.wbg.__wbindgen_cast_d6cd19b81560fd6e = function(arg0) {
-        // Cast intrinsic for `F64 -> Externref`.
-        const ret = arg0;
-        return addHeapObject(ret);
-    };
-    imports.wbg.__wbindgen_object_clone_ref = function(arg0) {
-        const ret = getObject(arg0);
-        return addHeapObject(ret);
-    };
-    imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
-        takeObject(arg0);
-    };
-
-    return imports;
-}
-
-function __wbg_finalize_init(instance, module) {
-    wasm = instance.exports;
-    __wbg_init.__wbindgen_wasm_module = module;
-    cachedDataViewMemory0 = null;
-    cachedUint8ArrayMemory0 = null;
-
-
-
-    return wasm;
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
 }
 
 function initSync(module) {
     if (wasm !== undefined) return wasm;
 
 
-    if (typeof module !== 'undefined') {
+    if (module !== undefined) {
         if (Object.getPrototypeOf(module) === Object.prototype) {
             ({module} = module)
         } else {
@@ -332,7 +361,7 @@ async function __wbg_init(module_or_path) {
     if (wasm !== undefined) return wasm;
 
 
-    if (typeof module_or_path !== 'undefined') {
+    if (module_or_path !== undefined) {
         if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
             ({module_or_path} = module_or_path)
         } else {
@@ -340,7 +369,7 @@ async function __wbg_init(module_or_path) {
         }
     }
 
-    if (typeof module_or_path === 'undefined') {
+    if (module_or_path === undefined) {
         module_or_path = new URL('arborium_kdl_plugin_bg.wasm', import.meta.url);
     }
     const imports = __wbg_get_imports();
@@ -354,5 +383,4 @@ async function __wbg_init(module_or_path) {
     return __wbg_finalize_init(instance, module);
 }
 
-export { initSync };
-export default __wbg_init;
+export { initSync, __wbg_init as default };

package/package.json

@@ -1,26 +1,17 @@
 {
-  "author": "Amos Wenger <amos@bearcove.eu>",
-  "bugs": {
-    "url": "https://github.com/bearcove/arborium/issues"
-  },
+  "name": "@arborium/kdl",
+  "version": "2.17.0",
   "description": "Syntax highlighting for KDL, powered by WebAssembly",
-  "engines": {
-    "node": ">=18"
-  },
+  "type": "module",
+  "main": "./grammar.js",
+  "module": "./grammar.js",
   "exports": {
     ".": "./grammar.js",
     "./grammar.js": "./grammar.js",
     "./grammar_bg.wasm": "./grammar_bg.wasm"
   },
-  "files": [
-    "grammar.js",
-    "grammar_bg.wasm"
-  ],
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/fasterthanlime"
-  },
-  "homepage": "https://github.com/bearcove/arborium",
+  "files": ["grammar.js", "grammar_bg.wasm"],
+  "sideEffects": false,
   "keywords": [
     "arborium",
     "syntax-highlighting",
@@ -29,18 +20,24 @@
     "KDL",
     "wasm"
   ],
-  "license": "MIT OR Apache-2.0",
-  "main": "./grammar.js",
-  "module": "./grammar.js",
-  "name": "@arborium/kdl",
-  "publishConfig": {
-    "access": "public"
-  },
+  "author": "Amos Wenger <amos@bearcove.eu>",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/bearcove/arborium"
   },
-  "sideEffects": false,
-  "type": "module",
-  "version": "2.6.1"
+  "homepage": "https://github.com/bearcove/arborium",
+  "bugs": {
+    "url": "https://github.com/bearcove/arborium/issues"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/fasterthanlime"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }