@codemirror/language 6.4.0 → 6.5.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.5.0 (2023-02-07)
+
+### Bug fixes
+
+Make indentation for stream languages more reliable by having `StringStream.indentation` return overridden indentations from the indent context.
+
+### New features
+
+The `toggleFold` command folds or unfolds depending on whether there's an existing folded range on the current line.
+
+`indentUnit` now accepts any (repeated) whitespace character, not just spaces and tabs.
+
 ## 6.4.0 (2023-01-12)
 
 ### New features

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2018-2021 by Marijn Haverbeke <marijnh@gmail.com> and others
+Copyright (C) 2018-2021 by Marijn Haverbeke <marijn@haverbeke.berlin> and others
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.cjs

@@ -229,13 +229,13 @@ function syntaxParserRunning(view) {
 }
 // Lezer-style Input object for a Text document.
 class DocInput {
-    constructor(doc, length = doc.length) {
+    constructor(doc) {
         this.doc = doc;
-        this.length = length;
         this.cursorPos = 0;
         this.string = "";
         this.cursor = doc.iter();
     }
+    get length() { return this.doc.length; }
     syncTo(pos) {
         this.string = this.cursor.next(pos - this.cursorPos).value;
         this.cursorPos = pos + this.string.length;
@@ -780,17 +780,18 @@ service.
 */
 const indentService = state.Facet.define();
 /**
-Facet for overriding the unit by which indentation happens.
-Should be a string consisting either entirely of spaces or
-entirely of tabs. When not set, this defaults to 2 spaces.
+Facet for overriding the unit by which indentation happens. Should
+be a string consisting either entirely of the same whitespace
+character. When not set, this defaults to 2 spaces.
 */
 const indentUnit = state.Facet.define({
     combine: values => {
         if (!values.length)
             return "  ";
-        if (!/^(?: +|\t+)$/.test(values[0]))
+        let unit = values[0];
+        if (!unit || /\S/.test(unit) || Array.from(unit).some(e => e != unit[0]))
             throw new Error("Invalid indent unit: " + JSON.stringify(values[0]));
-        return values[0];
+        return unit;
     }
 });
 /**
@@ -810,14 +811,16 @@ Will use tabs for as much of the columns as possible when the
 tabs.
 */
 function indentString(state, cols) {
-    let result = "", ts = state.tabSize;
-    if (state.facet(indentUnit).charCodeAt(0) == 9)
+    let result = "", ts = state.tabSize, ch = state.facet(indentUnit)[0];
+    if (ch == "\t") {
         while (cols >= ts) {
             result += "\t";
             cols -= ts;
         }
+        ch = " ";
+    }
     for (let i = 0; i < cols; i++)
-        result += " ";
+        result += ch;
     return result;
 }
 /**
@@ -1400,6 +1403,41 @@ const unfoldAll = view => {
     view.dispatch({ effects });
     return true;
 };
+// Find the foldable region containing the given line, if one exists
+function foldableContainer(view, lineBlock) {
+    // Look backwards through line blocks until we find a foldable region that
+    // intersects with the line
+    for (let line = lineBlock;;) {
+        let foldableRegion = foldable(view.state, line.from, line.to);
+        if (foldableRegion && foldableRegion.to > lineBlock.from)
+            return foldableRegion;
+        if (!line.from)
+            return null;
+        line = view.lineBlockAt(line.from - 1);
+    }
+}
+/**
+Toggle folding at cursors. Unfolds if there is an existing fold
+starting in that line, tries to find a foldable range around it
+otherwise.
+*/
+const toggleFold = (view) => {
+    let effects = [];
+    for (let line of selectedLines(view)) {
+        let folded = findFold(view.state, line.from, line.to);
+        if (folded) {
+            effects.push(unfoldEffect.of(folded), announceFold(view, folded, false));
+        }
+        else {
+            let foldRange = foldableContainer(view, line);
+            if (foldRange)
+                effects.push(foldEffect.of(foldRange), announceFold(view, foldRange));
+        }
+    }
+    if (effects.length > 0)
+        view.dispatch({ effects: maybeEnable(view.state, effects) });
+    return !!effects.length;
+};
 /**
 Default fold-related key bindings.
 
@@ -1923,10 +1961,11 @@ class StringStream {
     /**
     The current indent unit size.
     */
-    indentUnit) {
+    indentUnit, overrideIndent) {
         this.string = string;
         this.tabSize = tabSize;
         this.indentUnit = indentUnit;
+        this.overrideIndent = overrideIndent;
         /**
         The current position on the line.
         */
@@ -2027,7 +2066,8 @@ class StringStream {
     Get the indentation column of the current line.
     */
     indentation() {
-        return countCol(this.string, null, this.tabSize);
+        var _a;
+        return (_a = this.overrideIndent) !== null && _a !== void 0 ? _a : countCol(this.string, null, this.tabSize);
     }
     /**
     Match the input against the given string or regular expression
@@ -2089,6 +2129,7 @@ function defaultCopyState(state) {
     }
     return newState;
 }
+const IndentedFrom = new WeakMap();
 /**
 A [language](https://codemirror.net/6/docs/ref/#language.Language) class based on a CodeMirror
 5-style [streaming parser](https://codemirror.net/6/docs/ref/#language.StreamParser).
@@ -2119,7 +2160,14 @@ class StreamLanguage extends Language {
             at = at.parent;
         if (!at)
             return null;
-        let start = findState(this, tree, 0, at.from, pos), statePos, state;
+        let from = undefined;
+        let { overrideIndentation } = cx.options;
+        if (overrideIndentation) {
+            from = IndentedFrom.get(cx.state);
+            if (from != null && from < pos - 1e4)
+                from = undefined;
+        }
+        let start = findState(this, tree, 0, at.from, from !== null && from !== void 0 ? from : pos), statePos, state;
         if (start) {
             state = start.state;
             statePos = start.pos + 1;
@@ -2133,7 +2181,8 @@ class StreamLanguage extends Language {
         while (statePos < pos) {
             let line = cx.state.doc.lineAt(statePos), end = Math.min(pos, line.to);
             if (line.length) {
-                let stream = new StringStream(line.text, cx.state.tabSize, cx.unit);
+                let indentation = overrideIndentation ? overrideIndentation(line.from) : -1;
+                let stream = new StringStream(line.text, cx.state.tabSize, cx.unit, indentation < 0 ? undefined : indentation);
                 while (stream.pos < end - line.from)
                     readToken(this.streamParser.token, stream, state);
             }
@@ -2144,8 +2193,10 @@ class StreamLanguage extends Language {
                 break;
             statePos = line.to + 1;
         }
-        let { text } = cx.lineAt(pos);
-        return this.streamParser.indent(state, /^\s*(.*)/.exec(text)[1], cx);
+        let line = cx.lineAt(pos);
+        if (overrideIndentation && from == null)
+            IndentedFrom.set(cx.state, line.from);
+        return this.streamParser.indent(state, /^\s*(.*)/.exec(line.text)[1], cx);
     }
     get allowsNesting() { return false; }
 }
@@ -2459,6 +2510,7 @@ exports.syntaxHighlighting = syntaxHighlighting;
 exports.syntaxParserRunning = syntaxParserRunning;
 exports.syntaxTree = syntaxTree;
 exports.syntaxTreeAvailable = syntaxTreeAvailable;
+exports.toggleFold = toggleFold;
 exports.unfoldAll = unfoldAll;
 exports.unfoldCode = unfoldCode;
 exports.unfoldEffect = unfoldEffect;

package/dist/index.d.ts

@@ -370,9 +370,9 @@ service.
 */
 declare const indentService: Facet<(context: IndentContext, pos: number) => number | null | undefined, readonly ((context: IndentContext, pos: number) => number | null | undefined)[]>;
 /**
-Facet for overriding the unit by which indentation happens.
-Should be a string consisting either entirely of spaces or
-entirely of tabs. When not set, this defaults to 2 spaces.
+Facet for overriding the unit by which indentation happens. Should
+be a string consisting either entirely of the same whitespace
+character. When not set, this defaults to 2 spaces.
 */
 declare const indentUnit: Facet<string, string>;
 /**
@@ -450,7 +450,7 @@ declare class IndentContext {
         simulateBreak?: number;
         /**
         When `simulateBreak` is given, this can be used to make the
-        simulate break behave like a double line break.
+        simulated break behave like a double line break.
         */
         simulateDoubleBreak?: boolean;
     });
@@ -678,6 +678,12 @@ Unfold all folded code.
 */
 declare const unfoldAll: Command;
 /**
+Toggle folding at cursors. Unfolds if there is an existing fold
+starting in that line, tries to find a foldable range around it
+otherwise.
+*/
+declare const toggleFold: Command;
+/**
 Default fold-related key bindings.
 
  - Ctrl-Shift-[ (Cmd-Alt-[ on macOS): [`foldCode`](https://codemirror.net/6/docs/ref/#language.foldCode).
@@ -943,6 +949,7 @@ declare class StringStream {
     The current indent unit size.
     */
     indentUnit: number;
+    private overrideIndent?;
     /**
     The current position on the line.
     */
@@ -964,7 +971,7 @@ declare class StringStream {
     /**
     The current indent unit size.
     */
-    indentUnit: number);
+    indentUnit: number, overrideIndent?: number | undefined);
     /**
     True if we are at the end of the line.
     */
@@ -1112,4 +1119,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, 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 };
+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, toggleFold, unfoldAll, unfoldCode, unfoldEffect };

package/dist/index.js

@@ -225,13 +225,13 @@ function syntaxParserRunning(view) {
 }
 // Lezer-style Input object for a Text document.
 class DocInput {
-    constructor(doc, length = doc.length) {
+    constructor(doc) {
         this.doc = doc;
-        this.length = length;
         this.cursorPos = 0;
         this.string = "";
         this.cursor = doc.iter();
     }
+    get length() { return this.doc.length; }
     syncTo(pos) {
         this.string = this.cursor.next(pos - this.cursorPos).value;
         this.cursorPos = pos + this.string.length;
@@ -776,17 +776,18 @@ service.
 */
 const indentService = /*@__PURE__*/Facet.define();
 /**
-Facet for overriding the unit by which indentation happens.
-Should be a string consisting either entirely of spaces or
-entirely of tabs. When not set, this defaults to 2 spaces.
+Facet for overriding the unit by which indentation happens. Should
+be a string consisting either entirely of the same whitespace
+character. When not set, this defaults to 2 spaces.
 */
 const indentUnit = /*@__PURE__*/Facet.define({
     combine: values => {
         if (!values.length)
             return "  ";
-        if (!/^(?: +|\t+)$/.test(values[0]))
+        let unit = values[0];
+        if (!unit || /\S/.test(unit) || Array.from(unit).some(e => e != unit[0]))
             throw new Error("Invalid indent unit: " + JSON.stringify(values[0]));
-        return values[0];
+        return unit;
     }
 });
 /**
@@ -806,14 +807,16 @@ Will use tabs for as much of the columns as possible when the
 tabs.
 */
 function indentString(state, cols) {
-    let result = "", ts = state.tabSize;
-    if (state.facet(indentUnit).charCodeAt(0) == 9)
+    let result = "", ts = state.tabSize, ch = state.facet(indentUnit)[0];
+    if (ch == "\t") {
         while (cols >= ts) {
             result += "\t";
             cols -= ts;
         }
+        ch = " ";
+    }
     for (let i = 0; i < cols; i++)
-        result += " ";
+        result += ch;
     return result;
 }
 /**
@@ -1396,6 +1399,41 @@ const unfoldAll = view => {
     view.dispatch({ effects });
     return true;
 };
+// Find the foldable region containing the given line, if one exists
+function foldableContainer(view, lineBlock) {
+    // Look backwards through line blocks until we find a foldable region that
+    // intersects with the line
+    for (let line = lineBlock;;) {
+        let foldableRegion = foldable(view.state, line.from, line.to);
+        if (foldableRegion && foldableRegion.to > lineBlock.from)
+            return foldableRegion;
+        if (!line.from)
+            return null;
+        line = view.lineBlockAt(line.from - 1);
+    }
+}
+/**
+Toggle folding at cursors. Unfolds if there is an existing fold
+starting in that line, tries to find a foldable range around it
+otherwise.
+*/
+const toggleFold = (view) => {
+    let effects = [];
+    for (let line of selectedLines(view)) {
+        let folded = findFold(view.state, line.from, line.to);
+        if (folded) {
+            effects.push(unfoldEffect.of(folded), announceFold(view, folded, false));
+        }
+        else {
+            let foldRange = foldableContainer(view, line);
+            if (foldRange)
+                effects.push(foldEffect.of(foldRange), announceFold(view, foldRange));
+        }
+    }
+    if (effects.length > 0)
+        view.dispatch({ effects: maybeEnable(view.state, effects) });
+    return !!effects.length;
+};
 /**
 Default fold-related key bindings.
 
@@ -1919,10 +1957,11 @@ class StringStream {
     /**
     The current indent unit size.
     */
-    indentUnit) {
+    indentUnit, overrideIndent) {
         this.string = string;
         this.tabSize = tabSize;
         this.indentUnit = indentUnit;
+        this.overrideIndent = overrideIndent;
         /**
         The current position on the line.
         */
@@ -2023,7 +2062,8 @@ class StringStream {
     Get the indentation column of the current line.
     */
     indentation() {
-        return countCol(this.string, null, this.tabSize);
+        var _a;
+        return (_a = this.overrideIndent) !== null && _a !== void 0 ? _a : countCol(this.string, null, this.tabSize);
     }
     /**
     Match the input against the given string or regular expression
@@ -2085,6 +2125,7 @@ function defaultCopyState(state) {
     }
     return newState;
 }
+const IndentedFrom = /*@__PURE__*/new WeakMap();
 /**
 A [language](https://codemirror.net/6/docs/ref/#language.Language) class based on a CodeMirror
 5-style [streaming parser](https://codemirror.net/6/docs/ref/#language.StreamParser).
@@ -2115,7 +2156,14 @@ class StreamLanguage extends Language {
             at = at.parent;
         if (!at)
             return null;
-        let start = findState(this, tree, 0, at.from, pos), statePos, state;
+        let from = undefined;
+        let { overrideIndentation } = cx.options;
+        if (overrideIndentation) {
+            from = IndentedFrom.get(cx.state);
+            if (from != null && from < pos - 1e4)
+                from = undefined;
+        }
+        let start = findState(this, tree, 0, at.from, from !== null && from !== void 0 ? from : pos), statePos, state;
         if (start) {
             state = start.state;
             statePos = start.pos + 1;
@@ -2129,7 +2177,8 @@ class StreamLanguage extends Language {
         while (statePos < pos) {
             let line = cx.state.doc.lineAt(statePos), end = Math.min(pos, line.to);
             if (line.length) {
-                let stream = new StringStream(line.text, cx.state.tabSize, cx.unit);
+                let indentation = overrideIndentation ? overrideIndentation(line.from) : -1;
+                let stream = new StringStream(line.text, cx.state.tabSize, cx.unit, indentation < 0 ? undefined : indentation);
                 while (stream.pos < end - line.from)
                     readToken(this.streamParser.token, stream, state);
             }
@@ -2140,8 +2189,10 @@ class StreamLanguage extends Language {
                 break;
             statePos = line.to + 1;
         }
-        let { text } = cx.lineAt(pos);
-        return this.streamParser.indent(state, /^\s*(.*)/.exec(text)[1], cx);
+        let line = cx.lineAt(pos);
+        if (overrideIndentation && from == null)
+            IndentedFrom.set(cx.state, line.from);
+        return this.streamParser.indent(state, /^\s*(.*)/.exec(line.text)[1], cx);
     }
     get allowsNesting() { return false; }
 }
@@ -2408,4 +2459,4 @@ function docID(data) {
     return type;
 }
 
-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 };
+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, toggleFold, unfoldAll, unfoldCode, unfoldEffect };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/language",
-  "version": "6.4.0",
+  "version": "6.5.0",
   "description": "Language support infrastructure for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",
@@ -12,7 +12,7 @@
   ],
   "author": {
     "name": "Marijn Haverbeke",
-    "email": "marijnh@gmail.com",
+    "email": "marijn@haverbeke.berlin",
     "url": "http://marijnhaverbeke.nl"
   },
   "type": "module",