@codemirror/lint 6.2.2 → 6.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 6.4.0 (2023-07-03)
+
+### New features
+
+Diagnostics can now use `"hint"` as a severity level.
+
+Diagnostics can now set a `markClass` property to add an additional CSS class to the text marked by the diagnostic.
+
+## 6.3.0 (2023-06-23)
+
+### New features
+
+A new `previousDiagnostic` command can be used to move back through the active diagnostics.
+
 ## 6.2.2 (2023-06-05)
 
 ### Bug fixes

package/dist/index.cjs

@@ -37,7 +37,7 @@ class LintState {
                     diagnostic: d
                 }).range(d.from)
                 : view.Decoration.mark({
-                    attributes: { class: "cm-lintRange cm-lintRange-" + d.severity },
+                    attributes: { class: "cm-lintRange cm-lintRange-" + d.severity + (d.markClass ? " " + d.markClass : "") },
                     diagnostic: d
                 }).range(d.from, d.to);
         }), true);
@@ -182,6 +182,30 @@ const nextDiagnostic = (view) => {
     return true;
 };
 /**
+Move the selection to the previous diagnostic.
+*/
+const previousDiagnostic = (view) => {
+    let { state } = view, field = state.field(lintState, false);
+    if (!field)
+        return false;
+    let sel = state.selection.main;
+    let prevFrom, prevTo, lastFrom, lastTo;
+    field.diagnostics.between(0, state.doc.length, (from, to) => {
+        if (to < sel.to && (prevFrom == null || prevFrom < from)) {
+            prevFrom = from;
+            prevTo = to;
+        }
+        if (lastFrom == null || from > lastFrom) {
+            lastFrom = from;
+            lastTo = to;
+        }
+    });
+    if (lastFrom == null || prevFrom == null && lastFrom == sel.from)
+        return false;
+    view.dispatch({ selection: { anchor: prevFrom !== null && prevFrom !== void 0 ? prevFrom : lastFrom, head: prevTo !== null && prevTo !== void 0 ? prevTo : lastTo }, scrollIntoView: true });
+    return true;
+};
+/**
 A set of default key bindings for the lint functionality.
 
 - Ctrl-Shift-m (Cmd-Shift-m on macOS): [`openLintPanel`](https://codemirror.net/6/docs/ref/#lint.openLintPanel)
@@ -513,6 +537,7 @@ const baseTheme = view.EditorView.baseTheme({
     ".cm-diagnostic-error": { borderLeft: "5px solid #d11" },
     ".cm-diagnostic-warning": { borderLeft: "5px solid orange" },
     ".cm-diagnostic-info": { borderLeft: "5px solid #999" },
+    ".cm-diagnostic-hint": { borderLeft: "5px solid #66d" },
     ".cm-diagnosticAction": {
         font: "inherit",
         border: "none",
@@ -535,6 +560,7 @@ const baseTheme = view.EditorView.baseTheme({
     ".cm-lintRange-error": { backgroundImage: underline("#d11") },
     ".cm-lintRange-warning": { backgroundImage: underline("orange") },
     ".cm-lintRange-info": { backgroundImage: underline("#999") },
+    ".cm-lintRange-hint": { backgroundImage: underline("#66d") },
     ".cm-lintRange-active": { backgroundColor: "#ffdd9980" },
     ".cm-tooltip-lint": {
         padding: 0,
@@ -558,6 +584,9 @@ const baseTheme = view.EditorView.baseTheme({
     ".cm-lintPoint-info": {
         "&:after": { borderBottomColor: "#999" }
     },
+    ".cm-lintPoint-hint": {
+        "&:after": { borderBottomColor: "#66d" }
+    },
     ".cm-panel.cm-panel-lint": {
         position: "relative",
         "& ul": {
@@ -589,14 +618,14 @@ const baseTheme = view.EditorView.baseTheme({
         }
     }
 });
+function severityWeight(sev) {
+    return sev == "error" ? 4 : sev == "warning" ? 3 : sev == "info" ? 2 : 1;
+}
 class LintGutterMarker extends view.GutterMarker {
     constructor(diagnostics) {
         super();
         this.diagnostics = diagnostics;
-        this.severity = diagnostics.reduce((max, d) => {
-            let s = d.severity;
-            return s == "error" || s == "warning" && max == "info" ? s : max;
-        }, "info");
+        this.severity = diagnostics.reduce((max, d) => severityWeight(max) < severityWeight(d.severity) ? d.severity : max, "hint");
     }
     toDOM(view) {
         let elt = document.createElement("div");
@@ -772,5 +801,6 @@ exports.lintKeymap = lintKeymap;
 exports.linter = linter;
 exports.nextDiagnostic = nextDiagnostic;
 exports.openLintPanel = openLintPanel;
+exports.previousDiagnostic = previousDiagnostic;
 exports.setDiagnostics = setDiagnostics;
 exports.setDiagnosticsEffect = setDiagnosticsEffect;

package/dist/index.d.cts

@@ -2,6 +2,7 @@ import * as _codemirror_state from '@codemirror/state';
 import { EditorState, TransactionSpec, Extension } from '@codemirror/state';
 import { EditorView, Command, KeyBinding, ViewUpdate } from '@codemirror/view';
 
+declare type Severity = "hint" | "info" | "warning" | "error";
 /**
 Describes a problem or hint for a piece of code.
 */
@@ -19,7 +20,12 @@ interface Diagnostic {
     The severity of the problem. This will influence how it is
     displayed.
     */
-    severity: "info" | "warning" | "error";
+    severity: Severity;
+    /**
+    When given, add an extra CSS class to parts of the code that
+    this diagnostic applies to.
+    */
+    markClass?: string;
     /**
     An optional source string indicating where the diagnostic is
     coming from. You can put the name of your linter here, if
@@ -124,6 +130,10 @@ Move the selection to the next diagnostic.
 */
 declare const nextDiagnostic: Command;
 /**
+Move the selection to the previous diagnostic.
+*/
+declare const previousDiagnostic: Command;
+/**
 A set of default key bindings for the lint functionality.
 
 - Ctrl-Shift-m (Cmd-Shift-m on macOS): [`openLintPanel`](https://codemirror.net/6/docs/ref/#lint.openLintPanel)
@@ -160,4 +170,4 @@ 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, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, setDiagnostics, setDiagnosticsEffect };
+export { Action, Diagnostic, LintSource, closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import * as _codemirror_state from '@codemirror/state';
 import { EditorState, TransactionSpec, Extension } from '@codemirror/state';
 import { EditorView, Command, KeyBinding, ViewUpdate } from '@codemirror/view';
 
+declare type Severity = "hint" | "info" | "warning" | "error";
 /**
 Describes a problem or hint for a piece of code.
 */
@@ -19,7 +20,12 @@ interface Diagnostic {
     The severity of the problem. This will influence how it is
     displayed.
     */
-    severity: "info" | "warning" | "error";
+    severity: Severity;
+    /**
+    When given, add an extra CSS class to parts of the code that
+    this diagnostic applies to.
+    */
+    markClass?: string;
     /**
     An optional source string indicating where the diagnostic is
     coming from. You can put the name of your linter here, if
@@ -124,6 +130,10 @@ Move the selection to the next diagnostic.
 */
 declare const nextDiagnostic: Command;
 /**
+Move the selection to the previous diagnostic.
+*/
+declare const previousDiagnostic: Command;
+/**
 A set of default key bindings for the lint functionality.
 
 - Ctrl-Shift-m (Cmd-Shift-m on macOS): [`openLintPanel`](https://codemirror.net/6/docs/ref/#lint.openLintPanel)
@@ -160,4 +170,4 @@ 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, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, setDiagnostics, setDiagnosticsEffect };
+export { Action, Diagnostic, LintSource, closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };

package/dist/index.js

@@ -29,7 +29,7 @@ class LintState {
                     diagnostic: d
                 }).range(d.from)
                 : Decoration.mark({
-                    attributes: { class: "cm-lintRange cm-lintRange-" + d.severity },
+                    attributes: { class: "cm-lintRange cm-lintRange-" + d.severity + (d.markClass ? " " + d.markClass : "") },
                     diagnostic: d
                 }).range(d.from, d.to);
         }), true);
@@ -174,6 +174,30 @@ const nextDiagnostic = (view) => {
     return true;
 };
 /**
+Move the selection to the previous diagnostic.
+*/
+const previousDiagnostic = (view) => {
+    let { state } = view, field = state.field(lintState, false);
+    if (!field)
+        return false;
+    let sel = state.selection.main;
+    let prevFrom, prevTo, lastFrom, lastTo;
+    field.diagnostics.between(0, state.doc.length, (from, to) => {
+        if (to < sel.to && (prevFrom == null || prevFrom < from)) {
+            prevFrom = from;
+            prevTo = to;
+        }
+        if (lastFrom == null || from > lastFrom) {
+            lastFrom = from;
+            lastTo = to;
+        }
+    });
+    if (lastFrom == null || prevFrom == null && lastFrom == sel.from)
+        return false;
+    view.dispatch({ selection: { anchor: prevFrom !== null && prevFrom !== void 0 ? prevFrom : lastFrom, head: prevTo !== null && prevTo !== void 0 ? prevTo : lastTo }, scrollIntoView: true });
+    return true;
+};
+/**
 A set of default key bindings for the lint functionality.
 
 - Ctrl-Shift-m (Cmd-Shift-m on macOS): [`openLintPanel`](https://codemirror.net/6/docs/ref/#lint.openLintPanel)
@@ -505,6 +529,7 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
     ".cm-diagnostic-error": { borderLeft: "5px solid #d11" },
     ".cm-diagnostic-warning": { borderLeft: "5px solid orange" },
     ".cm-diagnostic-info": { borderLeft: "5px solid #999" },
+    ".cm-diagnostic-hint": { borderLeft: "5px solid #66d" },
     ".cm-diagnosticAction": {
         font: "inherit",
         border: "none",
@@ -527,6 +552,7 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
     ".cm-lintRange-error": { backgroundImage: /*@__PURE__*/underline("#d11") },
     ".cm-lintRange-warning": { backgroundImage: /*@__PURE__*/underline("orange") },
     ".cm-lintRange-info": { backgroundImage: /*@__PURE__*/underline("#999") },
+    ".cm-lintRange-hint": { backgroundImage: /*@__PURE__*/underline("#66d") },
     ".cm-lintRange-active": { backgroundColor: "#ffdd9980" },
     ".cm-tooltip-lint": {
         padding: 0,
@@ -550,6 +576,9 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
     ".cm-lintPoint-info": {
         "&:after": { borderBottomColor: "#999" }
     },
+    ".cm-lintPoint-hint": {
+        "&:after": { borderBottomColor: "#66d" }
+    },
     ".cm-panel.cm-panel-lint": {
         position: "relative",
         "& ul": {
@@ -581,14 +610,14 @@ const baseTheme = /*@__PURE__*/EditorView.baseTheme({
         }
     }
 });
+function severityWeight(sev) {
+    return sev == "error" ? 4 : sev == "warning" ? 3 : sev == "info" ? 2 : 1;
+}
 class LintGutterMarker extends GutterMarker {
     constructor(diagnostics) {
         super();
         this.diagnostics = diagnostics;
-        this.severity = diagnostics.reduce((max, d) => {
-            let s = d.severity;
-            return s == "error" || s == "warning" && max == "info" ? s : max;
-        }, "info");
+        this.severity = diagnostics.reduce((max, d) => severityWeight(max) < severityWeight(d.severity) ? d.severity : max, "hint");
     }
     toDOM(view) {
         let elt = document.createElement("div");
@@ -755,4 +784,4 @@ function forEachDiagnostic(state, f) {
             f(iter.value.spec.diagnostic, iter.from, iter.to);
 }
 
-export { closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, setDiagnostics, setDiagnosticsEffect };
+export { closeLintPanel, diagnosticCount, forEachDiagnostic, forceLinting, lintGutter, lintKeymap, linter, nextDiagnostic, openLintPanel, previousDiagnostic, setDiagnostics, setDiagnosticsEffect };

package/package.json

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