Skip to content

refactor(editor): extract theme + highlight from MarkdownEditor #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Jun 9, 2026
Merged

refactor(editor): extract theme + highlight from MarkdownEditor #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 4 additions & 134 deletions apps/desktop/src/renderer/components/MarkdownEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,7 @@ import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirro
import { indentUnit } from '@codemirror/language';
import { markdown, markdownLanguage } from '@codemirror/lang-markdown';
import { languages } from '@codemirror/language-data';
import {
syntaxHighlighting,
HighlightStyle,
indentOnInput,
bracketMatching,
} from '@codemirror/language';
import { tags } from '@lezer/highlight';
import { syntaxHighlighting, indentOnInput, bracketMatching } from '@codemirror/language';
import {
toggleBold,
toggleItalic,
Expand Down Expand Up @@ -51,6 +45,7 @@ import { htmlToGfmMarkdown } from '../utils/htmlToMarkdown';
import { useEditorBufferStore } from '../stores/editorBufferStore';
import { useSettingsStore, selectEditor } from '../stores/settings';
import { setEditorView } from '../hooks/useCommandRegistry';
import { createEditorTheme, markdownHighlighting, SCROLL_PAST_END_PADDING } from './editorTheme.js';

// Compartments for dynamic settings
const lineNumbersCompartment = new Compartment();
Expand All @@ -61,132 +56,8 @@ const tabSizeCompartment = new Compartment();
const scrollPastEndCompartment = new Compartment();
const spellCheckCompartment = new Compartment();

/** Scroll past end padding - allows scrolling content to top of viewport */
const SCROLL_PAST_END_PADDING = '50vh';

/** Create theme with configurable settings (uses CSS variables for colors) */
function createEditorTheme(fontSize: number, fontFamily: string, lineHeight: number) {
return EditorView.theme({
'&': {
backgroundColor: 'transparent',
color: 'var(--cm-text)',
fontSize: `${fontSize}px`,
height: '100%',
},
'.cm-content': {
fontFamily: fontFamily || "'JetBrains Mono', 'SF Mono', 'Fira Code', monospace",
padding: '12px',
lineHeight: String(lineHeight),
caretColor: 'var(--cm-cursor)',
},
'.cm-cursor': {
borderLeftColor: 'var(--cm-cursor)',
borderLeftWidth: '2px',
},
'.cm-selectionBackground, &.cm-focused .cm-selectionBackground': {
backgroundColor: 'var(--cm-selection)',
},
'.cm-activeLine': {
backgroundColor: 'var(--cm-active-line)',
},
'.cm-activeLineGutter': {
backgroundColor: 'var(--cm-active-line)',
},
'.cm-gutters': {
backgroundColor: 'transparent',
borderRight: '1px solid var(--cm-gutter-border)',
color: 'var(--cm-gutter-text)',
},
'.cm-lineNumbers .cm-gutterElement': {
padding: '0 12px 0 16px',
minWidth: '40px',
},
'.cm-scroller': {
overflow: 'auto',
},
'.cm-line': {
padding: '0 4px',
},
'&.cm-focused .cm-matchingBracket': {
backgroundColor: 'var(--cm-bracket-match)',
outline: 'none',
},
// Autocomplete tooltip
'.cm-tooltip-autocomplete': {
backgroundColor: 'var(--cm-tooltip-bg)',
backdropFilter: 'blur(12px)',
border: '1px solid var(--cm-tooltip-border)',
borderRadius: '8px',
boxShadow: '0 8px 32px rgba(0, 0, 0, 0.3)',
overflow: 'hidden',
},
'.cm-tooltip-autocomplete > ul': {
fontFamily: "'Inter', -apple-system, sans-serif",
fontSize: '13px',
maxHeight: '300px',
},
'.cm-tooltip-autocomplete > ul > li': {
padding: '8px 12px',
color: 'var(--cm-tooltip-text)',
cursor: 'pointer',
},
'.cm-tooltip-autocomplete > ul > li[aria-selected]': {
backgroundColor: 'var(--accent-muted)',
color: 'var(--accent)',
},
'.cm-completionLabel': {
fontWeight: '500',
},
});
}

/** Syntax highlighting for Markdown (uses CSS variables for theme-aware colors) */
const markdownHighlighting = HighlightStyle.define([
// Headings
{ tag: tags.heading1, color: 'var(--cm-heading)', fontWeight: '700', fontSize: '1.5em' },
{ tag: tags.heading2, color: 'var(--cm-heading)', fontWeight: '600', fontSize: '1.3em' },
{ tag: tags.heading3, color: 'var(--cm-heading)', fontWeight: '600', fontSize: '1.15em' },
{ tag: tags.heading4, color: 'var(--cm-heading)', fontWeight: '600' },
{ tag: tags.heading5, color: 'var(--cm-heading)', fontWeight: '600' },
{ tag: tags.heading6, color: 'var(--cm-heading)', fontWeight: '600' },

// Emphasis
{ tag: tags.emphasis, fontStyle: 'italic', color: 'var(--cm-emphasis)' },
{ tag: tags.strong, fontWeight: '700', color: 'var(--cm-strong)' },
{ tag: tags.strikethrough, textDecoration: 'line-through', color: 'var(--cm-strikethrough)' },

// Code
{
tag: tags.monospace,
fontFamily: "'JetBrains Mono', monospace",
backgroundColor: 'var(--cm-code-bg)',
padding: '2px 4px',
borderRadius: '3px',
},

// Links
{ tag: tags.link, color: 'var(--cm-link)', textDecoration: 'underline' },
{ tag: tags.url, color: 'var(--cm-link)' },

// Lists
{ tag: tags.list, color: 'var(--cm-list)' },

// Quotes
{
tag: tags.quote,
color: 'var(--cm-quote)',
fontStyle: 'italic',
borderLeft: '3px solid var(--cm-quote-border)',
paddingLeft: '12px',
},

// Meta (like --- for frontmatter)
{ tag: tags.meta, color: 'var(--cm-meta)' },
{ tag: tags.comment, color: 'var(--cm-meta)' },

// Punctuation
{ tag: tags.processingInstruction, color: 'var(--cm-meta)' },
]);
// createEditorTheme, markdownHighlighting, and SCROLL_PAST_END_PADDING
// live in editorTheme.ts.

interface MarkdownEditorProps {
initialContent: string;
Expand Down Expand Up @@ -363,7 +234,6 @@ export const MarkdownEditor = forwardRef<MarkdownEditorHandle, MarkdownEditorPro
// Global plugin error sink — catches exceptions thrown by view plugins
// (instead of crashing the EditorView). Logs to console + Sentry if wired.
EditorView.exceptionSink.of(err => {
// eslint-disable-next-line no-console
console.error('[CodeMirror] plugin error:', err);
const sentry = (
globalThis as unknown as {
Expand Down
139 changes: 139 additions & 0 deletions apps/desktop/src/renderer/components/editorTheme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/**
* CodeMirror theme + syntax highlighting for Readied's MarkdownEditor.
*
* Pure values extracted from MarkdownEditor.tsx so theme tweaks don't
* force a rebuild of the entire editor file. Colors come from CSS
* variables (defined in renderer/styles/) so light/dark switching works
* without rebuilding the EditorView.
*/

import { EditorView } from '@codemirror/view';
import { HighlightStyle } from '@codemirror/language';
import { tags } from '@lezer/highlight';

/** Padding under the document so the user can scroll the last line near the top. */
export const SCROLL_PAST_END_PADDING = '50vh';

/** Build a CodeMirror theme bound to the user's font/size preferences. */
export function createEditorTheme(fontSize: number, fontFamily: string, lineHeight: number) {
return EditorView.theme({
'&': {
backgroundColor: 'transparent',
color: 'var(--cm-text)',
fontSize: `${fontSize}px`,
height: '100%',
},
'.cm-content': {
fontFamily: fontFamily || "'JetBrains Mono', 'SF Mono', 'Fira Code', monospace",
padding: '12px',
lineHeight: String(lineHeight),
caretColor: 'var(--cm-cursor)',
},
'.cm-cursor': {
borderLeftColor: 'var(--cm-cursor)',
borderLeftWidth: '2px',
},
'.cm-selectionBackground, &.cm-focused .cm-selectionBackground': {
backgroundColor: 'var(--cm-selection)',
},
'.cm-activeLine': {
backgroundColor: 'var(--cm-active-line)',
},
'.cm-activeLineGutter': {
backgroundColor: 'var(--cm-active-line)',
},
'.cm-gutters': {
backgroundColor: 'transparent',
borderRight: '1px solid var(--cm-gutter-border)',
color: 'var(--cm-gutter-text)',
},
'.cm-lineNumbers .cm-gutterElement': {
padding: '0 12px 0 16px',
minWidth: '40px',
},
'.cm-scroller': {
overflow: 'auto',
},
'.cm-line': {
padding: '0 4px',
},
'&.cm-focused .cm-matchingBracket': {
backgroundColor: 'var(--cm-bracket-match)',
outline: 'none',
},
// Autocomplete tooltip
'.cm-tooltip-autocomplete': {
backgroundColor: 'var(--cm-tooltip-bg)',
backdropFilter: 'blur(12px)',
border: '1px solid var(--cm-tooltip-border)',
borderRadius: '8px',
boxShadow: '0 8px 32px rgba(0, 0, 0, 0.3)',
overflow: 'hidden',
},
'.cm-tooltip-autocomplete > ul': {
fontFamily: "'Inter', -apple-system, sans-serif",
fontSize: '13px',
maxHeight: '300px',
},
'.cm-tooltip-autocomplete > ul > li': {
padding: '8px 12px',
color: 'var(--cm-tooltip-text)',
cursor: 'pointer',
},
'.cm-tooltip-autocomplete > ul > li[aria-selected]': {
backgroundColor: 'var(--accent-muted)',
color: 'var(--accent)',
},
'.cm-completionLabel': {
fontWeight: '500',
},
});
}

/** Syntax highlighting for Markdown — uses CSS variables so dark/light works. */
export const markdownHighlighting = HighlightStyle.define([
// Headings
{ tag: tags.heading1, color: 'var(--cm-heading)', fontWeight: '700', fontSize: '1.5em' },
{ tag: tags.heading2, color: 'var(--cm-heading)', fontWeight: '600', fontSize: '1.3em' },
{ tag: tags.heading3, color: 'var(--cm-heading)', fontWeight: '600', fontSize: '1.15em' },
{ tag: tags.heading4, color: 'var(--cm-heading)', fontWeight: '600' },
{ tag: tags.heading5, color: 'var(--cm-heading)', fontWeight: '600' },
{ tag: tags.heading6, color: 'var(--cm-heading)', fontWeight: '600' },

// Emphasis
{ tag: tags.emphasis, fontStyle: 'italic', color: 'var(--cm-emphasis)' },
{ tag: tags.strong, fontWeight: '700', color: 'var(--cm-strong)' },
{ tag: tags.strikethrough, textDecoration: 'line-through', color: 'var(--cm-strikethrough)' },

// Code
{
tag: tags.monospace,
fontFamily: "'JetBrains Mono', monospace",
backgroundColor: 'var(--cm-code-bg)',
padding: '2px 4px',
borderRadius: '3px',
},

// Links
{ tag: tags.link, color: 'var(--cm-link)', textDecoration: 'underline' },
{ tag: tags.url, color: 'var(--cm-link)' },

// Lists
{ tag: tags.list, color: 'var(--cm-list)' },

// Quotes
{
tag: tags.quote,
color: 'var(--cm-quote)',
fontStyle: 'italic',
borderLeft: '3px solid var(--cm-quote-border)',
paddingLeft: '12px',
},

// Meta (like --- for frontmatter)
{ tag: tags.meta, color: 'var(--cm-meta)' },
{ tag: tags.comment, color: 'var(--cm-meta)' },

// Punctuation
{ tag: tags.processingInstruction, color: 'var(--cm-meta)' },
]);