@lumis-sh/wasm-dart 0.26.2 → 0.26.4

package/README.md

@@ -1,22 +1,52 @@
 # @lumis-sh/wasm-dart
 
-Tree-sitter WASM grammar for dart
+Self-contained Lumis language package for dart.
+
+The Tree-sitter parser is compiled to WASM and ships with the queries that highlight it.
 
 Built with [`tree-sitter build --wasm`](https://tree-sitter.github.io/tree-sitter/cli/build.html) `v0.26.11`
 
 Used by [Lumis](https://lumis.sh) and compatible with [web-tree-sitter](https://www.npmjs.com/package/web-tree-sitter) v0.26 and other WASM runtimes.
 
+## Installation
+
+```sh
+npm install @lumis-sh/wasm-dart
+```
+
+## Usage
+
+The package exports the language, ready for Lumis, in Node and in a browser:
+
+```js
+import { createHighlighter } from '@lumis-sh/lumis'
+import dart from '@lumis-sh/wasm-dart'
+
+const highlighter = await createHighlighter({ languages: [dart] })
+```
+
+## What it contains
+
+`tree-sitter-dart.wasm` is the parser. `lumis.json` describes it and records its size, its SHA-256 and the queries.
+
+Node reads both from the installed package, and a bundler ships them with your code, so nothing is downloaded at runtime.
+
 ## Parser
 
 | Parser | Version | Rev |
 | ------ | ------- | --- |
 | [https://github.com/UserNobody14/tree-sitter-dart.git](https://github.com/UserNobody14/tree-sitter-dart.git) | 1.0.0 | be07cf7118d3dba06236a3f19541685a68209934 |
 
+The same parser is published to Hex as
+[`lumis_wasm_dart`](https://hex.pm/packages/lumis_wasm_dart) — byte for byte, from
+one build, so both registries serve the same artifact.
+
 ## CDN
 
-- [https://unpkg.com/@lumis-sh/wasm-dart@0.26/tree-sitter-dart.wasm](https://unpkg.com/@lumis-sh/wasm-dart@0.26/tree-sitter-dart.wasm)
-- [https://cdn.jsdelivr.net/npm/@lumis-sh/wasm-dart@0.26/tree-sitter-dart.wasm](https://cdn.jsdelivr.net/npm/@lumis-sh/wasm-dart@0.26/tree-sitter-dart.wasm)
+- [https://unpkg.com/@lumis-sh/wasm-dart@0.26.4/tree-sitter-dart.wasm](https://unpkg.com/@lumis-sh/wasm-dart@0.26.4/tree-sitter-dart.wasm)
+- [https://cdn.jsdelivr.net/npm/@lumis-sh/wasm-dart@0.26.4/tree-sitter-dart.wasm](https://cdn.jsdelivr.net/npm/@lumis-sh/wasm-dart@0.26.4/tree-sitter-dart.wasm)
 
 ## License
 
-This package redistributes the parser source listed above; see that project for its license.
+The Lumis packaging is MIT. The parser itself is redistributed from the
+upstream project above; see that project for its license.

package/index.d.ts

@@ -1,2 +1,25 @@
-declare const wasmBinary: Uint8Array
-export default wasmBinary
+/**
+ * A language from this package. Pass it to `createHighlighter({ languages })`
+ * from `@lumis-sh/lumis`, in Node or in a browser.
+ */
+export interface Language {
+  id: string
+  aliases: string[]
+  packageName: string
+  /** The parser, which a bundler ships next to your code. */
+  wasm: URL
+  languagePackage: LanguagePackage
+  /** Grammars this language cannot highlight without, loaded along with it. */
+  requires?: Language[]
+}
+
+/** This package's `lumis.json`: the parser's size and digest, and the queries released with it. */
+export interface LanguagePackage {
+  packageName: string
+  version: string
+  [field: string]: unknown
+}
+
+export declare const languagePackage: LanguagePackage
+export declare const dart: Language
+export { dart as default }