@codemirror/lint 6.1.0 → 6.2.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 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
+
+Give lint action buttons a pointer cursor style.
+
+Fix a bug that caused diagnostic action callbacks to be called twice when their button was clicked.
+
 ## 6.1.0 (2022-11-15)
 
 ### New features

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2018-2021 by Marijn Haverbeke <marijnh@gmail.com> and others
+Copyright (C) 2018-2021 by Marijn Haverbeke <marijn@haverbeke.berlin> and others
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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
@@ -291,8 +295,11 @@ function renderDiagnostic(view, diagnostic, inPanel) {
     var _a;
     let keys = inPanel ? assignKeys(diagnostic.actions) : [];
     return elt__default["default"]("li", { class: "cm-diagnostic cm-diagnostic-" + diagnostic.severity }, elt__default["default"]("span", { class: "cm-diagnosticText" }, diagnostic.renderMessage ? diagnostic.renderMessage() : diagnostic.message), (_a = diagnostic.actions) === null || _a === void 0 ? void 0 : _a.map((action, i) => {
-        let click = (e) => {
+        let fired = false, click = (e) => {
             e.preventDefault();
+            if (fired)
+                return;
+            fired = true;
             let found = findDiagnostic(view.state.field(lintState).diagnostics, diagnostic);
             if (found)
                 action.apply(view, found.from, found.to);
@@ -519,7 +526,8 @@ const baseTheme = view.EditorView.baseTheme({
         backgroundColor: "#444",
         color: "white",
         borderRadius: "3px",
-        marginLeft: "8px"
+        marginLeft: "8px",
+        cursor: "pointer"
     },
     ".cm-diagnosticSource": {
         fontSize: "70%",
@@ -739,7 +747,7 @@ function lintGutter(config = {}) {
 /**
 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 werecreated, the `Diagnostic` object will
+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.
 */

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.
     */
@@ -148,7 +154,7 @@ 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 werecreated, the `Diagnostic` object will
+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.
 */

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
@@ -283,8 +287,11 @@ 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) => {
-        let click = (e) => {
+        let fired = false, click = (e) => {
             e.preventDefault();
+            if (fired)
+                return;
+            fired = true;
             let found = findDiagnostic(view.state.field(lintState).diagnostics, diagnostic);
             if (found)
                 action.apply(view, found.from, found.to);
@@ -511,7 +518,8 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
         backgroundColor: "#444",
         color: "white",
         borderRadius: "3px",
-        marginLeft: "8px"
+        marginLeft: "8px",
+        cursor: "pointer"
     },
     ".cm-diagnosticSource": {
         fontSize: "70%",
@@ -731,7 +739,7 @@ function lintGutter(config = {}) {
 /**
 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 werecreated, the `Diagnostic` object will
+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.
 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/lint",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Linting support for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",
@@ -12,7 +12,7 @@
   ],
   "author": {
     "name": "Marijn Haverbeke",
-    "email": "marijnh@gmail.com",
+    "email": "marijn@haverbeke.berlin",
     "url": "http://marijnhaverbeke.nl"
   },
   "type": "module",