@codemirror/lint 6.2.0 → 6.2.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 6.2.2 (2023-06-05)
+
+### Bug fixes
+
+Make sure lint gutter tooltips are properly closed when the content of their line changes.
+
+## 6.2.1 (2023-04-13)
+
+### Bug fixes
+
+The `linter` function now eagerly includes all lint-related extensions, rather than appending them to the configuration as-needed, so that turning off linting by clearing the compartment that contains it works properly.
+
 ## 6.2.0 (2023-02-27)
 
 ### New features

package/dist/index.cjs

@@ -55,20 +55,11 @@ function findDiagnostic(diagnostics, diagnostic = null, after = 0) {
     return found;
 }
 function hideTooltip(tr, tooltip) {
-    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(tooltip.pos));
+    let line = tr.startState.doc.lineAt(tooltip.pos);
+    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(line.from, line.to));
 }
 function maybeEnableLint(state$1, effects) {
-    return state$1.field(lintState, false) ? effects : effects.concat(state.StateEffect.appendConfig.of([
-        lintState,
-        view.EditorView.decorations.compute([lintState], state => {
-            let { selected, panel } = state.field(lintState);
-            return !selected || !panel || selected.from == selected.to ? view.Decoration.none : view.Decoration.set([
-                activeMark.range(selected.from, selected.to)
-            ]);
-        }),
-        view.hoverTooltip(lintTooltip, { hideOn: hideTooltip }),
-        baseTheme
-    ]));
+    return state$1.field(lintState, false) ? effects : effects.concat(state.StateEffect.appendConfig.of(lintExtensions));
 }
 /**
 Returns a transaction spec which updates the current set of
@@ -256,8 +247,7 @@ const lintConfig = state.Facet.define({
         }, {
             needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
-    },
-    enables: lintPlugin
+    }
 });
 /**
 Given a diagnostic source, this function returns an extension that
@@ -265,7 +255,11 @@ enables linting with that source. It will be called whenever the
 editor is idle (after its content changed).
 */
 function linter(source, config = {}) {
-    return lintConfig.of({ source, config });
+    return [
+        lintConfig.of({ source, config }),
+        lintPlugin,
+        lintExtensions
+    ];
 }
 /**
 Forces any linters [configured](https://codemirror.net/6/docs/ref/#lint.linter) to run when the
@@ -619,8 +613,8 @@ class LintGutterMarker extends view.GutterMarker {
 function trackHoverOn(view, marker) {
     let mousemove = (event) => {
         let rect = marker.getBoundingClientRect();
-        if (event.clientX > rect.left - 10 /* Hover.Margin */ && event.clientX < rect.right + 10 /* Hover.Margin */ &&
-            event.clientY > rect.top - 10 /* Hover.Margin */ && event.clientY < rect.bottom + 10 /* Hover.Margin */)
+        if (event.clientX > rect.left - 10 /* Margin */ && event.clientX < rect.right + 10 /* Margin */ &&
+            event.clientY > rect.top - 10 /* Margin */ && event.clientY < rect.bottom + 10 /* Margin */)
             return;
         for (let target = event.target; target; target = target.parentNode) {
             if (target.nodeType == 1 && target.classList.contains("cm-tooltip-lint"))
@@ -727,10 +721,21 @@ const lintGutterTheme = view.EditorView.baseTheme({
         content: svg(`<circle cx="20" cy="20" r="15" fill="#f87" stroke="#f43" stroke-width="6"/>`)
     },
 });
+const lintExtensions = [
+    lintState,
+    view.EditorView.decorations.compute([lintState], state => {
+        let { selected, panel } = state.field(lintState);
+        return !selected || !panel || selected.from == selected.to ? view.Decoration.none : view.Decoration.set([
+            activeMark.range(selected.from, selected.to)
+        ]);
+    }),
+    view.hoverTooltip(lintTooltip, { hideOn: hideTooltip }),
+    baseTheme
+];
 const lintGutterConfig = state.Facet.define({
     combine(configs) {
         return state.combineConfig(configs, {
-            hoverTime: 300 /* Hover.Time */,
+            hoverTime: 300 /* Time */,
             markerFilter: null,
             tooltipFilter: null
         });

package/dist/index.d.cts

@@ -0,0 +1,163 @@
+import * as _codemirror_state from '@codemirror/state';
+import { EditorState, TransactionSpec, Extension } from '@codemirror/state';
+import { EditorView, Command, KeyBinding, ViewUpdate } from '@codemirror/view';
+
+/**
+Describes a problem or hint for a piece of code.
+*/
+interface Diagnostic {
+    /**
+    The start position of the relevant text.
+    */
+    from: number;
+    /**
+    The end position. May be equal to `from`, though actually
+    covering text is preferable.
+    */
+    to: number;
+    /**
+    The severity of the problem. This will influence how it is
+    displayed.
+    */
+    severity: "info" | "warning" | "error";
+    /**
+    An optional source string indicating where the diagnostic is
+    coming from. You can put the name of your linter here, if
+    applicable.
+    */
+    source?: string;
+    /**
+    The message associated with this diagnostic.
+    */
+    message: string;
+    /**
+    An optional custom rendering function that displays the message
+    as a DOM node.
+    */
+    renderMessage?: () => Node;
+    /**
+    An optional array of actions that can be taken on this
+    diagnostic.
+    */
+    actions?: readonly Action[];
+}
+/**
+An action associated with a diagnostic.
+*/
+interface Action {
+    /**
+    The label to show to the user. Should be relatively short.
+    */
+    name: string;
+    /**
+    The function to call when the user activates this action. Is
+    given the diagnostic's _current_ position, which may have
+    changed since the creation of the diagnostic, due to editing.
+    */
+    apply: (view: EditorView, from: number, to: number) => void;
+}
+declare type DiagnosticFilter = (diagnostics: readonly Diagnostic[]) => Diagnostic[];
+interface LintConfig {
+    /**
+    Time to wait (in milliseconds) after a change before running
+    the linter. Defaults to 750ms.
+    */
+    delay?: number;
+    /**
+    Optional predicate that can be used to indicate when diagnostics
+    need to be recomputed. Linting is always re-done on document
+    changes.
+    */
+    needsRefresh?: null | ((update: ViewUpdate) => boolean);
+    /**
+    Optional filter to determine which diagnostics produce markers
+    in the content.
+    */
+    markerFilter?: null | DiagnosticFilter;
+    /**
+    Filter applied to a set of diagnostics shown in a tooltip. No
+    tooltip will appear if the empty set is returned.
+    */
+    tooltipFilter?: null | DiagnosticFilter;
+}
+interface LintGutterConfig {
+    /**
+    The delay before showing a tooltip when hovering over a lint gutter marker.
+    */
+    hoverTime?: number;
+    /**
+    Optional filter determining which diagnostics show a marker in
+    the gutter.
+    */
+    markerFilter?: null | DiagnosticFilter;
+    /**
+    Optional filter for diagnostics displayed in a tooltip, which
+    can also be used to prevent a tooltip appearing.
+    */
+    tooltipFilter?: null | DiagnosticFilter;
+}
+/**
+Returns a transaction spec which updates the current set of
+diagnostics, and enables the lint extension if if wasn't already
+active.
+*/
+declare function setDiagnostics(state: EditorState, diagnostics: readonly Diagnostic[]): TransactionSpec;
+/**
+The state effect that updates the set of active diagnostics. Can
+be useful when writing an extension that needs to track these.
+*/
+declare const setDiagnosticsEffect: _codemirror_state.StateEffectType<readonly Diagnostic[]>;
+/**
+Returns the number of active lint diagnostics in the given state.
+*/
+declare function diagnosticCount(state: EditorState): number;
+/**
+Command to open and focus the lint panel.
+*/
+declare const openLintPanel: Command;
+/**
+Command to close the lint panel, when open.
+*/
+declare const closeLintPanel: Command;
+/**
+Move the selection to the next diagnostic.
+*/
+declare const nextDiagnostic: Command;
+/**
+A set of default key bindings for the lint functionality.
+
+- Ctrl-Shift-m (Cmd-Shift-m on macOS): [`openLintPanel`](https://codemirror.net/6/docs/ref/#lint.openLintPanel)
+- F8: [`nextDiagnostic`](https://codemirror.net/6/docs/ref/#lint.nextDiagnostic)
+*/
+declare const lintKeymap: readonly KeyBinding[];
+/**
+The type of a function that produces diagnostics.
+*/
+declare type LintSource = (view: EditorView) => readonly Diagnostic[] | Promise<readonly Diagnostic[]>;
+/**
+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).
+*/
+declare function linter(source: LintSource, 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.
+*/
+declare function forceLinting(view: EditorView): void;
+/**
+Returns an extension that installs a gutter showing markers for
+each line that has diagnostics, which can be hovered over to see
+the diagnostics.
+*/
+declare function lintGutter(config?: LintGutterConfig): Extension;
+/**
+Iterate over the marked diagnostics for the given editor state,
+calling `f` for each of them. Note that, if the document changed
+since the diagnostics were created, the `Diagnostic` object will
+hold the original outdated position, whereas the `to` and `from`
+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, setDiagnostics, setDiagnosticsEffect };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { Decoration, showPanel, EditorView, ViewPlugin, logException, gutter, showTooltip, getPanel, WidgetType, hoverTooltip, GutterMarker } from '@codemirror/view';
+import { Decoration, showPanel, EditorView, ViewPlugin, logException, gutter, showTooltip, hoverTooltip, getPanel, WidgetType, GutterMarker } from '@codemirror/view';
 import { StateEffect, StateField, Facet, combineConfig, RangeSet } from '@codemirror/state';
 import elt from 'crelt';
 
@@ -47,20 +47,11 @@ function findDiagnostic(diagnostics, diagnostic = null, after = 0) {
     return found;
 }
 function hideTooltip(tr, tooltip) {
-    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(tooltip.pos));
+    let line = tr.startState.doc.lineAt(tooltip.pos);
+    return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(line.from, line.to));
 }
 function maybeEnableLint(state, effects) {
-    return state.field(lintState, false) ? effects : effects.concat(StateEffect.appendConfig.of([
-        lintState,
-        EditorView.decorations.compute([lintState], state => {
-            let { selected, panel } = state.field(lintState);
-            return !selected || !panel || selected.from == selected.to ? Decoration.none : Decoration.set([
-                activeMark.range(selected.from, selected.to)
-            ]);
-        }),
-        hoverTooltip(lintTooltip, { hideOn: hideTooltip }),
-        baseTheme
-    ]));
+    return state.field(lintState, false) ? effects : effects.concat(StateEffect.appendConfig.of(lintExtensions));
 }
 /**
 Returns a transaction spec which updates the current set of
@@ -248,8 +239,7 @@ const lintConfig = /*@__PURE__*/Facet.define({
         }, {
             needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
-    },
-    enables: lintPlugin
+    }
 });
 /**
 Given a diagnostic source, this function returns an extension that
@@ -257,7 +247,11 @@ enables linting with that source. It will be called whenever the
 editor is idle (after its content changed).
 */
 function linter(source, config = {}) {
-    return lintConfig.of({ source, config });
+    return [
+        lintConfig.of({ source, config }),
+        lintPlugin,
+        lintExtensions
+    ];
 }
 /**
 Forces any linters [configured](https://codemirror.net/6/docs/ref/#lint.linter) to run when the
@@ -611,8 +605,8 @@ class LintGutterMarker extends GutterMarker {
 function trackHoverOn(view, marker) {
     let mousemove = (event) => {
         let rect = marker.getBoundingClientRect();
-        if (event.clientX > rect.left - 10 /* Hover.Margin */ && event.clientX < rect.right + 10 /* Hover.Margin */ &&
-            event.clientY > rect.top - 10 /* Hover.Margin */ && event.clientY < rect.bottom + 10 /* Hover.Margin */)
+        if (event.clientX > rect.left - 10 /* Margin */ && event.clientX < rect.right + 10 /* Margin */ &&
+            event.clientY > rect.top - 10 /* Margin */ && event.clientY < rect.bottom + 10 /* Margin */)
             return;
         for (let target = event.target; target; target = target.parentNode) {
             if (target.nodeType == 1 && target.classList.contains("cm-tooltip-lint"))
@@ -719,10 +713,21 @@ const lintGutterTheme = /*@__PURE__*/EditorView.baseTheme({
         content: /*@__PURE__*/svg(`<circle cx="20" cy="20" r="15" fill="#f87" stroke="#f43" stroke-width="6"/>`)
     },
 });
+const lintExtensions = [
+    lintState,
+    /*@__PURE__*/EditorView.decorations.compute([lintState], state => {
+        let { selected, panel } = state.field(lintState);
+        return !selected || !panel || selected.from == selected.to ? Decoration.none : Decoration.set([
+            activeMark.range(selected.from, selected.to)
+        ]);
+    }),
+    /*@__PURE__*/hoverTooltip(lintTooltip, { hideOn: hideTooltip }),
+    baseTheme
+];
 const lintGutterConfig = /*@__PURE__*/Facet.define({
     combine(configs) {
         return combineConfig(configs, {
-            hoverTime: 300 /* Hover.Time */,
+            hoverTime: 300 /* Time */,
             markerFilter: null,
             tooltipFilter: null
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/lint",
-  "version": "6.2.0",
+  "version": "6.2.2",
   "description": "Linting support for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",
@@ -31,7 +31,7 @@
     "crelt": "^1.0.5"
   },
   "devDependencies": {
-    "@codemirror/buildhelper": "^0.1.0"
+    "@codemirror/buildhelper": "^1.0.0"
   },
   "repository": {
     "type": "git",