client: Set up syntax highlight in read-only code (closes #504)

This commit is contained in:
Elian Doran 2024-10-19 22:56:45 +03:00
parent 7957c6d34e
commit cab1d7d353
No known key found for this signature in database

View File

@ -1,4 +1,6 @@
import TypeWidget from "./type_widget.js"; import TypeWidget from "./type_widget.js";
import libraryLoader from "../../services/library_loader.js";
import options from "../../services/options.js";
const TPL = ` const TPL = `
<div class="note-detail-readonly-code note-detail-printable"> <div class="note-detail-readonly-code note-detail-printable">
@ -21,9 +23,38 @@ export default class ReadOnlyCodeTypeWidget extends TypeWidget {
doRender() { doRender() {
this.$widget = $(TPL); this.$widget = $(TPL);
this.$content = this.$widget.find('.note-detail-readonly-code-content'); this.$editor = this.$widget.find('.note-detail-readonly-code-content');
super.doRender(); super.doRender();
this.initialized = this.initEditor();
}
async initEditor() {
await libraryLoader.requireLibrary(libraryLoader.CODE_MIRROR);
// these conflict with backward/forward navigation shortcuts
delete CodeMirror.keyMap.default["Alt-Left"];
delete CodeMirror.keyMap.default["Alt-Right"];
CodeMirror.modeURL = `${window.glob.assetPath}/node_modules/codemirror/mode/%N/%N.js`;
CodeMirror.modeInfo.find(mode=>mode.name === "JavaScript").mimes.push(...["application/javascript;env=frontend", "application/javascript;env=backend"]);
CodeMirror.modeInfo.find(mode=>mode.name === "SQLite").mimes=["text/x-sqlite", "text/x-sqlite;schema=trilium"];
this.codeEditor = CodeMirror(this.$editor[0], {
value: "",
viewportMargin: Infinity,
indentUnit: 4,
matchBrackets: true,
matchTags: {bothTags: true},
highlightSelectionMatches: {showToken: false, annotateScrollbar: false},
gutters: ["CodeMirror-lint-markers"],
lineNumbers: true,
// we line wrap partly also because without it horizontal scrollbar displays only when you scroll
// all the way to the bottom of the note. With line wrap, there's no horizontal scrollbar so no problem
lineWrapping: options.is('codeLineWrapEnabled'),
readOnly: true
});
} }
async doRefresh(note) { async doRefresh(note) {
@ -33,7 +64,47 @@ export default class ReadOnlyCodeTypeWidget extends TypeWidget {
content = this.format(content); content = this.format(content);
} }
this.$content.text(content); // CodeMirror breaks pretty badly on null, so even though it shouldn't happen (guarded by a consistency check)
// we provide fallback
this.codeEditor.setValue(content || "");
this.codeEditor.clearHistory();
let info = CodeMirror.findModeByMIME(note.mime);
if (!info) {
// Switch back to plain text if CodeMirror does not have a mode for whatever MIME type we're editing.
// To avoid inheriting a mode from a previously open code note.
info = CodeMirror.findModeByMIME("text/plain");
}
this.codeEditor.setOption("mode", info.mime);
CodeMirror.autoLoadMode(this.codeEditor, info.mode);
this.show();
}
show() {
this.$widget.show();
if (this.codeEditor) { // show can be called before render
this.codeEditor.refresh();
}
}
focus() {
this.$editor.focus();
this.codeEditor.focus();
}
scrollToEnd() {
this.codeEditor.setCursor(this.codeEditor.lineCount(), 0);
this.codeEditor.focus();
}
cleanup() {
if (this.codeEditor) {
this.spacedUpdate.allowUpdateWithoutChange(() => {
this.codeEditor.setValue('');
});
}
} }
async executeWithContentElementEvent({resolve, ntxId}) { async executeWithContentElementEvent({resolve, ntxId}) {