@codemirror/language 0.20.1 → 6.1.0

package/.github/workflows/dispatch.yml

@@ -11,6 +11,6 @@ jobs:
         with:
           # You should create a personal access token and store it in your repository
           token: ${{ secrets.DISPATCH_AUTH }}
-          repo: codemirror.next
+          repo: dev
           owner: codemirror
           event_type: push

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 6.1.0 (2022-06-20)
+
+### New features
+
+The `foldState` field is now public, and can be used to serialize and deserialize the fold state.
+
+## 6.0.0 (2022-06-08)
+
+### New features
+
+The `foldingChanged` option to `foldGutter` can now be used to trigger a recomputation of the fold markers.
+
+## 0.20.2 (2022-05-20)
+
+### Bug fixes
+
+List style-mod as a dependency.
+
 ## 0.20.1 (2022-05-18)
 
 ### Bug fixes

package/README.md

@@ -1,13 +1,13 @@
 # @codemirror/language [![NPM version](https://img.shields.io/npm/v/@codemirror/language.svg)](https://www.npmjs.org/package/@codemirror/language)
 
-[ [**WEBSITE**](https://codemirror.net/6/) | [**DOCS**](https://codemirror.net/6/docs/ref/#language) | [**ISSUES**](https://github.com/codemirror/codemirror.next/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/language/blob/main/CHANGELOG.md) ]
+[ [**WEBSITE**](https://codemirror.net/) | [**DOCS**](https://codemirror.net/docs/ref/#language) | [**ISSUES**](https://github.com/codemirror/dev/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/language/blob/main/CHANGELOG.md) ]
 
 This package implements the language support infrastructure for the
-[CodeMirror](https://codemirror.net/6/) code editor.
+[CodeMirror](https://codemirror.net/) code editor.
 
-The [project page](https://codemirror.net/6/) has more information, a
-number of [examples](https://codemirror.net/6/examples/) and the
-[documentation](https://codemirror.net/6/docs/).
+The [project page](https://codemirror.net/) has more information, a
+number of [examples](https://codemirror.net/examples/) and the
+[documentation](https://codemirror.net/docs/).
 
 This code is released under an
 [MIT license](https://github.com/codemirror/language/tree/main/LICENSE).

package/dist/index.cjs

@@ -616,7 +616,10 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
     eventHandlers: { focus() { this.scheduleWork(); } }
 });
 /**
-The facet used to associate a language with an editor state.
+The facet used to associate a language with an editor state. Used
+by `Language` object's `extension` property (so you don't need to
+manually wrap your languages in this). Can be used to access the
+current language on a state.
 */
 const language = state.Facet.define({
     combine(languages) { return languages.length ? languages[0] : null; },
@@ -1204,6 +1207,13 @@ function selectedLines(view) {
     }
     return lines;
 }
+/**
+The state field that stores the folded ranges (as a [decoration
+set](https://codemirror.net/6/docs/ref/#view.DecorationSet)). Can be passed to
+[`EditorState.toJSON`](https://codemirror.net/6/docs/ref/#state.EditorState.toJSON) and
+[`fromJSON`](https://codemirror.net/6/docs/ref/#state.EditorState^fromJSON) to serialize the fold
+state.
+*/
 const foldState = state.StateField.define({
     create() {
         return view.Decoration.none;
@@ -1231,7 +1241,24 @@ const foldState = state.StateField.define({
         }
         return folded;
     },
-    provide: f => view.EditorView.decorations.from(f)
+    provide: f => view.EditorView.decorations.from(f),
+    toJSON(folded, state) {
+        let ranges = [];
+        folded.between(0, state.doc.length, (from, to) => { ranges.push(from, to); });
+        return ranges;
+    },
+    fromJSON(value) {
+        if (!Array.isArray(value) || value.length % 2)
+            throw new RangeError("Invalid JSON for fold state");
+        let ranges = [];
+        for (let i = 0; i < value.length;) {
+            let from = value[i++], to = value[i++];
+            if (typeof from != "number" || typeof to != "number")
+                throw new RangeError("Invalid JSON for fold state");
+            ranges.push(foldWidget.range(from, to));
+        }
+        return view.Decoration.set(ranges, true);
+    }
 });
 /**
 Get a [range set](https://codemirror.net/6/docs/ref/#state.RangeSet) containing the folded ranges
@@ -1380,6 +1407,7 @@ const foldGutterDefaults = {
     closedText: "›",
     markerDOM: null,
     domEventHandlers: {},
+    foldingChanged: () => false
 };
 class FoldMarker extends view.GutterMarker {
     constructor(config, open) {
@@ -1414,7 +1442,8 @@ function foldGutter(config = {}) {
             if (update.docChanged || update.viewportChanged ||
                 update.startState.facet(language) != update.state.facet(language) ||
                 update.startState.field(foldState, false) != update.state.field(foldState, false) ||
-                syntaxTree(update.startState) != syntaxTree(update.state))
+                syntaxTree(update.startState) != syntaxTree(update.state) ||
+                fullConfig.foldingChanged(update))
                 this.markers = this.buildMarkers(update.view);
         }
         buildMarkers(view) {
@@ -2247,8 +2276,8 @@ for (let [legacyName, name] of [
     ["variable-2", "variableName.special"],
     ["string-2", "string.special"],
     ["def", "variableName.definition"],
-    ["tag", "typeName"],
-    ["attribute", "propertyName"],
+    ["tag", "tagName"],
+    ["attribute", "attributeName"],
     ["type", "typeName"],
     ["builtin", "variableName.standard"],
     ["qualifier", "modifier"],
@@ -2335,6 +2364,7 @@ exports.foldInside = foldInside;
 exports.foldKeymap = foldKeymap;
 exports.foldNodeProp = foldNodeProp;
 exports.foldService = foldService;
+exports.foldState = foldState;
 exports.foldable = foldable;
 exports.foldedRanges = foldedRanges;
 exports.forceParsing = forceParsing;

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { NodeProp, Parser, Tree, TreeFragment, SyntaxNode, NodeType } from '@lezer/common';
 import { LRParser, ParserConfig } from '@lezer/lr';
 import * as _codemirror_state from '@codemirror/state';
-import { Facet, Extension, EditorState, Range } from '@codemirror/state';
-import { EditorView, DecorationSet, Command, KeyBinding, BlockInfo, Decoration } from '@codemirror/view';
+import { Facet, Extension, EditorState, StateField, Range } from '@codemirror/state';
+import { EditorView, DecorationSet, Command, KeyBinding, ViewUpdate, BlockInfo, Decoration } from '@codemirror/view';
 import { Highlighter, Tag } from '@lezer/highlight';
 import { StyleModule, StyleSpec } from 'style-mod';
 
@@ -214,7 +214,10 @@ declare class ParseContext {
     static get(): ParseContext | null;
 }
 /**
-The facet used to associate a language with an editor state.
+The facet used to associate a language with an editor state. Used
+by `Language` object's `extension` property (so you don't need to
+manually wrap your languages in this). Can be used to access the
+current language on a state.
 */
 declare const language: Facet<Language, Language | null>;
 /**
@@ -617,6 +620,14 @@ State effect that unfolds the given range (if it was folded).
 */
 declare const unfoldEffect: _codemirror_state.StateEffectType<DocRange>;
 /**
+The state field that stores the folded ranges (as a [decoration
+set](https://codemirror.net/6/docs/ref/#view.DecorationSet)). Can be passed to
+[`EditorState.toJSON`](https://codemirror.net/6/docs/ref/#state.EditorState.toJSON) and
+[`fromJSON`](https://codemirror.net/6/docs/ref/#state.EditorState^fromJSON) to serialize the fold
+state.
+*/
+declare const foldState: StateField<DecorationSet>;
+/**
 Get a [range set](https://codemirror.net/6/docs/ref/#state.RangeSet) containing the folded ranges
 in the given state.
 */
@@ -698,6 +709,11 @@ interface FoldGutterConfig {
     Supply event handlers for DOM events on this gutter.
     */
     domEventHandlers?: Handlers;
+    /**
+    When given, if this returns true for a given view update,
+    recompute the fold markers.
+    */
+    foldingChanged?: (update: ViewUpdate) => boolean;
 }
 /**
 Create an extension that registers a fold gutter, which shows a
@@ -1056,4 +1072,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, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, 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, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, unfoldAll, unfoldCode, unfoldEffect };

package/dist/index.js

@@ -612,7 +612,10 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
     eventHandlers: { focus() { this.scheduleWork(); } }
 });
 /**
-The facet used to associate a language with an editor state.
+The facet used to associate a language with an editor state. Used
+by `Language` object's `extension` property (so you don't need to
+manually wrap your languages in this). Can be used to access the
+current language on a state.
 */
 const language = /*@__PURE__*/Facet.define({
     combine(languages) { return languages.length ? languages[0] : null; },
@@ -1200,6 +1203,13 @@ function selectedLines(view) {
     }
     return lines;
 }
+/**
+The state field that stores the folded ranges (as a [decoration
+set](https://codemirror.net/6/docs/ref/#view.DecorationSet)). Can be passed to
+[`EditorState.toJSON`](https://codemirror.net/6/docs/ref/#state.EditorState.toJSON) and
+[`fromJSON`](https://codemirror.net/6/docs/ref/#state.EditorState^fromJSON) to serialize the fold
+state.
+*/
 const foldState = /*@__PURE__*/StateField.define({
     create() {
         return Decoration.none;
@@ -1227,7 +1237,24 @@ const foldState = /*@__PURE__*/StateField.define({
         }
         return folded;
     },
-    provide: f => EditorView.decorations.from(f)
+    provide: f => EditorView.decorations.from(f),
+    toJSON(folded, state) {
+        let ranges = [];
+        folded.between(0, state.doc.length, (from, to) => { ranges.push(from, to); });
+        return ranges;
+    },
+    fromJSON(value) {
+        if (!Array.isArray(value) || value.length % 2)
+            throw new RangeError("Invalid JSON for fold state");
+        let ranges = [];
+        for (let i = 0; i < value.length;) {
+            let from = value[i++], to = value[i++];
+            if (typeof from != "number" || typeof to != "number")
+                throw new RangeError("Invalid JSON for fold state");
+            ranges.push(foldWidget.range(from, to));
+        }
+        return Decoration.set(ranges, true);
+    }
 });
 /**
 Get a [range set](https://codemirror.net/6/docs/ref/#state.RangeSet) containing the folded ranges
@@ -1376,6 +1403,7 @@ const foldGutterDefaults = {
     closedText: "›",
     markerDOM: null,
     domEventHandlers: {},
+    foldingChanged: () => false
 };
 class FoldMarker extends GutterMarker {
     constructor(config, open) {
@@ -1410,7 +1438,8 @@ function foldGutter(config = {}) {
             if (update.docChanged || update.viewportChanged ||
                 update.startState.facet(language) != update.state.facet(language) ||
                 update.startState.field(foldState, false) != update.state.field(foldState, false) ||
-                syntaxTree(update.startState) != syntaxTree(update.state))
+                syntaxTree(update.startState) != syntaxTree(update.state) ||
+                fullConfig.foldingChanged(update))
                 this.markers = this.buildMarkers(update.view);
         }
         buildMarkers(view) {
@@ -2243,8 +2272,8 @@ for (let [legacyName, name] of [
     ["variable-2", "variableName.special"],
     ["string-2", "string.special"],
     ["def", "variableName.definition"],
-    ["tag", "typeName"],
-    ["attribute", "propertyName"],
+    ["tag", "tagName"],
+    ["attribute", "attributeName"],
     ["type", "typeName"],
     ["builtin", "variableName.standard"],
     ["qualifier", "modifier"],
@@ -2305,4 +2334,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, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, 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, codeFolding, continuedIndent, defaultHighlightStyle, defineLanguageFacet, delimitedIndent, ensureSyntaxTree, flatIndent, foldAll, foldCode, foldEffect, foldGutter, foldInside, foldKeymap, foldNodeProp, foldService, foldState, foldable, foldedRanges, forceParsing, getIndentUnit, getIndentation, highlightingFor, indentNodeProp, indentOnInput, indentService, indentString, indentUnit, language, languageDataProp, matchBrackets, syntaxHighlighting, syntaxParserRunning, syntaxTree, syntaxTreeAvailable, unfoldAll, unfoldCode, unfoldEffect };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/language",
-  "version": "0.20.1",
+  "version": "6.1.0",
   "description": "Language support infrastructure for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",
@@ -26,15 +26,16 @@
   "sideEffects": false,
   "license": "MIT",
   "dependencies": {
-    "@codemirror/state": "^0.20.0",
-    "@codemirror/view": "^0.20.0",
-    "@lezer/common": "^0.16.0",
-    "@lezer/highlight": "^0.16.0",
-    "@lezer/lr": "^0.16.0"
+    "@codemirror/state": "^6.0.0",
+    "@codemirror/view": "^6.0.0",
+    "@lezer/common": "^1.0.0",
+    "@lezer/highlight": "^1.0.0",
+    "@lezer/lr": "^1.0.0",
+    "style-mod": "^4.0.0"
   },
   "devDependencies": {
     "@codemirror/buildhelper": "^0.1.5",
-    "@lezer/javascript": "^0.16.0"
+    "@lezer/javascript": "^1.0.0"
   },
   "repository": {
     "type": "git",