@codemirror/lint 6.5.0 → 6.7.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.7.0 (2024-04-30)
+
+### New features
+
+The `renderMessage` function is now called with the editor view as first argument.
+
+## 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

package/dist/index.cjs

@@ -50,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));
@@ -263,7 +267,8 @@ const lintConfig = state.Facet.define({
             delay: 750,
             markerFilter: null,
             tooltipFilter: null,
-            needsRefresh: null
+            needsRefresh: null,
+            hideOn: () => null,
         }, {
             needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
@@ -309,7 +314,7 @@ function assignKeys(actions) {
 function renderDiagnostic(view, diagnostic, inPanel) {
     var _a;
     let keys = inPanel ? assignKeys(diagnostic.actions) : [];
-    return elt("li", { class: "cm-diagnostic cm-diagnostic-" + diagnostic.severity }, elt("span", { class: "cm-diagnosticText" }, diagnostic.renderMessage ? diagnostic.renderMessage() : diagnostic.message), (_a = diagnostic.actions) === null || _a === void 0 ? void 0 : _a.map((action, i) => {
+    return elt("li", { class: "cm-diagnostic cm-diagnostic-" + diagnostic.severity }, elt("span", { class: "cm-diagnosticText" }, diagnostic.renderMessage ? diagnostic.renderMessage(view) : diagnostic.message), (_a = diagnostic.actions) === null || _a === void 0 ? void 0 : _a.map((action, i) => {
         let fired = false, click = (e) => {
             e.preventDefault();
             if (fired)

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";
@@ -40,7 +40,7 @@ interface Diagnostic {
     An optional custom rendering function that displays the message
     as a DOM node.
     */
-    renderMessage?: () => Node;
+    renderMessage?: (view: EditorView) => Node;
     /**
     An optional array of actions that can be taken on this
     diagnostic.
@@ -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 {
     /**

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";
@@ -40,7 +40,7 @@ interface Diagnostic {
     An optional custom rendering function that displays the message
     as a DOM node.
     */
-    renderMessage?: () => Node;
+    renderMessage?: (view: EditorView) => Node;
     /**
     An optional array of actions that can be taken on this
     diagnostic.
@@ -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 {
     /**

package/dist/index.js

@@ -48,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));
@@ -261,7 +265,8 @@ const lintConfig = /*@__PURE__*/Facet.define({
             delay: 750,
             markerFilter: null,
             tooltipFilter: null,
-            needsRefresh: null
+            needsRefresh: null,
+            hideOn: () => null,
         }, {
             needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
@@ -307,7 +312,7 @@ function assignKeys(actions) {
 function renderDiagnostic(view, diagnostic, inPanel) {
     var _a;
     let keys = inPanel ? assignKeys(diagnostic.actions) : [];
-    return elt("li", { class: "cm-diagnostic cm-diagnostic-" + diagnostic.severity }, elt("span", { class: "cm-diagnosticText" }, diagnostic.renderMessage ? diagnostic.renderMessage() : diagnostic.message), (_a = diagnostic.actions) === null || _a === void 0 ? void 0 : _a.map((action, i) => {
+    return elt("li", { class: "cm-diagnostic cm-diagnostic-" + diagnostic.severity }, elt("span", { class: "cm-diagnosticText" }, diagnostic.renderMessage ? diagnostic.renderMessage(view) : diagnostic.message), (_a = diagnostic.actions) === null || _a === void 0 ? void 0 : _a.map((action, i) => {
         let fired = false, click = (e) => {
             e.preventDefault();
             if (fired)

package/package.json

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