Skip to content

πŸ“š The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.

feat: add rainbow brackets plugin for enhanced bracket visibility in Markdown editor & autoclose brackets & autoclose keymaps

Smaug6739477abe7b44ae
diff --git a/frontend/app/components/MarkdownEditor/modules/bracketsRainbow.ts b/frontend/app/components/MarkdownEditor/modules/bracketsRainbow.ts
new file mode 100644
index 00000000..90b90b04
--- /dev/null
+++ b/frontend/app/components/MarkdownEditor/modules/bracketsRainbow.ts
@@ -0,0 +1,87 @@
+import type { Range } from '@codemirror/state';
+import { EditorView, Decoration, ViewPlugin } from '@codemirror/view';
+
+function generateColors() {
+ return ['blue', 'red', 'orange', 'yellow', 'green', 'teal', 'purple'];
+}
+
+const rainbowBracketsPlugin = ViewPlugin.fromClass(
+ class {
+ decorations;
+
+ constructor(view: EditorView) {
+ this.decorations = this.getBracketDecorations(view);
+ }
+
+ update(update: { docChanged: boolean; selectionSet: boolean; viewportChanged: boolean; view: EditorView }) {
+ if (update.docChanged || update.selectionSet || update.viewportChanged) {
+ this.decorations = this.getBracketDecorations(update.view);
+ }
+ }
+
+ getBracketDecorations(view: EditorView) {
+ const { doc } = view.state;
+ const decorations = [] as Range<Decoration>[];
+ const stack = [] as { type: string; from: number }[];
+ const colors = generateColors();
+
+ for (let pos = 0; pos < doc.length; pos += 1) {
+ const char = doc.sliceString(pos, pos + 1);
+ if (char === '(' || char === '[' || char === '{') {
+ stack.push({ type: char, from: pos });
+ } else if (char === ')' || char === ']' || char === '}') {
+ const open = stack.pop();
+ if (open && open.type === this.getMatchingBracket(char)) {
+ const color = colors[stack.length % colors.length];
+ decorations.push(
+ Decoration.mark({ class: `rainbow-bracket-${color}` }).range(open.from, open.from + 1),
+ Decoration.mark({ class: `rainbow-bracket-${color}` }).range(pos, pos + 1),
+ );
+ }
+ }
+ }
+
+ decorations.sort((a, b) => a.from - b.from);
+
+ return Decoration.set(decorations);
+ }
+
+ getMatchingBracket(closingBracket: string) {
+ switch (closingBracket) {
+ case ')':
+ return '(';
+ case ']':
+ return '[';
+ case '}':
+ return '{';
+ default:
+ return null;
+ }
+ }
+ },
+ {
+ decorations: v => v.decorations,
+ },
+);
+
+export function rainbowBrackets() {
+ return [
+ rainbowBracketsPlugin,
+ EditorView.baseTheme({
+ '.rainbow-bracket-red': { color: 'var(--red)' },
+ '.rainbow-bracket-red > span': { color: 'var(--red)' },
+ '.rainbow-bracket-orange': { color: 'var(--orange)' },
+ '.rainbow-bracket-orange > span': { color: 'var(--orange)' },
+ '.rainbow-bracket-yellow': { color: 'var(--yellow)' },
+ '.rainbow-bracket-yellow > span': { color: 'var(--yellow)' },
+ '.rainbow-bracket-green': { color: 'var(--green)' },
+ '.rainbow-bracket-green > span': { color: 'var(--green)' },
+ '.rainbow-bracket-blue': { color: 'var(--blue)' },
+ '.rainbow-bracket-blue > span': { color: 'var(--blue)' },
+ '.rainbow-bracket-teal': { color: 'var(--teal)' },
+ '.rainbow-bracket-teal > span': { color: 'var(--teal)' },
+ '.rainbow-bracket-purple': { color: 'var(--purple)' },
+ '.rainbow-bracket-purple > span': { color: 'var(--purple)' },
+ }),
+ ];
+}
diff --git a/frontend/app/components/MarkdownEditor/modules/editorState.ts b/frontend/app/components/MarkdownEditor/modules/editorState.ts
index 6547e08e..aafe6085 100644
--- a/frontend/app/components/MarkdownEditor/modules/editorState.ts
+++ b/frontend/app/components/MarkdownEditor/modules/editorState.ts
@@ -2,8 +2,9 @@ import { EditorView, keymap, highlightSpecialChars, drawSelection, lineNumbers,
import { EditorState, Compartment, type Extension } from '@codemirror/state';
import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
import { highlightSelectionMatches, searchKeymap } from '@codemirror/search';
-import { autocompletion } from '@codemirror/autocomplete';
+import { autocompletion, closeBrackets, closeBracketsKeymap } from '@codemirror/autocomplete';
import { markdown, markdownLanguage } from '@codemirror/lang-markdown';
+import { rainbowBrackets } from './bracketsRainbow';
export interface CreateEditorStateParams {
initialDoc: string;
@@ -29,7 +30,9 @@ export function createEditorState(params: CreateEditorStateParams) {
history(),
drawSelection(),
autocompletion(),
- keymap.of([...params.keymaps, ...defaultKeymap, ...historyKeymap, indentWithTab, ...searchKeymap]),
+ rainbowBrackets(),
+ closeBrackets(),
+ keymap.of([...params.keymaps, ...defaultKeymap, ...historyKeymap, indentWithTab, ...searchKeymap, ...closeBracketsKeymap]),
markdown({ base: markdownLanguage }),
markdownLanguage.data.of({
autocomplete: params.snippetSource,