@codemirror/lint 6.1.1 → 6.2.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 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
+
+The new `needsRefresh` option to `linter` makes it possible to cause linting to be recalculated for non-document state changes.
+
 ## 6.1.1 (2023-02-15)
 
 ### Bug fixes

package/dist/index.cjs

@@ -58,17 +58,7 @@ function hideTooltip(tr, tooltip) {
     return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(tooltip.pos));
 }
 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
@@ -227,7 +217,8 @@ const lintPlugin = view.ViewPlugin.fromClass(class {
     }
     update(update) {
         let config = update.state.facet(lintConfig);
-        if (update.docChanged || config != update.startState.facet(lintConfig)) {
+        if (update.docChanged || config != update.startState.facet(lintConfig) ||
+            config.needsRefresh && config.needsRefresh(update)) {
             this.lintTime = Date.now() + config.delay;
             if (!this.set) {
                 this.set = true;
@@ -250,10 +241,12 @@ const lintConfig = state.Facet.define({
         return Object.assign({ sources: input.map(i => i.source) }, state.combineConfig(input.map(i => i.config), {
             delay: 750,
             markerFilter: null,
-            tooltipFilter: null
+            tooltipFilter: null,
+            needsRefresh: null
+        }, {
+            needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
-    },
-    enables: lintPlugin
+    }
 });
 /**
 Given a diagnostic source, this function returns an extension that
@@ -261,7 +254,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
@@ -723,6 +720,17 @@ 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, {

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _codemirror_state from '@codemirror/state';
 import { EditorState, TransactionSpec, Extension } from '@codemirror/state';
-import { EditorView, Command, KeyBinding } from '@codemirror/view';
+import { EditorView, Command, KeyBinding, ViewUpdate } from '@codemirror/view';
 
 /**
 Describes a problem or hint for a piece of code.
@@ -64,6 +64,12 @@ interface LintConfig {
     */
     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.
     */

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';
 
@@ -50,17 +50,7 @@ function hideTooltip(tr, tooltip) {
     return !!(tr.effects.some(e => e.is(setDiagnosticsEffect)) || tr.changes.touchesRange(tooltip.pos));
 }
 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
@@ -219,7 +209,8 @@ const lintPlugin = /*@__PURE__*/ViewPlugin.fromClass(class {
     }
     update(update) {
         let config = update.state.facet(lintConfig);
-        if (update.docChanged || config != update.startState.facet(lintConfig)) {
+        if (update.docChanged || config != update.startState.facet(lintConfig) ||
+            config.needsRefresh && config.needsRefresh(update)) {
             this.lintTime = Date.now() + config.delay;
             if (!this.set) {
                 this.set = true;
@@ -242,10 +233,12 @@ const lintConfig = /*@__PURE__*/Facet.define({
         return Object.assign({ sources: input.map(i => i.source) }, combineConfig(input.map(i => i.config), {
             delay: 750,
             markerFilter: null,
-            tooltipFilter: null
+            tooltipFilter: null,
+            needsRefresh: null
+        }, {
+            needsRefresh: (a, b) => !a ? b : !b ? a : u => a(u) || b(u)
         }));
-    },
-    enables: lintPlugin
+    }
 });
 /**
 Given a diagnostic source, this function returns an extension that
@@ -253,7 +246,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
@@ -715,6 +712,17 @@ 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, {

package/package.json

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