@codemirror/lint 6.4.2 → 6.6.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 6.6.0 (2024-04-29)
+
+### New features
+
+The new `hideOn` configuration option can be used to control in what circumstances lint tooltips get hidden by state changes.
+
+## 6.5.0 (2024-01-30)
+
+### Bug fixes
+
+Make lint mark decorations inclusive, so that they are applied even if the marked content is replaced by a widget decoration.
+
+### New features
+
+`linter` can now be called with null as source to only provide a configuration.
+
+`markerFilter` and `tooltipFilter` function now get passed the current editor state.
+
 ## 6.4.2 (2023-09-14)
 
 ### Bug fixes

package/dist/index.cjs

@@ -22,7 +22,7 @@ class LintState {
         let markedDiagnostics = diagnostics;
         let diagnosticFilter = state.facet(lintConfig).markerFilter;
         if (diagnosticFilter)
-            markedDiagnostics = diagnosticFilter(markedDiagnostics);
+            markedDiagnostics = diagnosticFilter(markedDiagnostics, state);
         let ranges = view.Decoration.set(markedDiagnostics.map((d) => {
             // For zero-length ranges or ranges covering only a line break, create a widget
             return d.from == d.to || (d.from == d.to - 1 && state.doc.lineAt(d.from).to == d.from)
@@ -32,7 +32,8 @@ class LintState {
                 }).range(d.from)
                 : view.Decoration.mark({
                     attributes: { class: "cm-lintRange cm-lintRange-" + d.severity + (d.markClass ? " " + d.markClass : "") },
-                    diagnostic: d
+                    diagnostic: d,
+                    inclusive: true
                 }).range(d.from, d.to);
         }), true);
         return new LintState(ranges, panel, findDiagnostic(ranges));
@@ -49,8 +50,12 @@ function findDiagnostic(diagnostics, diagnostic = null, after = 0) {
     return found;
 }
 function hideTooltip(tr, tooltip) {
+    let from = tooltip.pos, to = tooltip.end || from;
+    let result = tr.state.facet(lintConfig).hideOn(tr, from, to);
+    if (result != null)
+        return result;
     let line = tr.startState.doc.lineAt(tooltip.pos);
-    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(line.from, line.to));
+    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(line.from, Math.max(line.to, to)));
 }
 function maybeEnableLint(state$1, effects) {
     return state$1.field(lintState, false) ? effects : effects.concat(state.StateEffect.appendConfig.of(lintExtensions));
@@ -108,7 +113,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" });
+const activeMark = view.Decoration.mark({ class: "cm-lintRange cm-lintRange-active", inclusive: true });
 function lintTooltip(view, pos, side) {
     let { diagnostics } = view.state.field(lintState);
     let found = [], stackStart = 2e8, stackEnd = 0;
@@ -122,7 +127,7 @@ function lintTooltip(view, pos, side) {
     });
     let diagnosticFilter = view.state.facet(lintConfig).tooltipFilter;
     if (diagnosticFilter)
-        found = diagnosticFilter(found);
+        found = diagnosticFilter(found, view.state);
     if (!found.length)
         return null;
     return {
@@ -227,11 +232,12 @@ const lintPlugin = view.ViewPlugin.fromClass(class {
         else {
             this.set = false;
             let { state } = this.view, { sources } = state.facet(lintConfig);
-            Promise.all(sources.map(source => Promise.resolve(source(this.view)))).then(annotations => {
-                let all = annotations.reduce((a, b) => a.concat(b));
-                if (this.view.state.doc == state.doc)
-                    this.view.dispatch(setDiagnostics(this.view.state, all));
-            }, error => { view.logException(this.view.state, error); });
+            if (sources.length)
+                Promise.all(sources.map(source => Promise.resolve(source(this.view)))).then(annotations => {
+                    let all = annotations.reduce((a, b) => a.concat(b));
+                    if (this.view.state.doc == state.doc)
+                        this.view.dispatch(setDiagnostics(this.view.state, all));
+                }, error => { view.logException(this.view.state, error); });
         }
     }
     update(update) {
@@ -257,11 +263,12 @@ const lintPlugin = view.ViewPlugin.fromClass(class {
 });
 const lintConfig = state.Facet.define({
     combine(input) {
-        return Object.assign({ sources: input.map(i => i.source) }, state.combineConfig(input.map(i => i.config), {
+        return Object.assign({ sources: input.map(i => i.source).filter(x => x != null) }, state.combineConfig(input.map(i => i.config), {
             delay: 750,
             markerFilter: null,
             tooltipFilter: null,
-            needsRefresh: null
+            needsRefresh: null,
+            hideOn: () => null,
         }, {
             needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
@@ -270,7 +277,8 @@ const lintConfig = state.Facet.define({
 /**
 Given a diagnostic source, this function returns an extension that
 enables linting with that source. It will be called whenever the
-editor is idle (after its content changed).
+editor is idle (after its content changed). If `null` is given as
+source, this only configures the lint extension.
 */
 function linter(source, config = {}) {
     return [
@@ -628,7 +636,7 @@ class LintGutterMarker extends view.GutterMarker {
         let diagnostics = this.diagnostics;
         let diagnosticsFilter = view.state.facet(lintGutterConfig).tooltipFilter;
         if (diagnosticsFilter)
-            diagnostics = diagnosticsFilter(diagnostics);
+            diagnostics = diagnosticsFilter(diagnostics, view.state);
         if (diagnostics.length)
             elt.onmouseover = () => gutterMarkerMouseOver(view, elt, diagnostics);
         return elt;
@@ -707,7 +715,7 @@ const lintGutterMarkers = state.StateField.define({
             if (effect.is(setDiagnosticsEffect)) {
                 let diagnostics = effect.value;
                 if (diagnosticFilter)
-                    diagnostics = diagnosticFilter(diagnostics || []);
+                    diagnostics = diagnosticFilter(diagnostics || [], tr.state);
                 markers = markersForDiagnostics(tr.state.doc, diagnostics.slice(0));
             }
         }

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _codemirror_state from '@codemirror/state';
-import { EditorState, TransactionSpec, Extension } from '@codemirror/state';
+import { EditorState, TransactionSpec, Extension, Transaction } from '@codemirror/state';
 import { EditorView, Command, KeyBinding, ViewUpdate } from '@codemirror/view';
 
 type Severity = "hint" | "info" | "warning" | "error";
@@ -62,7 +62,7 @@ interface Action {
     */
     apply: (view: EditorView, from: number, to: number) => void;
 }
-type DiagnosticFilter = (diagnostics: readonly Diagnostic[]) => Diagnostic[];
+type DiagnosticFilter = (diagnostics: readonly Diagnostic[], state: EditorState) => Diagnostic[];
 interface LintConfig {
     /**
     Time to wait (in milliseconds) after a change before running
@@ -85,6 +85,14 @@ interface LintConfig {
     tooltip will appear if the empty set is returned.
     */
     tooltipFilter?: null | DiagnosticFilter;
+    /**
+    Can be used to control what kind of transactions cause lint
+    hover tooltips associated with the given document range to be
+    hidden. By default any transactions that changes the line
+    around the range will hide it. Returning null falls back to this
+    behavior.
+    */
+    hideOn?: (tr: Transaction, from: number, to: number) => boolean | null;
 }
 interface LintGutterConfig {
     /**
@@ -147,9 +155,10 @@ type LintSource = (view: EditorView) => readonly Diagnostic[] | Promise<readonly
 /**
 Given a diagnostic source, this function returns an extension that
 enables linting with that source. It will be called whenever the
-editor is idle (after its content changed).
+editor is idle (after its content changed). If `null` is given as
+source, this only configures the lint extension.
 */
-declare function linter(source: LintSource, config?: LintConfig): Extension;
+declare function linter(source: LintSource | null, config?: LintConfig): Extension;
 /**
 Forces any linters [configured](https://codemirror.net/6/docs/ref/#lint.linter) to run when the
 editor is idle to run right away.
@@ -170,4 +179,4 @@ arguments hold the diagnostic's current position.
 */
 declare function forEachDiagnostic(state: EditorState, f: (d: Diagnostic, from: number, to: number) => void): void;
 
-export { Action, Diagnostic, LintSource, closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };
+export { type Action, type Diagnostic, type LintSource, closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _codemirror_state from '@codemirror/state';
-import { EditorState, TransactionSpec, Extension } from '@codemirror/state';
+import { EditorState, TransactionSpec, Extension, Transaction } from '@codemirror/state';
 import { EditorView, Command, KeyBinding, ViewUpdate } from '@codemirror/view';
 
 type Severity = "hint" | "info" | "warning" | "error";
@@ -62,7 +62,7 @@ interface Action {
     */
     apply: (view: EditorView, from: number, to: number) => void;
 }
-type DiagnosticFilter = (diagnostics: readonly Diagnostic[]) => Diagnostic[];
+type DiagnosticFilter = (diagnostics: readonly Diagnostic[], state: EditorState) => Diagnostic[];
 interface LintConfig {
     /**
     Time to wait (in milliseconds) after a change before running
@@ -85,6 +85,14 @@ interface LintConfig {
     tooltip will appear if the empty set is returned.
     */
     tooltipFilter?: null | DiagnosticFilter;
+    /**
+    Can be used to control what kind of transactions cause lint
+    hover tooltips associated with the given document range to be
+    hidden. By default any transactions that changes the line
+    around the range will hide it. Returning null falls back to this
+    behavior.
+    */
+    hideOn?: (tr: Transaction, from: number, to: number) => boolean | null;
 }
 interface LintGutterConfig {
     /**
@@ -147,9 +155,10 @@ type LintSource = (view: EditorView) => readonly Diagnostic[] | Promise<readonly
 /**
 Given a diagnostic source, this function returns an extension that
 enables linting with that source. It will be called whenever the
-editor is idle (after its content changed).
+editor is idle (after its content changed). If `null` is given as
+source, this only configures the lint extension.
 */
-declare function linter(source: LintSource, config?: LintConfig): Extension;
+declare function linter(source: LintSource | null, config?: LintConfig): Extension;
 /**
 Forces any linters [configured](https://codemirror.net/6/docs/ref/#lint.linter) to run when the
 editor is idle to run right away.
@@ -170,4 +179,4 @@ arguments hold the diagnostic's current position.
 */
 declare function forEachDiagnostic(state: EditorState, f: (d: Diagnostic, from: number, to: number) => void): void;
 
-export { Action, Diagnostic, LintSource, closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };
+export { type Action, type Diagnostic, type LintSource, closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };

package/dist/index.js

@@ -20,7 +20,7 @@ class LintState {
         let markedDiagnostics = diagnostics;
         let diagnosticFilter = state.facet(lintConfig).markerFilter;
         if (diagnosticFilter)
-            markedDiagnostics = diagnosticFilter(markedDiagnostics);
+            markedDiagnostics = diagnosticFilter(markedDiagnostics, state);
         let ranges = Decoration.set(markedDiagnostics.map((d) => {
             // For zero-length ranges or ranges covering only a line break, create a widget
             return d.from == d.to || (d.from == d.to - 1 && state.doc.lineAt(d.from).to == d.from)
@@ -30,7 +30,8 @@ class LintState {
                 }).range(d.from)
                 : Decoration.mark({
                     attributes: { class: "cm-lintRange cm-lintRange-" + d.severity + (d.markClass ? " " + d.markClass : "") },
-                    diagnostic: d
+                    diagnostic: d,
+                    inclusive: true
                 }).range(d.from, d.to);
         }), true);
         return new LintState(ranges, panel, findDiagnostic(ranges));
@@ -47,8 +48,12 @@ function findDiagnostic(diagnostics, diagnostic = null, after = 0) {
     return found;
 }
 function hideTooltip(tr, tooltip) {
+    let from = tooltip.pos, to = tooltip.end || from;
+    let result = tr.state.facet(lintConfig).hideOn(tr, from, to);
+    if (result != null)
+        return result;
     let line = tr.startState.doc.lineAt(tooltip.pos);
-    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(line.from, line.to));
+    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(line.from, Math.max(line.to, to)));
 }
 function maybeEnableLint(state, effects) {
     return state.field(lintState, false) ? effects : effects.concat(StateEffect.appendConfig.of(lintExtensions));
@@ -106,7 +111,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" });
+const activeMark = /*@__PURE__*/Decoration.mark({ class: "cm-lintRange cm-lintRange-active", inclusive: true });
 function lintTooltip(view, pos, side) {
     let { diagnostics } = view.state.field(lintState);
     let found = [], stackStart = 2e8, stackEnd = 0;
@@ -120,7 +125,7 @@ function lintTooltip(view, pos, side) {
     });
     let diagnosticFilter = view.state.facet(lintConfig).tooltipFilter;
     if (diagnosticFilter)
-        found = diagnosticFilter(found);
+        found = diagnosticFilter(found, view.state);
     if (!found.length)
         return null;
     return {
@@ -225,11 +230,12 @@ const lintPlugin = /*@__PURE__*/ViewPlugin.fromClass(class {
         else {
             this.set = false;
             let { state } = this.view, { sources } = state.facet(lintConfig);
-            Promise.all(sources.map(source => Promise.resolve(source(this.view)))).then(annotations => {
-                let all = annotations.reduce((a, b) => a.concat(b));
-                if (this.view.state.doc == state.doc)
-                    this.view.dispatch(setDiagnostics(this.view.state, all));
-            }, error => { logException(this.view.state, error); });
+            if (sources.length)
+                Promise.all(sources.map(source => Promise.resolve(source(this.view)))).then(annotations => {
+                    let all = annotations.reduce((a, b) => a.concat(b));
+                    if (this.view.state.doc == state.doc)
+                        this.view.dispatch(setDiagnostics(this.view.state, all));
+                }, error => { logException(this.view.state, error); });
         }
     }
     update(update) {
@@ -255,11 +261,12 @@ const lintPlugin = /*@__PURE__*/ViewPlugin.fromClass(class {
 });
 const lintConfig = /*@__PURE__*/Facet.define({
     combine(input) {
-        return Object.assign({ sources: input.map(i => i.source) }, combineConfig(input.map(i => i.config), {
+        return Object.assign({ sources: input.map(i => i.source).filter(x => x != null) }, combineConfig(input.map(i => i.config), {
             delay: 750,
             markerFilter: null,
             tooltipFilter: null,
-            needsRefresh: null
+            needsRefresh: null,
+            hideOn: () => null,
         }, {
             needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
@@ -268,7 +275,8 @@ const lintConfig = /*@__PURE__*/Facet.define({
 /**
 Given a diagnostic source, this function returns an extension that
 enables linting with that source. It will be called whenever the
-editor is idle (after its content changed).
+editor is idle (after its content changed). If `null` is given as
+source, this only configures the lint extension.
 */
 function linter(source, config = {}) {
     return [
@@ -626,7 +634,7 @@ class LintGutterMarker extends GutterMarker {
         let diagnostics = this.diagnostics;
         let diagnosticsFilter = view.state.facet(lintGutterConfig).tooltipFilter;
         if (diagnosticsFilter)
-            diagnostics = diagnosticsFilter(diagnostics);
+            diagnostics = diagnosticsFilter(diagnostics, view.state);
         if (diagnostics.length)
             elt.onmouseover = () => gutterMarkerMouseOver(view, elt, diagnostics);
         return elt;
@@ -705,7 +713,7 @@ const lintGutterMarkers = /*@__PURE__*/StateField.define({
             if (effect.is(setDiagnosticsEffect)) {
                 let diagnostics = effect.value;
                 if (diagnosticFilter)
-                    diagnostics = diagnosticFilter(diagnostics || []);
+                    diagnostics = diagnosticFilter(diagnostics || [], tr.state);
                 markers = markersForDiagnostics(tr.state.doc, diagnostics.slice(0));
             }
         }

package/package.json

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