@codemirror/lint 0.18.3 → 0.18.4

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.18.4 (2021-06-07)
+
+### Bug fixes
+
+Multiple `linter` extensions can now be added to an editor without disrupting each other.
+
+Fix poor layout on lint tooltips due to changes in @codemirror/tooltip.
+
 ## 0.18.3 (2021-05-10)
 
 ### Bug fixes

package/dist/index.cjs

@@ -36,7 +36,7 @@ class LintState {
                     widget: new DiagnosticWidget(d),
                     diagnostic: d
                 }).range(d.from);
-        }));
+        }), true);
         return new LintState(ranges, panel, findDiagnostic(ranges));
     }
 }
@@ -175,6 +175,53 @@ const lintKeymap = [
     { key: "Mod-Shift-m", run: openLintPanel },
     { key: "F8", run: nextDiagnostic }
 ];
+const lintPlugin = view.ViewPlugin.fromClass(class {
+    constructor(view) {
+        this.view = view;
+        this.timeout = -1;
+        this.set = true;
+        let { delay } = view.state.facet(lintSource);
+        this.lintTime = Date.now() + delay;
+        this.run = this.run.bind(this);
+        this.timeout = setTimeout(this.run, delay);
+    }
+    run() {
+        let now = Date.now();
+        if (now < this.lintTime - 10) {
+            setTimeout(this.run, this.lintTime - now);
+        }
+        else {
+            this.set = false;
+            let { state } = this.view, { sources } = state.facet(lintSource);
+            Promise.all(sources.map(source => Promise.resolve(source(this.view)))).then(annotations => {
+                var _a, _b;
+                let all = annotations.reduce((a, b) => a.concat(b));
+                if (this.view.state.doc == state.doc &&
+                    (all.length || ((_b = (_a = this.view.state.field(lintState, false)) === null || _a === void 0 ? void 0 : _a.diagnostics) === null || _b === void 0 ? void 0 : _b.size)))
+                    this.view.dispatch(setDiagnostics(this.view.state, all));
+            }, error => { view.logException(this.view.state, error); });
+        }
+    }
+    update(update) {
+        if (update.docChanged) {
+            let { delay } = update.state.facet(lintSource);
+            this.lintTime = Date.now() + delay;
+            if (!this.set) {
+                this.set = true;
+                this.timeout = setTimeout(this.run, delay);
+            }
+        }
+    }
+    destroy() {
+        clearTimeout(this.timeout);
+    }
+});
+const lintSource = state.Facet.define({
+    combine(input) {
+        return { sources: input.map(i => i.source), delay: input.length ? Math.max(...input.map(i => i.delay)) : 750 };
+    },
+    enables: lintPlugin
+});
 /**
 Given a diagnostic source, this function returns an extension that
 enables linting with that source. It will be called whenever the
@@ -182,41 +229,7 @@ editor is idle (after its content changed).
 */
 function linter(source, config = {}) {
     var _a;
-    let delay = (_a = config.delay) !== null && _a !== void 0 ? _a : 750;
-    return view.ViewPlugin.fromClass(class {
-        constructor(view) {
-            this.view = view;
-            this.lintTime = Date.now() + delay;
-            this.set = true;
-            this.run = this.run.bind(this);
-            setTimeout(this.run, delay);
-        }
-        run() {
-            let now = Date.now();
-            if (now < this.lintTime - 10) {
-                setTimeout(this.run, this.lintTime - now);
-            }
-            else {
-                this.set = false;
-                let { state } = this.view;
-                Promise.resolve(source(this.view)).then(annotations => {
-                    var _a, _b;
-                    if (this.view.state.doc == state.doc &&
-                        (annotations.length || ((_b = (_a = this.view.state.field(lintState, false)) === null || _a === void 0 ? void 0 : _a.diagnostics) === null || _b === void 0 ? void 0 : _b.size)))
-                        this.view.dispatch(setDiagnostics(this.view.state, annotations));
-                }, error => { view.logException(this.view.state, error); });
-            }
-        }
-        update(update) {
-            if (update.docChanged) {
-                this.lintTime = Date.now() + delay;
-                if (!this.set) {
-                    this.set = true;
-                    setTimeout(this.run, delay);
-                }
-            }
-        }
-    });
+    return lintSource.of({ source, delay: (_a = config.delay) !== null && _a !== void 0 ? _a : 750 });
 }
 function assignKeys(actions) {
     let assigned = [];
@@ -479,6 +492,10 @@ const baseTheme = view.EditorView.baseTheme({
     ".cm-lintRange-warning": { backgroundImage: underline("orange") },
     ".cm-lintRange-info": { backgroundImage: underline("#999") },
     ".cm-lintRange-active": { backgroundColor: "#ffdd9980" },
+    ".cm-tooltip-lint": {
+        padding: 0,
+        margin: 0
+    },
     ".cm-lintPoint": {
         position: "relative",
         "&:after": {

package/dist/index.d.ts

@@ -74,12 +74,13 @@ A set of default key bindings for the lint functionality.
 - F8: [`nextDiagnostic`](https://codemirror.net/6/docs/ref/#lint.nextDiagnostic)
 */
 declare const lintKeymap: readonly KeyBinding[];
+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: (view: EditorView) => readonly Diagnostic[] | Promise<readonly Diagnostic[]>, config?: {
+declare function linter(source: LintSource, config?: {
     /**
     Time to wait (in milliseconds) after a change before running
     the linter. Defaults to 750ms.

package/dist/index.js

@@ -1,5 +1,5 @@
 import { EditorView, Decoration, ViewPlugin, logException, WidgetType } from '@codemirror/view';
-import { StateEffect, StateField } from '@codemirror/state';
+import { StateEffect, StateField, Facet } from '@codemirror/state';
 import { hoverTooltip } from '@codemirror/tooltip';
 import { showPanel, getPanel } from '@codemirror/panel';
 import elt from 'crelt';
@@ -28,7 +28,7 @@ class LintState {
                     widget: new DiagnosticWidget(d),
                     diagnostic: d
                 }).range(d.from);
-        }));
+        }), true);
         return new LintState(ranges, panel, findDiagnostic(ranges));
     }
 }
@@ -167,6 +167,53 @@ const lintKeymap = [
     { key: "Mod-Shift-m", run: openLintPanel },
     { key: "F8", run: nextDiagnostic }
 ];
+const lintPlugin = /*@__PURE__*/ViewPlugin.fromClass(class {
+    constructor(view) {
+        this.view = view;
+        this.timeout = -1;
+        this.set = true;
+        let { delay } = view.state.facet(lintSource);
+        this.lintTime = Date.now() + delay;
+        this.run = this.run.bind(this);
+        this.timeout = setTimeout(this.run, delay);
+    }
+    run() {
+        let now = Date.now();
+        if (now < this.lintTime - 10) {
+            setTimeout(this.run, this.lintTime - now);
+        }
+        else {
+            this.set = false;
+            let { state } = this.view, { sources } = state.facet(lintSource);
+            Promise.all(sources.map(source => Promise.resolve(source(this.view)))).then(annotations => {
+                var _a, _b;
+                let all = annotations.reduce((a, b) => a.concat(b));
+                if (this.view.state.doc == state.doc &&
+                    (all.length || ((_b = (_a = this.view.state.field(lintState, false)) === null || _a === void 0 ? void 0 : _a.diagnostics) === null || _b === void 0 ? void 0 : _b.size)))
+                    this.view.dispatch(setDiagnostics(this.view.state, all));
+            }, error => { logException(this.view.state, error); });
+        }
+    }
+    update(update) {
+        if (update.docChanged) {
+            let { delay } = update.state.facet(lintSource);
+            this.lintTime = Date.now() + delay;
+            if (!this.set) {
+                this.set = true;
+                this.timeout = setTimeout(this.run, delay);
+            }
+        }
+    }
+    destroy() {
+        clearTimeout(this.timeout);
+    }
+});
+const lintSource = /*@__PURE__*/Facet.define({
+    combine(input) {
+        return { sources: input.map(i => i.source), delay: input.length ? Math.max(...input.map(i => i.delay)) : 750 };
+    },
+    enables: lintPlugin
+});
 /**
 Given a diagnostic source, this function returns an extension that
 enables linting with that source. It will be called whenever the
@@ -174,41 +221,7 @@ editor is idle (after its content changed).
 */
 function linter(source, config = {}) {
     var _a;
-    let delay = (_a = config.delay) !== null && _a !== void 0 ? _a : 750;
-    return ViewPlugin.fromClass(class {
-        constructor(view) {
-            this.view = view;
-            this.lintTime = Date.now() + delay;
-            this.set = true;
-            this.run = this.run.bind(this);
-            setTimeout(this.run, delay);
-        }
-        run() {
-            let now = Date.now();
-            if (now < this.lintTime - 10) {
-                setTimeout(this.run, this.lintTime - now);
-            }
-            else {
-                this.set = false;
-                let { state } = this.view;
-                Promise.resolve(source(this.view)).then(annotations => {
-                    var _a, _b;
-                    if (this.view.state.doc == state.doc &&
-                        (annotations.length || ((_b = (_a = this.view.state.field(lintState, false)) === null || _a === void 0 ? void 0 : _a.diagnostics) === null || _b === void 0 ? void 0 : _b.size)))
-                        this.view.dispatch(setDiagnostics(this.view.state, annotations));
-                }, error => { logException(this.view.state, error); });
-            }
-        }
-        update(update) {
-            if (update.docChanged) {
-                this.lintTime = Date.now() + delay;
-                if (!this.set) {
-                    this.set = true;
-                    setTimeout(this.run, delay);
-                }
-            }
-        }
-    });
+    return lintSource.of({ source, delay: (_a = config.delay) !== null && _a !== void 0 ? _a : 750 });
 }
 function assignKeys(actions) {
     let assigned = [];
@@ -471,6 +484,10 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
     ".cm-lintRange-warning": { backgroundImage: /*@__PURE__*/underline("orange") },
     ".cm-lintRange-info": { backgroundImage: /*@__PURE__*/underline("#999") },
     ".cm-lintRange-active": { backgroundColor: "#ffdd9980" },
+    ".cm-tooltip-lint": {
+        padding: 0,
+        margin: 0
+    },
     ".cm-lintPoint": {
         position: "relative",
         "&:after": {

package/package.json

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