@codemirror/lint 6.7.1 → 6.8.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.8.1 (2024-06-19)
+
+### Bug fixes
+
+Make lint markers non-inclusive again, since having them that way causes more issues than it solves.
+
+## 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

package/dist/index.cjs

@@ -32,8 +32,7 @@ class LintState {
                 }).range(d.from)
                 : view.Decoration.mark({
                     attributes: { class: "cm-lintRange cm-lintRange-" + d.severity + (d.markClass ? " " + d.markClass : "") },
-                    diagnostic: d,
-                    inclusive: true
+                    diagnostic: d
                 }).range(d.from, d.to);
         }), true);
         return new LintState(ranges, panel, findDiagnostic(ranges));
@@ -82,17 +81,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);
@@ -113,7 +115,7 @@ function diagnosticCount(state) {
     let lint = state.field(lintState, false);
     return lint ? lint.diagnostics.size : 0;
 }
-const activeMark = view.Decoration.mark({ class: "cm-lintRange cm-lintRange-active", inclusive: true });
+const activeMark = view.Decoration.mark({ class: "cm-lintRange cm-lintRange-active" });
 function lintTooltip(view, pos, side) {
     let { diagnostics } = view.state.field(lintState);
     let found = [], stackStart = 2e8, stackEnd = 0;

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

@@ -30,8 +30,7 @@ class LintState {
                 }).range(d.from)
                 : Decoration.mark({
                     attributes: { class: "cm-lintRange cm-lintRange-" + d.severity + (d.markClass ? " " + d.markClass : "") },
-                    diagnostic: d,
-                    inclusive: true
+                    diagnostic: d
                 }).range(d.from, d.to);
         }), true);
         return new LintState(ranges, panel, findDiagnostic(ranges));
@@ -80,17 +79,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);
@@ -111,7 +113,7 @@ function diagnosticCount(state) {
     let lint = state.field(lintState, false);
     return lint ? lint.diagnostics.size : 0;
 }
-const activeMark = /*@__PURE__*/Decoration.mark({ class: "cm-lintRange cm-lintRange-active", inclusive: true });
+const activeMark = /*@__PURE__*/Decoration.mark({ class: "cm-lintRange cm-lintRange-active" });
 function lintTooltip(view, pos, side) {
     let { diagnostics } = view.state.field(lintState);
     let found = [], stackStart = 2e8, stackEnd = 0;

package/package.json

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