@codemirror/lint 6.1.1 → 6.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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

@@ -227,7 +227,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,7 +251,10 @@ 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

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

@@ -219,7 +219,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,7 +243,10 @@ 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

package/package.json

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