@codemirror/lint 6.7.0 → 6.8.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.8.0 (2024-05-23)
+
+### New features
+
+The new `autoPanel` option can be used to make the panel automatically appear when diagnostics are added and close when no diagnostics are left.
+
+## 6.7.1 (2024-05-15)
+
+### Bug fixes
+
+Don't perform an additional superfluous timed lint run after `forceLinting` has been called.
+
 ## 6.7.0 (2024-04-30)
 
 ### New features

package/dist/index.cjs

@@ -82,17 +82,20 @@ const lintState = state.StateField.define({
         return new LintState(view.Decoration.none, null, null);
     },
     update(value, tr) {
-        if (tr.docChanged) {
-            let mapped = value.diagnostics.map(tr.changes), selected = null;
+        if (tr.docChanged && value.diagnostics.size) {
+            let mapped = value.diagnostics.map(tr.changes), selected = null, panel = value.panel;
             if (value.selected) {
                 let selPos = tr.changes.mapPos(value.selected.from, 1);
                 selected = findDiagnostic(mapped, value.selected.diagnostic, selPos) || findDiagnostic(mapped, null, selPos);
             }
-            value = new LintState(mapped, value.panel, selected);
+            if (!mapped.size && panel && tr.state.facet(lintConfig).autoPanel)
+                panel = null;
+            value = new LintState(mapped, panel, selected);
         }
         for (let effect of tr.effects) {
             if (effect.is(setDiagnosticsEffect)) {
-                value = LintState.init(effect.value, value.panel, tr.state);
+                let panel = !tr.state.facet(lintConfig).autoPanel ? value.panel : effect.value.length ? LintPanel.open : null;
+                value = LintState.init(effect.value, panel, tr.state);
             }
             else if (effect.is(togglePanel)) {
                 value = new LintState(value.diagnostics, effect.value ? LintPanel.open : null, value.selected);
@@ -225,6 +228,7 @@ const lintPlugin = view.ViewPlugin.fromClass(class {
         this.timeout = setTimeout(this.run, delay);
     }
     run() {
+        clearTimeout(this.timeout);
         let now = Date.now();
         if (now < this.lintTime - 10) {
             this.timeout = setTimeout(this.run, this.lintTime - now);

package/dist/index.d.cts

@@ -93,6 +93,12 @@ interface LintConfig {
     behavior.
     */
     hideOn?: (tr: Transaction, from: number, to: number) => boolean | null;
+    /**
+    When enabled (defaults to off), this will cause the lint panel
+    to automatically open when diagnostics are found, and close when
+    all diagnostics are resolved or removed.
+    */
+    autoPanel?: boolean;
 }
 interface LintGutterConfig {
     /**

package/dist/index.d.ts

@@ -93,6 +93,12 @@ interface LintConfig {
     behavior.
     */
     hideOn?: (tr: Transaction, from: number, to: number) => boolean | null;
+    /**
+    When enabled (defaults to off), this will cause the lint panel
+    to automatically open when diagnostics are found, and close when
+    all diagnostics are resolved or removed.
+    */
+    autoPanel?: boolean;
 }
 interface LintGutterConfig {
     /**

package/dist/index.js

@@ -80,17 +80,20 @@ const lintState = /*@__PURE__*/StateField.define({
         return new LintState(Decoration.none, null, null);
     },
     update(value, tr) {
-        if (tr.docChanged) {
-            let mapped = value.diagnostics.map(tr.changes), selected = null;
+        if (tr.docChanged && value.diagnostics.size) {
+            let mapped = value.diagnostics.map(tr.changes), selected = null, panel = value.panel;
             if (value.selected) {
                 let selPos = tr.changes.mapPos(value.selected.from, 1);
                 selected = findDiagnostic(mapped, value.selected.diagnostic, selPos) || findDiagnostic(mapped, null, selPos);
             }
-            value = new LintState(mapped, value.panel, selected);
+            if (!mapped.size && panel && tr.state.facet(lintConfig).autoPanel)
+                panel = null;
+            value = new LintState(mapped, panel, selected);
         }
         for (let effect of tr.effects) {
             if (effect.is(setDiagnosticsEffect)) {
-                value = LintState.init(effect.value, value.panel, tr.state);
+                let panel = !tr.state.facet(lintConfig).autoPanel ? value.panel : effect.value.length ? LintPanel.open : null;
+                value = LintState.init(effect.value, panel, tr.state);
             }
             else if (effect.is(togglePanel)) {
                 value = new LintState(value.diagnostics, effect.value ? LintPanel.open : null, value.selected);
@@ -223,6 +226,7 @@ const lintPlugin = /*@__PURE__*/ViewPlugin.fromClass(class {
         this.timeout = setTimeout(this.run, delay);
     }
     run() {
+        clearTimeout(this.timeout);
         let now = Date.now();
         if (now < this.lintTime - 10) {
             this.timeout = setTimeout(this.run, this.lintTime - now);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/lint",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "Linting support for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",