Enhance frontmatter highlighting with error decoration#844
Open
krataratha wants to merge 7 commits into
Open
Conversation
Added frontmatterError decoration for invalid YAML syntax highlighting.
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the CodeMirror frontmatter highlighter to support richer YAML-like highlighting (keys, values, errors) and adds theme styling for these decorations.
Changes:
- Added an error decoration/class for invalid YAML frontmatter lines.
- Expanded
decorateFrontmatterLineto handle comments/blank lines, nested keys, values, and YAML bullets. - Added/updated CodeMirror plugin + base theme mappings for the new decoration classes.
Comment on lines
+84
to
95
| export function frontmatterHighlightTheme() { | ||
| return EditorView.baseTheme({ | ||
| '.cm-frontmatter-delimiter': { color: 'var(--syntax-frontmatter-key)', fontWeight: '600' }, | ||
| '.cm-frontmatter-key': { color: 'var(--syntax-frontmatter-key)' }, | ||
| '.cm-frontmatter-value': { color: 'var(--syntax-frontmatter-value)' }, | ||
| '.cm-frontmatter-error': { backgroundColor: 'rgba(255, 0, 0, 0.15)', textDecoration: 'underline wavy red' }, | ||
| }) | ||
| } | ||
| text: string, | ||
| isDelimiter: boolean, | ||
| ): void { | ||
| if (text.length === 0) return |
Comment on lines
+75
to
+79
| update(update: { docChanged: boolean; viewportChanged: boolean; view: EditorView }) { | ||
| if (update.docChanged) { | ||
| this.decorations = buildDecorations(update.view) | ||
| } | ||
| } |
Comment on lines
+47
to
+63
| const colonIdx = text.indexOf(':') | ||
|
|
||
| if (colonIdx > 0) { | ||
| // Highlights keys (including indented nested YAML keys) | ||
| const keyStart = text.length - text.trimStart().length | ||
| builder.add(from + keyStart, from + colonIdx, frontmatterKey) | ||
|
|
||
| const valuePart = text.slice(colonIdx + 1).trimStart() | ||
| if (valuePart.length > 0) { | ||
| const valueOffset = text.indexOf(valuePart, colonIdx + 1) | ||
| builder.add(from + valueOffset, from + text.length, frontmatterValue) | ||
| } | ||
| } else if (trimmed.startsWith('- ')) { | ||
| // Feature: Highlight YAML array/bullet items cleanly as values | ||
| const dashOffset = text.indexOf('-') | ||
| builder.add(from + dashOffset + 2, from + text.length, frontmatterValue) | ||
| } else { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added frontmatterError decoration for invalid YAML syntax highlighting.