@codemirror/language 0.19.5 → 0.19.6

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.19.6 (2021-11-26)
+
+### Bug fixes
+
+Fixes an issue where the background parse work would be scheduled too aggressively, degrading responsiveness on a newly-created editor with a large document.
+
+Improve initial highlight for mixed-language editors and limit the amount of parsing done on state creation for faster startup.
+
 ## 0.19.5 (2021-11-17)
 
 ### New features

package/dist/index.cjs

@@ -301,12 +301,12 @@ class ParseContext {
         }
         return this.withContext(() => {
             var _a;
+            let endTime = Date.now() + time;
             if (!this.parse)
                 this.parse = this.startParse();
             if (upto != null && (this.parse.stoppedAt == null || this.parse.stoppedAt > upto) &&
                 upto < this.state.doc.length)
                 this.parse.stopAt(upto);
-            let endTime = Date.now() + time;
             for (;;) {
                 let done = this.parse.advance();
                 if (done) {
@@ -329,10 +329,11 @@ class ParseContext {
     */
     takeTree() {
         let pos, tree;
-        if (this.parse && (pos = this.parse.parsedPos) > this.treeLen) {
+        if (this.parse && (pos = this.parse.parsedPos) >= this.treeLen) {
             if (this.parse.stoppedAt == null || this.parse.stoppedAt > pos)
                 this.parse.stopAt(pos);
             this.withContext(() => { while (!(tree = this.parse.advance())) { } });
+            this.treeLen = pos;
             this.tree = tree;
             this.fragments = this.withoutTempSkipped(common.TreeFragment.addTree(this.tree, this.fragments, true));
             this.parse = null;
@@ -450,12 +451,6 @@ class ParseContext {
     /**
     @internal
     */
-    movedPast(pos) {
-        return this.treeLen < pos && this.parse && this.parse.parsedPos >= pos;
-    }
-    /**
-    @internal
-    */
     isDone(upto) {
         let frags = this.fragments;
         return this.treeLen >= upto && frags.length && frags[0].from == 0 && frags[0].to >= upto;
@@ -486,13 +481,14 @@ class LanguageState {
         // state updates with parse work beyond the viewport.
         let upto = this.context.treeLen == tr.startState.doc.length ? undefined
             : Math.max(tr.changes.mapPos(this.context.treeLen), newCx.viewport.to);
-        if (!newCx.work(25 /* Apply */, upto))
+        if (!newCx.work(20 /* Apply */, upto))
             newCx.takeTree();
         return new LanguageState(newCx);
     }
     static init(state) {
-        let parseState = new ParseContext(state.facet(language).parser, state, [], common.Tree.empty, 0, { from: 0, to: state.doc.length }, [], null);
-        if (!parseState.work(25 /* Apply */))
+        let vpTo = Math.min(3000 /* InitViewport */, state.doc.length);
+        let parseState = new ParseContext(state.facet(language).parser, state, [], common.Tree.empty, 0, { from: 0, to: vpTo }, [], null);
+        if (!parseState.work(20 /* Apply */, vpTo))
             parseState.takeTree();
         return new LanguageState(parseState);
     }
@@ -508,13 +504,21 @@ Language.state = state.StateField.define({
         return value.apply(tr);
     }
 });
-let requestIdle = typeof window != "undefined" && window.requestIdleCallback ||
-    ((callback, { timeout }) => setTimeout(callback, timeout));
-let cancelIdle = typeof window != "undefined" && window.cancelIdleCallback || clearTimeout;
+let requestIdle = (callback) => {
+    let timeout = setTimeout(() => callback(), 500 /* MaxPause */);
+    return () => clearTimeout(timeout);
+};
+if (typeof requestIdleCallback != "undefined")
+    requestIdle = (callback) => {
+        let idle = -1, timeout = setTimeout(() => {
+            idle = requestIdleCallback(callback, { timeout: 500 /* MaxPause */ - 100 /* MinPause */ });
+        }, 100 /* MinPause */);
+        return () => idle < 0 ? clearTimeout(timeout) : cancelIdleCallback(idle);
+    };
 const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
     constructor(view) {
         this.view = view;
-        this.working = -1;
+        this.working = null;
         this.workScheduled = 0;
         // End of the current time chunk
         this.chunkEnd = -1;
@@ -535,14 +539,14 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
         this.checkAsyncSchedule(cx);
     }
     scheduleWork() {
-        if (this.working > -1)
+        if (this.working)
             return;
         let { state } = this.view, field = state.field(Language.state);
         if (field.tree != field.context.tree || !field.context.isDone(state.doc.length))
-            this.working = requestIdle(this.work, { timeout: 500 /* Pause */ });
+            this.working = requestIdle(this.work);
     }
     work(deadline) {
-        this.working = -1;
+        this.working = null;
         let now = Date.now();
         if (this.chunkEnd < now && (this.chunkEnd < 0 || this.view.hasFocus)) { // Start a new chunk
             this.chunkEnd = now + 30000 /* ChunkTime */;
@@ -551,16 +555,17 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
         if (this.chunkBudget <= 0)
             return; // No more budget
         let { state, viewport: { to: vpTo } } = this.view, field = state.field(Language.state);
-        if (field.tree == field.context.tree && field.context.treeLen >= vpTo + 1000000 /* MaxParseAhead */)
+        if (field.tree == field.context.tree && field.context.treeLen >= vpTo + 100000 /* MaxParseAhead */)
             return;
-        let time = Math.min(this.chunkBudget, deadline ? Math.max(25 /* MinSlice */, deadline.timeRemaining()) : 100 /* Slice */);
-        let done = field.context.work(time, vpTo + 1000000 /* MaxParseAhead */);
+        let time = Math.min(this.chunkBudget, 100 /* Slice */, deadline ? Math.max(25 /* MinSlice */, deadline.timeRemaining() - 5) : 1e9);
+        let viewportFirst = field.context.treeLen < vpTo && state.doc.length > vpTo + 1000;
+        let done = field.context.work(time, vpTo + (viewportFirst ? 0 : 100000 /* MaxParseAhead */));
         this.chunkBudget -= Date.now() - now;
-        if (done || this.chunkBudget <= 0 || field.context.movedPast(vpTo)) {
+        if (done || this.chunkBudget <= 0) {
             field.context.takeTree();
             this.view.dispatch({ effects: Language.setState.of(new LanguageState(field.context)) });
         }
-        if (!done && this.chunkBudget > 0)
+        if (this.chunkBudget > 0 && !(done && !viewportFirst))
             this.scheduleWork();
         this.checkAsyncSchedule(field.context);
     }
@@ -575,11 +580,11 @@ const parseWorker = view.ViewPlugin.fromClass(class ParseWorker {
         }
     }
     destroy() {
-        if (this.working >= 0)
-            cancelIdle(this.working);
+        if (this.working)
+            this.working();
     }
     isWorking() {
-        return this.working >= 0 || this.workScheduled > 0;
+        return this.working || this.workScheduled > 0;
     }
 }, {
     eventHandlers: { focus() { this.scheduleWork(); } }

package/dist/index.d.ts

@@ -156,7 +156,7 @@ stopped running, either because it parsed the entire document,
 because it spent too much time and was cut off, or because there
 is no language parser enabled.
 */
-declare function syntaxParserRunning(view: EditorView): boolean;
+declare function syntaxParserRunning(view: EditorView): boolean | (() => void);
 /**
 A parse context provided to parsers working on the editor content.
 */

package/dist/index.js

@@ -297,12 +297,12 @@ class ParseContext {
         }
         return this.withContext(() => {
             var _a;
+            let endTime = Date.now() + time;
             if (!this.parse)
                 this.parse = this.startParse();
             if (upto != null && (this.parse.stoppedAt == null || this.parse.stoppedAt > upto) &&
                 upto < this.state.doc.length)
                 this.parse.stopAt(upto);
-            let endTime = Date.now() + time;
             for (;;) {
                 let done = this.parse.advance();
                 if (done) {
@@ -325,10 +325,11 @@ class ParseContext {
     */
     takeTree() {
         let pos, tree;
-        if (this.parse && (pos = this.parse.parsedPos) > this.treeLen) {
+        if (this.parse && (pos = this.parse.parsedPos) >= this.treeLen) {
             if (this.parse.stoppedAt == null || this.parse.stoppedAt > pos)
                 this.parse.stopAt(pos);
             this.withContext(() => { while (!(tree = this.parse.advance())) { } });
+            this.treeLen = pos;
             this.tree = tree;
             this.fragments = this.withoutTempSkipped(TreeFragment.addTree(this.tree, this.fragments, true));
             this.parse = null;
@@ -446,12 +447,6 @@ class ParseContext {
     /**
     @internal
     */
-    movedPast(pos) {
-        return this.treeLen < pos && this.parse && this.parse.parsedPos >= pos;
-    }
-    /**
-    @internal
-    */
     isDone(upto) {
         let frags = this.fragments;
         return this.treeLen >= upto && frags.length && frags[0].from == 0 && frags[0].to >= upto;
@@ -482,13 +477,14 @@ class LanguageState {
         // state updates with parse work beyond the viewport.
         let upto = this.context.treeLen == tr.startState.doc.length ? undefined
             : Math.max(tr.changes.mapPos(this.context.treeLen), newCx.viewport.to);
-        if (!newCx.work(25 /* Apply */, upto))
+        if (!newCx.work(20 /* Apply */, upto))
             newCx.takeTree();
         return new LanguageState(newCx);
     }
     static init(state) {
-        let parseState = new ParseContext(state.facet(language).parser, state, [], Tree.empty, 0, { from: 0, to: state.doc.length }, [], null);
-        if (!parseState.work(25 /* Apply */))
+        let vpTo = Math.min(3000 /* InitViewport */, state.doc.length);
+        let parseState = new ParseContext(state.facet(language).parser, state, [], Tree.empty, 0, { from: 0, to: vpTo }, [], null);
+        if (!parseState.work(20 /* Apply */, vpTo))
             parseState.takeTree();
         return new LanguageState(parseState);
     }
@@ -504,13 +500,21 @@ Language.state = /*@__PURE__*/StateField.define({
         return value.apply(tr);
     }
 });
-let requestIdle = typeof window != "undefined" && window.requestIdleCallback ||
-    ((callback, { timeout }) => setTimeout(callback, timeout));
-let cancelIdle = typeof window != "undefined" && window.cancelIdleCallback || clearTimeout;
+let requestIdle = (callback) => {
+    let timeout = setTimeout(() => callback(), 500 /* MaxPause */);
+    return () => clearTimeout(timeout);
+};
+if (typeof requestIdleCallback != "undefined")
+    requestIdle = (callback) => {
+        let idle = -1, timeout = setTimeout(() => {
+            idle = requestIdleCallback(callback, { timeout: 500 /* MaxPause */ - 100 /* MinPause */ });
+        }, 100 /* MinPause */);
+        return () => idle < 0 ? clearTimeout(timeout) : cancelIdleCallback(idle);
+    };
 const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
     constructor(view) {
         this.view = view;
-        this.working = -1;
+        this.working = null;
         this.workScheduled = 0;
         // End of the current time chunk
         this.chunkEnd = -1;
@@ -531,14 +535,14 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
         this.checkAsyncSchedule(cx);
     }
     scheduleWork() {
-        if (this.working > -1)
+        if (this.working)
             return;
         let { state } = this.view, field = state.field(Language.state);
         if (field.tree != field.context.tree || !field.context.isDone(state.doc.length))
-            this.working = requestIdle(this.work, { timeout: 500 /* Pause */ });
+            this.working = requestIdle(this.work);
     }
     work(deadline) {
-        this.working = -1;
+        this.working = null;
         let now = Date.now();
         if (this.chunkEnd < now && (this.chunkEnd < 0 || this.view.hasFocus)) { // Start a new chunk
             this.chunkEnd = now + 30000 /* ChunkTime */;
@@ -547,16 +551,17 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
         if (this.chunkBudget <= 0)
             return; // No more budget
         let { state, viewport: { to: vpTo } } = this.view, field = state.field(Language.state);
-        if (field.tree == field.context.tree && field.context.treeLen >= vpTo + 1000000 /* MaxParseAhead */)
+        if (field.tree == field.context.tree && field.context.treeLen >= vpTo + 100000 /* MaxParseAhead */)
             return;
-        let time = Math.min(this.chunkBudget, deadline ? Math.max(25 /* MinSlice */, deadline.timeRemaining()) : 100 /* Slice */);
-        let done = field.context.work(time, vpTo + 1000000 /* MaxParseAhead */);
+        let time = Math.min(this.chunkBudget, 100 /* Slice */, deadline ? Math.max(25 /* MinSlice */, deadline.timeRemaining() - 5) : 1e9);
+        let viewportFirst = field.context.treeLen < vpTo && state.doc.length > vpTo + 1000;
+        let done = field.context.work(time, vpTo + (viewportFirst ? 0 : 100000 /* MaxParseAhead */));
         this.chunkBudget -= Date.now() - now;
-        if (done || this.chunkBudget <= 0 || field.context.movedPast(vpTo)) {
+        if (done || this.chunkBudget <= 0) {
             field.context.takeTree();
             this.view.dispatch({ effects: Language.setState.of(new LanguageState(field.context)) });
         }
-        if (!done && this.chunkBudget > 0)
+        if (this.chunkBudget > 0 && !(done && !viewportFirst))
             this.scheduleWork();
         this.checkAsyncSchedule(field.context);
     }
@@ -571,11 +576,11 @@ const parseWorker = /*@__PURE__*/ViewPlugin.fromClass(class ParseWorker {
         }
     }
     destroy() {
-        if (this.working >= 0)
-            cancelIdle(this.working);
+        if (this.working)
+            this.working();
     }
     isWorking() {
-        return this.working >= 0 || this.workScheduled > 0;
+        return this.working || this.workScheduled > 0;
     }
 }, {
     eventHandlers: { focus() { this.scheduleWork(); } }

package/package.json

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