Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
client/text editor/code embed: tweak the gutter of CodeMirror when numbers are hidden
Adorian Doran80910e889ec5
diff --git a/packages/codemirror/src/index.spec.ts b/packages/codemirror/src/index.spec.tsindex 8cc7af6715..c1e845af04 100644--- a/packages/codemirror/src/index.spec.ts+++ b/packages/codemirror/src/index.spec.ts@@ -284,6 +284,24 @@ describe("CodeMirror", () => {expect(hasLineNumbers(editor)).toBe(false);});+ it("blends the gutter into the code while the line numbers are off", async () => {+ const theme = getThemeById("github-light");+ expect(theme).not.toBeNull();+ if (!theme) return;+ editor = build({ lineNumbers: false });+ await editor.setTheme(theme);++ const [ hidden ] = getGutterRules(editor);+ expect(hidden).toContain("background-color: transparent;");+ expect(hidden).toContain("border: none;");+ expect(hidden).not.toContain("border-right");++ editor.setLineNumbers(true);+ const [ shown ] = getGutterRules(editor);+ expect(shown).toContain("background-color: #f6f8fa;");+ expect(shown).toContain("border-right: 1px solid");+ });+it("clamps the indent size to a sane range", () => {editor = build();@@ -681,6 +699,13 @@ function build(config: Partial<EditorConfig> = {}): CodeMirror {return new CodeMirror({ parent, ...config });}+/** The `.cm-gutters` rules of `view`, the one that takes effect first. */+function getGutterRules(view: CodeMirror) {+ return view.state.facet(EditorView.styleModule)+ .flatMap((module) => module.getRules().split("\n"))+ .filter((rule) => / \.cm-gutters \{/.test(rule));+}+/** A keydown of `key` from `target`, which the editor does not handle, as it is not dispatched. */function createKeydown(key: string, target: EventTarget, init: KeyboardEventInit = {}) {const event = new KeyboardEvent("keydown", { key, ...init });diff --git a/packages/codemirror/src/index.ts b/packages/codemirror/src/index.tsindex cf31dc8255..abca1b7dbd 100644--- a/packages/codemirror/src/index.ts+++ b/packages/codemirror/src/index.ts@@ -1,7 +1,9 @@import { defaultKeymap, history, historyKeymap } from "@codemirror/commands";import { EditorView, highlightActiveLine, keymap, lineNumbers, placeholder, tooltips, ViewPlugin, ViewUpdate, type EditorViewConfig, KeyBinding } from "@codemirror/view";import { defaultHighlightStyle, StreamLanguage, syntaxHighlighting, indentUnit, bracketMatching, foldGutter, codeFolding } from "@codemirror/language";-import { Compartment, EditorSelection, EditorState, StateEffect, type Extension } from "@codemirror/state";+import {+ Compartment, EditorSelection, EditorState, Prec, StateEffect, type Extension+} from "@codemirror/state";import { highlightSelectionMatches } from "@codemirror/search";import { autocompletion, completionStatus, type CompletionSource } from "@codemirror/autocomplete";import { vim } from "@replit/codemirror-vim";@@ -145,7 +147,9 @@ export default class CodeMirror extends EditorView {typeCompletionCompartment.of([]),completionSourceCompartment.of([]),highlightActiveLine(),- lineNumbersCompartment.of(config.lineNumbers === false ? [] : lineNumbers()),+ lineNumbersCompartment.of(+ config.lineNumbers === false ? hiddenLineNumbersTheme : lineNumbers()+ ),themeCompartment.of([syntaxHighlighting(defaultHighlightStyle, { fallback: true })]),@@ -285,7 +289,11 @@ export default class CodeMirror extends EditorView {this.hasLineNumbers = isShown;this.dispatch({- effects: [ this.lineNumbersCompartment.reconfigure(isShown ? lineNumbers() : []) ]+ effects: [+ this.lineNumbersCompartment.reconfigure(+ isShown ? lineNumbers() : hiddenLineNumbersTheme+ )+ ]});}@@ -578,3 +586,14 @@ function getTooltipHost() {document.body.appendChild(host);return host;}++/**+ * Merges the gutter, which still holds the fold markers, into the code area while the line+ * numbers are off. `Prec.highest` outranks the `.cm-gutters` rule of the color theme.+ */+const hiddenLineNumbersTheme = Prec.highest(EditorView.theme({+ ".cm-gutters": {+ border: "none",+ backgroundColor: "transparent"+ }+}));