@lumis-sh/wasm-dart 0.26.3 → 0.26.4

package/README.md

@@ -1,22 +1,52 @@
 # @lumis-sh/wasm-dart
 
-Self-contained Lumis language package for dart, with its parser and queries.
+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.3/tree-sitter-dart.wasm](https://unpkg.com/@lumis-sh/wasm-dart@0.26.3/tree-sitter-dart.wasm)
-- [https://cdn.jsdelivr.net/npm/@lumis-sh/wasm-dart@0.26.3/tree-sitter-dart.wasm](https://cdn.jsdelivr.net/npm/@lumis-sh/wasm-dart@0.26.3/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 wasmUrl: URL
-export default wasmUrl
+/**
+ * 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 }

package/index.js

@@ -1,2 +1,34 @@
-const wasmUrl = new URL('./tree-sitter-dart.wasm', import.meta.url)
-export default wasmUrl
+const wasm = new URL('./tree-sitter-dart.wasm', import.meta.url)
+
+export const languagePackage = {
+  "packageName": "@lumis-sh/wasm-dart",
+  "version": "0.26.4",
+  "definitionHash": "fb831d8b6931dcb442d0623ff8a7b63123d24a1de0eab3833a2c1cd713958d12",
+  "parser": {
+    "name": "tree-sitter-dart",
+    "grammarName": "dart",
+    "upstreamVersion": "1.0.0",
+    "revision": "be07cf7118d3dba06236a3f19541685a68209934",
+    "sha256": "f743e6ecda0447cf330d012e9c8dc4f784d2a8874dbdec4b929b0dde87faec79",
+    "size": 1159597
+  },
+  "languages": {
+    "dart": {
+      "aliases": [],
+      "highlights": "; This file is auto-generated. Do not edit.\n(identifier) @variable\n\n(dotted_identifier_list) @string\n\n; Methods\n; --------------------\n; TODO: add method/call_expression to grammar and\n; distinguish method call from variable access\n(function_expression_body\n  (identifier) @function.call)\n\n; ((identifier)(selector (argument_part)) @function)\n; NOTE: This query is a bit of a work around for the fact that the dart grammar doesn't\n; specifically identify a node as a function call\n(((identifier) @function.call\n  (#match? @function.call \"^_?[a-z]\"))\n  .\n  (selector\n    .\n    (argument_part))) @function.call\n\n; Annotations\n; --------------------\n(annotation\n  \"@\" @attribute\n  name: (identifier) @attribute)\n\n; Operators and Tokens\n; --------------------\n(template_substitution\n  \"$\" @punctuation.special\n  \"{\" @punctuation.special\n  \"}\" @punctuation.special) @none\n\n(template_substitution\n  \"$\" @punctuation.special\n  (identifier_dollar_escaped) @variable) @none\n\n(escape_sequence) @string.escape\n\n[\n  \"=>\"\n  \"..\"\n  \"??\"\n  \"==\"\n  \"!\"\n  \"?\"\n  \"&&\"\n  \"%\"\n  \"<\"\n  \">\"\n  \"=\"\n  \">=\"\n  \"<=\"\n  \"||\"\n  \">>>=\"\n  \">>=\"\n  \"<<=\"\n  \"&=\"\n  \"|=\"\n  \"??=\"\n  \"%=\"\n  \"+=\"\n  \"-=\"\n  \"*=\"\n  \"/=\"\n  \"^=\"\n  \"~/=\"\n  (shift_operator)\n  (multiplicative_operator)\n  (increment_operator)\n  (is_operator)\n  (prefix_operator)\n  (equality_operator)\n  (additive_operator)\n] @operator\n\n[\n  \"(\"\n  \")\"\n  \"[\"\n  \"]\"\n  \"{\"\n  \"}\"\n] @punctuation.bracket\n\n; Delimiters\n; --------------------\n[\n  \";\"\n  \".\"\n  \",\"\n  \":\"\n  \"?.\"\n  \"?\"\n] @punctuation.delimiter\n\n; Types\n; --------------------\n(class_definition\n  name: (identifier) @type)\n\n(constructor_signature\n  name: (identifier) @type)\n\n(scoped_identifier\n  scope: (identifier) @type)\n\n(function_signature\n  name: (identifier) @function.method)\n\n(getter_signature\n  (identifier) @function.method)\n\n(setter_signature\n  name: (identifier) @function.method)\n\n(enum_declaration\n  name: (identifier) @type)\n\n(enum_constant\n  name: (identifier) @type)\n\n(void_type) @type\n\n((scoped_identifier\n  scope: (identifier) @type\n  name: (identifier) @type)\n  (#match? @type \"^[A-Za-z]\"))\n\n(type_identifier) @type\n\n(type_alias\n  (type_identifier) @type.definition)\n\n(type_arguments\n  [\n    \"<\"\n    \">\"\n  ] @punctuation.bracket)\n\n; Variables\n; --------------------\n; var keyword\n(inferred_type) @keyword\n\n((identifier) @type\n  (#match? @type \"^_?[A-Z][\\\\s\\\\S]*[a-z]\")) ; catch Classes or IClasses not CLASSES\n\n\"Function\" @type\n\n; properties\n(unconditional_assignable_selector\n  (identifier) @property)\n\n(conditional_assignable_selector\n  (identifier) @property)\n\n(this) @variable.builtin\n\n; Parameters\n; --------------------\n(formal_parameter\n  (identifier) @variable.parameter)\n\n(named_argument\n  (label\n    (identifier) @variable.parameter))\n\n; Literals\n; --------------------\n[\n  (hex_integer_literal)\n  (decimal_integer_literal)\n  (decimal_floating_point_literal)\n  ; TODO: inaccessible nodes\n  ; (octal_integer_literal)\n  ; (hex_floating_point_literal)\n] @number\n\n(symbol_literal) @string.special.symbol\n\n(string_literal) @string\n\n(true) @boolean\n\n(false) @boolean\n\n(null_literal) @constant.builtin\n\n(comment) @comment \n\n(documentation_comment) @comment.documentation \n\n; Keywords\n; --------------------\n[\n  \"import\"\n  \"library\"\n  \"export\"\n  \"as\"\n  \"show\"\n  \"hide\"\n] @keyword.import\n\n; Reserved words (cannot be used as identifiers)\n[\n  ; TODO:\n  ; \"rethrow\" cannot be targeted at all and seems to be an invisible node\n  ; TODO:\n  ; the assert keyword cannot be specifically targeted\n  ; because the grammar selects the whole node or the content\n  ; of the assertion not just the keyword\n  ; assert\n  (case_builtin)\n  \"late\"\n  \"required\"\n  \"on\"\n  \"extends\"\n  \"in\"\n  \"is\"\n  \"new\"\n  \"super\"\n  \"with\"\n] @keyword\n\n[\n  \"class\"\n  \"enum\"\n  \"extension\"\n] @keyword.type\n\n\"return\" @keyword.return\n\n; Built in identifiers:\n; alone these are marked as keywords\n[\n  \"deferred\"\n  \"factory\"\n  \"get\"\n  \"implements\"\n  \"interface\"\n  \"library\"\n  \"operator\"\n  \"mixin\"\n  \"part\"\n  \"set\"\n  \"typedef\"\n] @keyword\n\n[\n  \"async\"\n  \"async*\"\n  \"sync*\"\n  \"await\"\n  \"yield\"\n] @keyword.coroutine\n\n[\n  (const_builtin)\n  (final_builtin)\n  \"abstract\"\n  \"covariant\"\n  \"external\"\n  \"static\"\n  \"final\"\n  \"base\"\n  \"sealed\"\n] @keyword.modifier\n\n; when used as an identifier:\n((identifier) @variable.builtin\n  (#any-of? @variable.builtin\n    \"abstract\" \"as\" \"covariant\" \"deferred\" \"dynamic\" \"export\" \"external\" \"factory\" \"Function\" \"get\"\n    \"implements\" \"import\" \"interface\" \"library\" \"operator\" \"mixin\" \"part\" \"set\" \"static\" \"typedef\"))\n\n[\n  \"if\"\n  \"else\"\n  \"switch\"\n  \"default\"\n] @keyword.conditional\n\n(conditional_expression\n  [\n    \"?\"\n    \":\"\n  ] @keyword.conditional.ternary)\n\n[\n  \"try\"\n  \"throw\"\n  \"catch\"\n  \"finally\"\n  (break_statement)\n] @keyword.exception\n\n[\n  \"do\"\n  \"while\"\n  \"continue\"\n  \"for\"\n] @keyword.repeat",
+      "injections": "; This file is auto-generated. Do not edit.\n((comment) @injection.content\n  (#set! injection.language \"comment\"))",
+      "locals": "; This file is auto-generated. Do not edit.\n; Definitions\n(function_signature\n  name: (identifier) @local.definition.function)\n\n(formal_parameter\n  name: (identifier) @local.definition.parameter)\n\n(initialized_variable_definition\n  name: (identifier) @local.definition.var)\n\n(initialized_identifier\n  (identifier) @local.definition.var)\n\n(static_final_declaration\n  (identifier) @local.definition.var)\n\n; References\n(identifier) @local.reference\n\n; Scopes\n(class_definition\n  body: (_) @local.scope)\n\n[\n  (block)\n  (if_statement)\n  (for_statement)\n  (while_statement)\n  (try_statement)\n  (catch_clause)\n  (finally_clause)\n] @local.scope",
+      "brackets": "; This file is auto-generated. Do not edit.\n(\"(\" @open\n  \")\" @close)\n\n(\"[\" @open\n  \"]\" @close)\n\n(\"{\" @open\n  \"}\" @close)\n"
+    }
+  }
+}
+
+export const dart = {
+  id: "dart",
+  aliases: [],
+  packageName: "@lumis-sh/wasm-dart",
+  wasm,
+  languagePackage,
+}
+
+export default dart

package/lumis.json

@@ -1,6 +1,6 @@
 {
   "packageName": "@lumis-sh/wasm-dart",
-  "version": "0.26.3",
+  "version": "0.26.4",
   "definitionHash": "fb831d8b6931dcb442d0623ff8a7b63123d24a1de0eab3833a2c1cd713958d12",
   "parser": {
     "name": "tree-sitter-dart",

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@lumis-sh/wasm-dart",
-  "version": "0.26.3",
+  "version": "0.26.4",
   "type": "module",
   "types": "./index.d.ts",
-  "description": "Self-contained Lumis language package for dart",
+  "description": "Tree-sitter parser and queries for dart, compiled to WASM for Lumis",
   "author": "Leandro Pereira",
   "license": "MIT",
   "homepage": "https://lumis.sh",
@@ -21,9 +21,16 @@
   },
   "lumis": {
     "treeSitter": "0.26",
-    "formatVersion": 3,
+    "formatVersion": 4,
     "definitionHash": "fb831d8b6931dcb442d0623ff8a7b63123d24a1de0eab3833a2c1cd713958d12"
   },
+  "peerDependencies": {
+    "@lumis-sh/lumis": ">=0.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@lumis-sh/lumis": { "optional": true }
+  },
+  "dependencies": {},
   "keywords": ["lumis-sh", "wasm", "tree-sitter"],
   "files": ["*.wasm", "*.json", "*.js", "*.d.ts", "README.md", "LICENSE"]
 }