@codemirror/language 6.3.1 → 6.4.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.4.0 (2023-01-12)
+
+### New features
+
+The `bracketMatchingHandle` node prop can now be used to limit bracket matching behavior for larger nodes to a single subnode (for example the tag name of an HTML tag).
+
+## 6.3.2 (2022-12-16)
+
+### Bug fixes
+
+Fix a bug that caused `ensureSyntaxTree` to return incomplete trees when using a viewport-aware parser like `StreamLanguage`.
+
 ## 6.3.1 (2022-11-14)
 
 ### Bug fixes

package/dist/index.cjs

@@ -183,7 +183,13 @@ up to that point if the tree isn't already available.
 function ensureSyntaxTree(state, upto, timeout = 50) {
     var _a;
     let parse = (_a = state.field(Language.state, false)) === null || _a === void 0 ? void 0 : _a.context;
-    return !parse ? null : parse.isDone(upto) || parse.work(timeout, upto) ? parse.tree : null;
+    if (!parse)
+        return null;
+    let oldVieport = parse.viewport;
+    parse.updateViewport({ from: 0, to: upto });
+    let result = parse.isDone(upto) || parse.work(timeout, upto) ? parse.tree : null;
+    parse.updateViewport(oldVieport);
+    return result;
 }
 /**
 Queries whether there is a full syntax tree available up to the
@@ -1682,7 +1688,7 @@ A default highlight style (works well with light themes).
 */
 const defaultHighlightStyle = HighlightStyle.define([
     { tag: highlight.tags.meta,
-        color: "#7a757a" },
+        color: "#404740" },
     { tag: highlight.tags.link,
         textDecoration: "underline" },
     { tag: highlight.tags.heading,
@@ -1781,6 +1787,15 @@ highlighting style is used to indicate this.
 function bracketMatching(config = {}) {
     return [bracketMatchingConfig.of(config), bracketMatchingUnique];
 }
+/**
+When larger syntax nodes, such as HTML tags, are marked as
+opening/closing, it can be a bit messy to treat the whole node as
+a matchable bracket. This node prop allows you to define, for such
+a node, a ‘handle’—the part of the node that is highlighted, and
+that the cursor must be on to activate highlighting in the first
+place.
+*/
+const bracketMatchingHandle = new common.NodeProp();
 function matchingNodes(node, dir, brackets) {
     let byProp = node.prop(dir < 0 ? common.NodeProp.openedBy : common.NodeProp.closedBy);
     if (byProp)
@@ -1792,6 +1807,10 @@ function matchingNodes(node, dir, brackets) {
     }
     return null;
 }
+function findHandle(node) {
+    let hasHandle = node.type.prop(bracketMatchingHandle);
+    return hasHandle ? hasHandle(node.node) : node;
+}
 /**
 Find the matching bracket for the token at `pos`, scanning
 direction `dir`. Only the `brackets` and `maxScanDistance`
@@ -1803,30 +1822,36 @@ function matchBrackets(state, pos, dir, config = {}) {
     let tree = syntaxTree(state), node = tree.resolveInner(pos, dir);
     for (let cur = node; cur; cur = cur.parent) {
         let matches = matchingNodes(cur.type, dir, brackets);
-        if (matches && cur.from < cur.to)
-            return matchMarkedBrackets(state, pos, dir, cur, matches, brackets);
+        if (matches && cur.from < cur.to) {
+            let handle = findHandle(cur);
+            if (handle && (dir > 0 ? pos >= handle.from && pos < handle.to : pos > handle.from && pos <= handle.to))
+                return matchMarkedBrackets(state, pos, dir, cur, handle, matches, brackets);
+        }
     }
     return matchPlainBrackets(state, pos, dir, tree, node.type, maxScanDistance, brackets);
 }
-function matchMarkedBrackets(_state, _pos, dir, token, matching, brackets) {
-    let parent = token.parent, firstToken = { from: token.from, to: token.to };
+function matchMarkedBrackets(_state, _pos, dir, token, handle, matching, brackets) {
+    let parent = token.parent, firstToken = { from: handle.from, to: handle.to };
     let depth = 0, cursor = parent === null || parent === void 0 ? void 0 : parent.cursor();
     if (cursor && (dir < 0 ? cursor.childBefore(token.from) : cursor.childAfter(token.to)))
         do {
             if (dir < 0 ? cursor.to <= token.from : cursor.from >= token.to) {
                 if (depth == 0 && matching.indexOf(cursor.type.name) > -1 && cursor.from < cursor.to) {
-                    return { start: firstToken, end: { from: cursor.from, to: cursor.to }, matched: true };
+                    let endHandle = findHandle(cursor);
+                    return { start: firstToken, end: endHandle ? { from: endHandle.from, to: endHandle.to } : undefined, matched: true };
                 }
                 else if (matchingNodes(cursor.type, dir, brackets)) {
                     depth++;
                 }
                 else if (matchingNodes(cursor.type, -dir, brackets)) {
-                    if (depth == 0)
+                    if (depth == 0) {
+                        let endHandle = findHandle(cursor);
                         return {
                             start: firstToken,
-                            end: cursor.from == cursor.to ? undefined : { from: cursor.from, to: cursor.to },
+                            end: endHandle && endHandle.from < endHandle.to ? { from: endHandle.from, to: endHandle.to } : undefined,
                             matched: false
                         };
+                    }
                     depth--;
                 }
             }
@@ -2398,6 +2423,7 @@ exports.StreamLanguage = StreamLanguage;
 exports.StringStream = StringStream;
 exports.TreeIndentContext = TreeIndentContext;
 exports.bracketMatching = bracketMatching;
+exports.bracketMatchingHandle = bracketMatchingHandle;
 exports.codeFolding = codeFolding;
 exports.continuedIndent = continuedIndent;
 exports.defaultHighlightStyle = defaultHighlightStyle;

package/dist/index.d.ts

@@ -889,6 +889,15 @@ highlighting style is used to indicate this.
 */
 declare function bracketMatching(config?: Config): Extension;
 /**
+When larger syntax nodes, such as HTML tags, are marked as
+opening/closing, it can be a bit messy to treat the whole node as
+a matchable bracket. This node prop allows you to define, for such
+a node, a ‘handle’—the part of the node that is highlighted, and
+that the cursor must be on to activate highlighting in the first
+place.
+*/
+declare const bracketMatchingHandle: NodeProp<(node: SyntaxNode) => SyntaxNode | null>;
+/**
 The result returned from `matchBrackets`.
 */
 interface MatchResult {
@@ -1103,4 +1112,4 @@ declare class StreamLanguage<State> extends Language {
     get allowsNesting(): boolean;
 }
 
-export { Config, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, MatchResult, ParseContext, StreamLanguage, StreamParser, StringStream, TagStyle, TreeIndentContext, bracketMatching, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, unfoldAll, unfoldCode, unfoldEffect };
+export { Config, HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, MatchResult, ParseContext, StreamLanguage, StreamParser, StringStream, TagStyle, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, unfoldAll, unfoldCode, unfoldEffect };

package/dist/index.js

@@ -179,7 +179,13 @@ up to that point if the tree isn't already available.
 function ensureSyntaxTree(state, upto, timeout = 50) {
     var _a;
     let parse = (_a = state.field(Language.state, false)) === null || _a === void 0 ? void 0 : _a.context;
-    return !parse ? null : parse.isDone(upto) || parse.work(timeout, upto) ? parse.tree : null;
+    if (!parse)
+        return null;
+    let oldVieport = parse.viewport;
+    parse.updateViewport({ from: 0, to: upto });
+    let result = parse.isDone(upto) || parse.work(timeout, upto) ? parse.tree : null;
+    parse.updateViewport(oldVieport);
+    return result;
 }
 /**
 Queries whether there is a full syntax tree available up to the
@@ -1678,7 +1684,7 @@ A default highlight style (works well with light themes).
 */
 const defaultHighlightStyle = /*@__PURE__*/HighlightStyle.define([
     { tag: tags.meta,
-        color: "#7a757a" },
+        color: "#404740" },
     { tag: tags.link,
         textDecoration: "underline" },
     { tag: tags.heading,
@@ -1777,6 +1783,15 @@ highlighting style is used to indicate this.
 function bracketMatching(config = {}) {
     return [bracketMatchingConfig.of(config), bracketMatchingUnique];
 }
+/**
+When larger syntax nodes, such as HTML tags, are marked as
+opening/closing, it can be a bit messy to treat the whole node as
+a matchable bracket. This node prop allows you to define, for such
+a node, a ‘handle’—the part of the node that is highlighted, and
+that the cursor must be on to activate highlighting in the first
+place.
+*/
+const bracketMatchingHandle = /*@__PURE__*/new NodeProp();
 function matchingNodes(node, dir, brackets) {
     let byProp = node.prop(dir < 0 ? NodeProp.openedBy : NodeProp.closedBy);
     if (byProp)
@@ -1788,6 +1803,10 @@ function matchingNodes(node, dir, brackets) {
     }
     return null;
 }
+function findHandle(node) {
+    let hasHandle = node.type.prop(bracketMatchingHandle);
+    return hasHandle ? hasHandle(node.node) : node;
+}
 /**
 Find the matching bracket for the token at `pos`, scanning
 direction `dir`. Only the `brackets` and `maxScanDistance`
@@ -1799,30 +1818,36 @@ function matchBrackets(state, pos, dir, config = {}) {
     let tree = syntaxTree(state), node = tree.resolveInner(pos, dir);
     for (let cur = node; cur; cur = cur.parent) {
         let matches = matchingNodes(cur.type, dir, brackets);
-        if (matches && cur.from < cur.to)
-            return matchMarkedBrackets(state, pos, dir, cur, matches, brackets);
+        if (matches && cur.from < cur.to) {
+            let handle = findHandle(cur);
+            if (handle && (dir > 0 ? pos >= handle.from && pos < handle.to : pos > handle.from && pos <= handle.to))
+                return matchMarkedBrackets(state, pos, dir, cur, handle, matches, brackets);
+        }
     }
     return matchPlainBrackets(state, pos, dir, tree, node.type, maxScanDistance, brackets);
 }
-function matchMarkedBrackets(_state, _pos, dir, token, matching, brackets) {
-    let parent = token.parent, firstToken = { from: token.from, to: token.to };
+function matchMarkedBrackets(_state, _pos, dir, token, handle, matching, brackets) {
+    let parent = token.parent, firstToken = { from: handle.from, to: handle.to };
     let depth = 0, cursor = parent === null || parent === void 0 ? void 0 : parent.cursor();
     if (cursor && (dir < 0 ? cursor.childBefore(token.from) : cursor.childAfter(token.to)))
         do {
             if (dir < 0 ? cursor.to <= token.from : cursor.from >= token.to) {
                 if (depth == 0 && matching.indexOf(cursor.type.name) > -1 && cursor.from < cursor.to) {
-                    return { start: firstToken, end: { from: cursor.from, to: cursor.to }, matched: true };
+                    let endHandle = findHandle(cursor);
+                    return { start: firstToken, end: endHandle ? { from: endHandle.from, to: endHandle.to } : undefined, matched: true };
                 }
                 else if (matchingNodes(cursor.type, dir, brackets)) {
                     depth++;
                 }
                 else if (matchingNodes(cursor.type, -dir, brackets)) {
-                    if (depth == 0)
+                    if (depth == 0) {
+                        let endHandle = findHandle(cursor);
                         return {
                             start: firstToken,
-                            end: cursor.from == cursor.to ? undefined : { from: cursor.from, to: cursor.to },
+                            end: endHandle && endHandle.from < endHandle.to ? { from: endHandle.from, to: endHandle.to } : undefined,
                             matched: false
                         };
+                    }
                     depth--;
                 }
             }
@@ -2383,4 +2408,4 @@ function docID(data) {
     return type;
 }
 
-export { HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, StreamLanguage, StringStream, TreeIndentContext, bracketMatching, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, unfoldAll, unfoldCode, unfoldEffect };
+export { HighlightStyle, IndentContext, LRLanguage, Language, LanguageDescription, LanguageSupport, ParseContext, StreamLanguage, StringStream, TreeIndentContext, bracketMatching, bracketMatchingHandle, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentRange, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, unfoldAll, unfoldCode, unfoldEffect };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/language",
-  "version": "6.3.1",
+  "version": "6.4.0",
   "description": "Language support infrastructure for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",