@codemirror/lint 6.0.0 → 6.1.1

package/.github/workflows/dispatch.yml

@@ -11,6 +11,6 @@ jobs:
         with:
           # You should create a personal access token and store it in your repository
           token: ${{ secrets.DISPATCH_AUTH }}
-          repo: codemirror.next
+          repo: dev
           owner: codemirror
           event_type: push

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 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
+
+The new `forEachDiagnostic` function can be used to iterate over the diagnostics in an editor state.
+
 ## 6.0.0 (2022-06-08)
 
 ### Breaking changes

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/README.md

@@ -1,13 +1,13 @@
 # @codemirror/lint [![NPM version](https://img.shields.io/npm/v/@codemirror/lint.svg)](https://www.npmjs.org/package/@codemirror/lint)
 
-[ [**WEBSITE**](https://codemirror.net/6/) | [**DOCS**](https://codemirror.net/6/docs/ref/#lint) | [**ISSUES**](https://github.com/codemirror/codemirror.next/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lint/blob/main/CHANGELOG.md) ]
+[ [**WEBSITE**](https://codemirror.net/) | [**DOCS**](https://codemirror.net/docs/ref/#lint) | [**ISSUES**](https://github.com/codemirror/dev/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lint/blob/main/CHANGELOG.md) ]
 
 This package implements linting support for the
-[CodeMirror](https://codemirror.net/6/) code editor.
+[CodeMirror](https://codemirror.net/) code editor.
 
-The [project page](https://codemirror.net/6/) has more information, a
-number of [examples](https://codemirror.net/6/examples/) and the
-[documentation](https://codemirror.net/6/docs/).
+The [project page](https://codemirror.net/) has more information, a
+number of [examples](https://codemirror.net/examples/) and the
+[documentation](https://codemirror.net/docs/).
 
 This code is released under an
 [MIT license](https://github.com/codemirror/lint/tree/main/LICENSE).

package/dist/index.cjs

@@ -197,7 +197,7 @@ A set of default key bindings for the lint functionality.
 - F8: [`nextDiagnostic`](https://codemirror.net/6/docs/ref/#lint.nextDiagnostic)
 */
 const lintKeymap = [
-    { key: "Mod-Shift-m", run: openLintPanel },
+    { key: "Mod-Shift-m", run: openLintPanel, preventDefault: true },
     { key: "F8", run: nextDiagnostic }
 ];
 const lintPlugin = view.ViewPlugin.fromClass(class {
@@ -291,8 +291,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 +522,8 @@ const baseTheme = view.EditorView.baseTheme({
         backgroundColor: "#444",
         color: "white",
         borderRadius: "3px",
-        marginLeft: "8px"
+        marginLeft: "8px",
+        cursor: "pointer"
     },
     ".cm-diagnosticSource": {
         fontSize: "70%",
@@ -611,8 +615,8 @@ class LintGutterMarker extends view.GutterMarker {
 function trackHoverOn(view, marker) {
     let mousemove = (event) => {
         let rect = marker.getBoundingClientRect();
-        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 */)
+        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 */)
             return;
         for (let target = event.target; target; target = target.parentNode) {
             if (target.nodeType == 1 && target.classList.contains("cm-tooltip-lint"))
@@ -715,14 +719,14 @@ const lintGutterTheme = view.EditorView.baseTheme({
     ".cm-lint-marker-warning": {
         content: svg(`<path fill="#fe8" stroke="#fd7" stroke-width="6" stroke-linejoin="round" d="M20 6L37 35L3 35Z"/>`),
     },
-    ".cm-lint-marker-error:before": {
+    ".cm-lint-marker-error": {
         content: svg(`<circle cx="20" cy="20" r="15" fill="#f87" stroke="#f43" stroke-width="6"/>`)
     },
 });
 const lintGutterConfig = state.Facet.define({
     combine(configs) {
         return state.combineConfig(configs, {
-            hoverTime: 300 /* Time */,
+            hoverTime: 300 /* Hover.Time */,
             markerFilter: null,
             tooltipFilter: null
         });
@@ -736,9 +740,23 @@ the diagnostics.
 function lintGutter(config = {}) {
     return [lintGutterConfig.of(config), lintGutterMarkers, lintGutterExtension, lintGutterTheme, lintGutterTooltip];
 }
+/**
+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.
+*/
+function forEachDiagnostic(state$1, f) {
+    let lState = state$1.field(lintState, false);
+    if (lState && lState.diagnostics.size)
+        for (let iter = state.RangeSet.iter([lState.diagnostics]); iter.value; iter.next())
+            f(iter.value.spec.diagnostic, iter.from, iter.to);
+}
 
 exports.closeLintPanel = closeLintPanel;
 exports.diagnosticCount = diagnosticCount;
+exports.forEachDiagnostic = forEachDiagnostic;
 exports.forceLinting = forceLinting;
 exports.lintGutter = lintGutter;
 exports.lintKeymap = lintKeymap;

package/dist/index.d.ts

@@ -145,5 +145,13 @@ 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, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, setDiagnostics, setDiagnosticsEffect };
+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, hoverTooltip, logException, gutter, showTooltip, getPanel, WidgetType, GutterMarker } from '@codemirror/view';
+import { Decoration, showPanel, EditorView, ViewPlugin, logException, gutter, showTooltip, getPanel, WidgetType, hoverTooltip, GutterMarker } from '@codemirror/view';
 import { StateEffect, StateField, Facet, combineConfig, RangeSet } from '@codemirror/state';
 import elt from 'crelt';
 
@@ -189,7 +189,7 @@ A set of default key bindings for the lint functionality.
 - F8: [`nextDiagnostic`](https://codemirror.net/6/docs/ref/#lint.nextDiagnostic)
 */
 const lintKeymap = [
-    { key: "Mod-Shift-m", run: openLintPanel },
+    { key: "Mod-Shift-m", run: openLintPanel, preventDefault: true },
     { key: "F8", run: nextDiagnostic }
 ];
 const lintPlugin = /*@__PURE__*/ViewPlugin.fromClass(class {
@@ -283,8 +283,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 +514,8 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
         backgroundColor: "#444",
         color: "white",
         borderRadius: "3px",
-        marginLeft: "8px"
+        marginLeft: "8px",
+        cursor: "pointer"
     },
     ".cm-diagnosticSource": {
         fontSize: "70%",
@@ -603,8 +607,8 @@ class LintGutterMarker extends GutterMarker {
 function trackHoverOn(view, marker) {
     let mousemove = (event) => {
         let rect = marker.getBoundingClientRect();
-        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 */)
+        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 */)
             return;
         for (let target = event.target; target; target = target.parentNode) {
             if (target.nodeType == 1 && target.classList.contains("cm-tooltip-lint"))
@@ -707,14 +711,14 @@ const lintGutterTheme = /*@__PURE__*/EditorView.baseTheme({
     ".cm-lint-marker-warning": {
         content: /*@__PURE__*/svg(`<path fill="#fe8" stroke="#fd7" stroke-width="6" stroke-linejoin="round" d="M20 6L37 35L3 35Z"/>`),
     },
-    ".cm-lint-marker-error:before": {
+    ".cm-lint-marker-error": {
         content: /*@__PURE__*/svg(`<circle cx="20" cy="20" r="15" fill="#f87" stroke="#f43" stroke-width="6"/>`)
     },
 });
 const lintGutterConfig = /*@__PURE__*/Facet.define({
     combine(configs) {
         return combineConfig(configs, {
-            hoverTime: 300 /* Time */,
+            hoverTime: 300 /* Hover.Time */,
             markerFilter: null,
             tooltipFilter: null
         });
@@ -728,5 +732,18 @@ the diagnostics.
 function lintGutter(config = {}) {
     return [lintGutterConfig.of(config), lintGutterMarkers, lintGutterExtension, lintGutterTheme, lintGutterTooltip];
 }
+/**
+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.
+*/
+function forEachDiagnostic(state, f) {
+    let lState = state.field(lintState, false);
+    if (lState && lState.diagnostics.size)
+        for (let iter = RangeSet.iter([lState.diagnostics]); iter.value; iter.next())
+            f(iter.value.spec.diagnostic, iter.from, iter.to);
+}
 
-export { closeLintPanel, diagnosticCount, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, setDiagnostics, setDiagnosticsEffect };
+export { closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, setDiagnostics, setDiagnosticsEffect };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/lint",
-  "version": "6.0.0",
+  "version": "6.1.1",
   "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",