@lezer/common 0.16.1 → 1.0.0

package/dist/index.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 // FIXME profile adding a per-Tree TreeNode cache, validating it by
 // parent pointer
-/// The default maximum length of a `TreeBuffer` node (1024).
+/// The default maximum length of a `TreeBuffer` node.
 const DefaultBufferLength = 1024;
 let nextPropID = 0;
 class Range {
@@ -67,7 +67,7 @@ NodeProp.contextHash = new NodeProp({ perNode: true });
 NodeProp.lookAhead = new NodeProp({ perNode: true });
 /// This per-node prop is used to replace a given node, or part of a
 /// node, with another tree. This is useful to include trees from
-/// different languages.
+/// different languages in mixed-language parsers.
 NodeProp.mounted = new NodeProp({ perNode: true });
 /// A mounted tree, which can be [stored](#common.NodeProp^mounted) on
 /// a tree node to indicate that parts of its content are
@@ -113,6 +113,7 @@ class NodeType {
         this.id = id;
         this.flags = flags;
     }
+    /// Define a node type.
     static define(spec) {
         let props = spec.props && spec.props.length ? Object.create(null) : noProps;
         let flags = (spec.top ? 1 /* Top */ : 0) | (spec.skipped ? 2 /* Skipped */ : 0) |
@@ -194,7 +195,7 @@ class NodeSet {
                 throw new RangeError("Node type ids should correspond to array positions when creating a node set");
     }
     /// Create a copy of this set with some node properties added. The
-    /// arguments to this method should be created with
+    /// arguments to this method can be created with
     /// [`NodeProp.add`](#common.NodeProp.add).
     extend(...props) {
         let newTypes = [];
@@ -404,7 +405,7 @@ class FlatBufferCursor {
 /// Tree buffers contain (type, start, end, endIndex) quads for each
 /// node. In such a buffer, nodes are stored in prefix order (parents
 /// before children, with the endIndex of the parent indicating which
-/// children belong to it)
+/// children belong to it).
 class TreeBuffer {
     /// Create a tree buffer.
     constructor(
@@ -1308,7 +1309,10 @@ class NodeWeakMap {
 /// [`applyChanges`](#common.TreeFragment^applyChanges) method to
 /// update fragments for document changes.
 class TreeFragment {
-    /// Construct a tree fragment.
+    /// Construct a tree fragment. You'll usually want to use
+    /// [`addTree`](#common.TreeFragment^addTree) and
+    /// [`applyChanges`](#common.TreeFragment^applyChanges) instead of
+    /// calling this directly.
     constructor(
     /// The start of the unchanged range pointed to by this fragment.
     /// This refers to an offset in the _updated_ document (as opposed
@@ -1423,11 +1427,6 @@ class StringInput {
 /// function, runs the resulting [inner parses](#common.NestedParse),
 /// and then [mounts](#common.NodeProp^mounted) their results onto the
 /// tree.
-///
-/// The nesting function is passed a cursor to provide context for a
-/// node, but _should not_ move that cursor, only inspect its
-/// properties and optionally access its
-/// [node object](#common.TreeCursor.node).
 function parseMixed(nest) {
     return (parse, input, fragments, ranges) => new MixedParse(parse, nest, input, fragments, ranges);
 }

package/dist/index.js

@@ -1,6 +1,6 @@
 // FIXME profile adding a per-Tree TreeNode cache, validating it by
 // parent pointer
-/// The default maximum length of a `TreeBuffer` node (1024).
+/// The default maximum length of a `TreeBuffer` node.
 const DefaultBufferLength = 1024;
 let nextPropID = 0;
 class Range {
@@ -63,7 +63,7 @@ NodeProp.contextHash = new NodeProp({ perNode: true });
 NodeProp.lookAhead = new NodeProp({ perNode: true });
 /// This per-node prop is used to replace a given node, or part of a
 /// node, with another tree. This is useful to include trees from
-/// different languages.
+/// different languages in mixed-language parsers.
 NodeProp.mounted = new NodeProp({ perNode: true });
 /// A mounted tree, which can be [stored](#common.NodeProp^mounted) on
 /// a tree node to indicate that parts of its content are
@@ -109,6 +109,7 @@ class NodeType {
         this.id = id;
         this.flags = flags;
     }
+    /// Define a node type.
     static define(spec) {
         let props = spec.props && spec.props.length ? Object.create(null) : noProps;
         let flags = (spec.top ? 1 /* Top */ : 0) | (spec.skipped ? 2 /* Skipped */ : 0) |
@@ -190,7 +191,7 @@ class NodeSet {
                 throw new RangeError("Node type ids should correspond to array positions when creating a node set");
     }
     /// Create a copy of this set with some node properties added. The
-    /// arguments to this method should be created with
+    /// arguments to this method can be created with
     /// [`NodeProp.add`](#common.NodeProp.add).
     extend(...props) {
         let newTypes = [];
@@ -400,7 +401,7 @@ class FlatBufferCursor {
 /// Tree buffers contain (type, start, end, endIndex) quads for each
 /// node. In such a buffer, nodes are stored in prefix order (parents
 /// before children, with the endIndex of the parent indicating which
-/// children belong to it)
+/// children belong to it).
 class TreeBuffer {
     /// Create a tree buffer.
     constructor(
@@ -1304,7 +1305,10 @@ class NodeWeakMap {
 /// [`applyChanges`](#common.TreeFragment^applyChanges) method to
 /// update fragments for document changes.
 class TreeFragment {
-    /// Construct a tree fragment.
+    /// Construct a tree fragment. You'll usually want to use
+    /// [`addTree`](#common.TreeFragment^addTree) and
+    /// [`applyChanges`](#common.TreeFragment^applyChanges) instead of
+    /// calling this directly.
     constructor(
     /// The start of the unchanged range pointed to by this fragment.
     /// This refers to an offset in the _updated_ document (as opposed
@@ -1419,11 +1423,6 @@ class StringInput {
 /// function, runs the resulting [inner parses](#common.NestedParse),
 /// and then [mounts](#common.NodeProp^mounted) their results onto the
 /// tree.
-///
-/// The nesting function is passed a cursor to provide context for a
-/// node, but _should not_ move that cursor, only inspect its
-/// properties and optionally access its
-/// [node object](#common.TreeCursor.node).
 function parseMixed(nest) {
     return (parse, input, fragments, ranges) => new MixedParse(parse, nest, input, fragments, ranges);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lezer/common",
-  "version": "0.16.1",
+  "version": "1.0.0",
   "description": "Syntax tree data structure and parser interfaces for the lezer parser",
   "main": "dist/index.cjs",
   "type": "module",