feat(editor): syntax-highlight the TOML source with Shiki

This commit is contained in:
Julien Calixte
2026-06-17 01:01:35 +02:00
parent e51f3b96e7
commit 7cd6a1f98e

View File

@@ -1,23 +1,70 @@
<script setup lang="ts"> <script setup lang="ts">
defineProps<{ modelValue: string; error: string | null }>() import { ref, computed, onMounted } from 'vue'
import type { HighlighterCore } from 'shiki/core'
const props = defineProps<{ modelValue: string; error: string | null }>()
const emit = defineEmits<{ 'update:modelValue': [value: string] }>() const emit = defineEmits<{ 'update:modelValue': [value: string] }>()
const textarea = ref<HTMLTextAreaElement>()
const backdrop = ref<HTMLElement>()
const highlighter = ref<HighlighterCore>()
onMounted(async () => {
// Lazy-load Shiki as its own chunk so it stays out of the initial bundle.
// Fine-grained: only the TOML grammar + one light theme, JS engine (no WASM).
const [core, engine, toml, theme] = await Promise.all([
import('shiki/core'),
import('shiki/engine/javascript'),
import('shiki/langs/toml.mjs'),
import('shiki/themes/github-light.mjs'),
])
highlighter.value = await core.createHighlighterCore({
themes: [theme.default],
langs: [toml.default],
engine: engine.createJavaScriptRegexEngine(),
})
})
const highlighted = computed(() => {
// a trailing newline needs a trailing char so the last backdrop line keeps height
const code = props.modelValue.endsWith('\n') ? props.modelValue + ' ' : props.modelValue
const hl = highlighter.value
if (!hl) return `<pre class="shiki"><code>${escapeHtml(code)}</code></pre>`
return hl.codeToHtml(code, { lang: 'toml', theme: 'github-light' })
})
function escapeHtml(s: string): string {
return s.replace(/[&<>]/g, (c) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;' })[c]!)
}
function onInput(e: Event) { function onInput(e: Event) {
emit('update:modelValue', (e.target as HTMLTextAreaElement).value) emit('update:modelValue', (e.target as HTMLTextAreaElement).value)
} }
function syncScroll() {
if (!textarea.value || !backdrop.value) return
backdrop.value.scrollTop = textarea.value.scrollTop
backdrop.value.scrollLeft = textarea.value.scrollLeft
}
</script> </script>
<template> <template>
<div class="editor"> <div class="editor">
<textarea <div class="code">
class="editor-area" <div ref="backdrop" class="backdrop" aria-hidden="true" v-html="highlighted" />
:value="modelValue" <textarea
spellcheck="false" ref="textarea"
autocapitalize="off" class="input"
autocorrect="off" :value="modelValue"
aria-label="Macroplan TOML source" spellcheck="false"
@input="onInput" autocapitalize="off"
></textarea> autocorrect="off"
autocomplete="off"
aria-label="Macroplan TOML source"
@input="onInput"
@scroll="syncScroll"
></textarea>
</div>
<div v-if="error" class="editor-error" role="alert"> <div v-if="error" class="editor-error" role="alert">
<span class="font-semibold">Cant parse:</span> {{ error }} <span class="font-semibold">Cant parse:</span> {{ error }}
</div> </div>
@@ -32,15 +79,20 @@ function onInput(e: Event) {
height: 100%; height: 100%;
min-height: 0; min-height: 0;
} }
.editor-area { .code {
position: relative;
flex: 1; flex: 1;
width: 100%; min-height: 0;
resize: none; }
border: none; /* Backdrop (highlighted) and textarea (input) share identical box metrics so the
outline: none; transparent input text sits exactly over its colored Shiki copy. */
.backdrop,
.input {
position: absolute;
inset: 0;
margin: 0;
border: 0;
padding: 0.9rem 1rem; padding: 0.9rem 1rem;
background: var(--color-base-100);
color: var(--color-base-content);
font-family: inherit; /* Fira Code, from the global theme */ font-family: inherit; /* Fira Code, from the global theme */
font-size: 0.8rem; font-size: 0.8rem;
line-height: 1.6; line-height: 1.6;
@@ -48,9 +100,36 @@ function onInput(e: Event) {
white-space: pre; white-space: pre;
overflow: auto; overflow: auto;
} }
.backdrop {
z-index: 0;
pointer-events: none;
overflow: hidden; /* scroll is driven by the textarea via syncScroll */
background: var(--color-base-100);
color: var(--color-base-content);
}
/* Neutralise Shiki's own <pre> chrome — the .backdrop provides padding/metrics. */
.backdrop :deep(pre.shiki) {
margin: 0;
padding: 0;
background: transparent !important;
white-space: pre;
}
.backdrop :deep(pre.shiki),
.backdrop :deep(pre.shiki code) {
font: inherit;
}
.input {
z-index: 1;
resize: none;
outline: none;
background: transparent;
color: transparent;
caret-color: var(--color-base-content);
}
.input::selection {
background: color-mix(in oklch, var(--color-primary) 28%, transparent);
}
.editor-error { .editor-error {
position: sticky;
bottom: 0;
padding: 0.6rem 1rem; padding: 0.6rem 1rem;
font-size: 0.74rem; font-size: 0.74rem;
background: var(--color-error); background: var(--color-error);