438 lines
16 KiB
Vue
438 lines
16 KiB
Vue
<script setup lang="ts">
|
||
/**
|
||
* CM6 编辑器宿主。
|
||
*
|
||
* 职责:装配 EditorView、把文档变更回写 store(含自动保存防抖)、
|
||
* 按设置热重配置(主题/排版/行号/Live Preview 开关/语言)。
|
||
*
|
||
* # 编辑器实例为什么不是响应式的
|
||
*
|
||
* EditorView 存普通变量、不进 `ref`:把它放进 Vue 响应式系统会让整个 CM state 树
|
||
* 被 Proxy 包一层,既慢又容易被误触发(CM6 的 state 是不可变对象,语义上就不该
|
||
* 被 Vue 追踪)。
|
||
*
|
||
* # 「整篇替换」的判据是 docRevision,不是内容字符串
|
||
*
|
||
* 只比对内容会把用户自己的每一次输入也当成外部替换(光标被弹回行首);
|
||
* 只比对路径又漏掉「同一篇被外部改动后重载」。因此用 store 里的自增
|
||
* `docRevision`:只有在**整篇装载**(打开/重载)时才替换文档。
|
||
*
|
||
* # 语言是异步来的
|
||
*
|
||
* 语言包按需 `import()`(见 `editor/languages.ts`)。这里 watch 的是
|
||
* `store.language`(一个 thunk),拿到后就地 `setLanguageExtension`;
|
||
* 旧语言的过期结果由 store 里的令牌机制丢弃,这里不需要再判一次。
|
||
*/
|
||
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue'
|
||
import { EditorView } from '@codemirror/view'
|
||
import { useEditorStore } from '@/stores/editorStore'
|
||
import {
|
||
createEditorState,
|
||
jumpToPosition,
|
||
reconfigureEditor,
|
||
setLanguageExtension,
|
||
type EditorConfig
|
||
} from '../editor/core'
|
||
import { editorBackground } from '../editor/themes'
|
||
import { createLogger } from '@/lib/logger'
|
||
import type { LanguageLoader } from '../editor/languages'
|
||
import type { EditorState, Extension } from '@codemirror/state'
|
||
|
||
const logger = createLogger('editor')
|
||
|
||
const props = defineProps<{
|
||
/**
|
||
* 编辑器**窗口**当前是否深色(由 EditorWindow 按「跟随主应用主题 / 配色方案」推导)。
|
||
* 用于:跟随应用时按它取深浅变体,配色方案为「跟随系统」时按它取 VS Code 深/浅。
|
||
*/
|
||
isDark: boolean
|
||
/** 是否启用 Live Preview */
|
||
livePreview: boolean
|
||
/**
|
||
* 绑定的标签 id(并排副面板用)。
|
||
*
|
||
* 缺省(主面板)= 绑定 store 的**扁平活动文档**;给出 id 时 = 绑定该标签**自己的缓冲**
|
||
* (读 `tab.content`、写 `tab.content` 并置脏、保存走 `saveTab`)。副面板永远绑定非活动
|
||
* 标签,因此不会与主面板争抢扁平 state。
|
||
*/
|
||
tabId?: string
|
||
}>()
|
||
|
||
const emit = defineEmits<{
|
||
/** 光标移动(行号 1 起,列号 1 起) */
|
||
'cursor-moved': [line: number, column: number]
|
||
/** 点击了 `[[wikilink]]`(`target` 是去掉 `#` 与别名后的笔记名) */
|
||
'wikilink': [target: string]
|
||
}>()
|
||
|
||
const store = useEditorStore()
|
||
const hostRef = ref<HTMLDivElement | null>(null)
|
||
|
||
/** 是否为「绑定某个标签」的副面板(否则为主面板,读扁平 state)。 */
|
||
const isPane = computed(() => !!props.tabId)
|
||
/** 副面板绑定的标签(主面板为 null)。 */
|
||
const boundTab = computed(() =>
|
||
props.tabId ? store.tabs.find(t => t.id === props.tabId) ?? null : null
|
||
)
|
||
|
||
/** 需要读取的文档属性:主面板取扁平 state,副面板取标签缓冲。 */
|
||
const paneContent = computed(() => (isPane.value ? boundTab.value?.content ?? '' : store.content))
|
||
const paneLarge = computed(() =>
|
||
isPane.value ? boundTab.value?.fileDoc?.large ?? false : store.fileDoc?.large ?? false
|
||
)
|
||
const paneKind = computed(() => (isPane.value ? boundTab.value?.kind ?? 'none' : store.kind))
|
||
const paneRelPath = computed(() =>
|
||
isPane.value ? boundTab.value?.relPath ?? '' : store.currentRelPath
|
||
)
|
||
const paneRevision = computed(() =>
|
||
isPane.value ? boundTab.value?.docRevision ?? 0 : store.docRevision
|
||
)
|
||
const paneLanguage = computed<LanguageLoader>(() =>
|
||
isPane.value ? boundTab.value?.language ?? (() => Promise.resolve(null)) : store.language
|
||
)
|
||
|
||
/**
|
||
* 编辑器外壳底色:跟随当前**实际生效**的主题。
|
||
*
|
||
* CM6 只会绘制 `.cm-editor` 覆盖到的区域,正文下方留白等仍由外壳容器显示;
|
||
* 若外壳透明就会透出窗口的 mica 背景(表现为「编辑器背景是透明的」)。
|
||
*/
|
||
const hostBackground = computed(() =>
|
||
editorBackground(String(store.settings.editorTheme), store.settings.followAppTheme, props.isDark)
|
||
)
|
||
|
||
let view: EditorView | null = null
|
||
let autosaveTimer: ReturnType<typeof setTimeout> | null = null
|
||
/** 已应用的文档版本,避免重复整篇替换 */
|
||
let appliedRevision = -1
|
||
/** 语言令牌:丢弃过期的异步加载结果(与 store 里的令牌是两层保险) */
|
||
let languageSeq = 0
|
||
|
||
/**
|
||
* 每个标签自己的 EditorState(撤销历史随标签保留)。
|
||
*
|
||
* CM6 的撤销历史挂在 **EditorState 的字段**上,没有「只导出历史」的公开 API,因此
|
||
* 「按标签保存撤销历史」就等于「按标签保存整个 state」:切换标签时把当前 state
|
||
* 收进缓存、把目标标签的 state 装回同一个 `EditorView`。缓存只保留仍打开的标签
|
||
* (见下方按标签集合的清理 watch),关闭标签即释放。
|
||
*/
|
||
const stateCache = new Map<string, EditorState>()
|
||
/** 当前 view 装载的是哪个标签的 state(空串 = 未绑定)。 */
|
||
let boundKey = ''
|
||
|
||
/** 当前面板的缓存键:主面板 = 活动标签,副面板 = 它绑定的标签。 */
|
||
function paneKey(): string {
|
||
if (isPane.value) return props.tabId ?? ''
|
||
return store.activeTabId || ''
|
||
}
|
||
|
||
function currentConfig(): EditorConfig {
|
||
const s = store.settings
|
||
const large = paneLarge.value
|
||
const note = paneKind.value === 'note'
|
||
return {
|
||
livePreview: props.livePreview,
|
||
showLineNumbers: s.showLineNumbers,
|
||
tabSize: s.tabSize,
|
||
fontFamily: s.fontFamily,
|
||
fontSize: s.fontSize,
|
||
lineHeight: s.lineHeight,
|
||
ligatures: s.ligatures,
|
||
theme: String(s.editorTheme),
|
||
followAppTheme: s.followAppTheme,
|
||
isDark: props.isDark,
|
||
// 初始语言留空:语言由 applyLanguage 单独设置(见下方 watch),
|
||
// 放在这里会让每次 reconfigure 都把语言重置一遍(异步加载的结果被抹掉)
|
||
language: () => null,
|
||
largeFile: large,
|
||
autocomplete: s.autocomplete,
|
||
wikilink: s.wikilink && note,
|
||
onWikilink: target => emit('wikilink', target),
|
||
// 图片预览只在库内笔记里有意义(库外文件没有库根上下文)
|
||
currentRelPath: note ? paneRelPath.value : '',
|
||
images: note
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 构造一个**全新的**编辑器状态(初次装配 / 无法复用缓存时)。
|
||
*
|
||
* # 为什么整篇装载必须换 state,而不是 dispatch 一次替换
|
||
*
|
||
* CM6 的撤销历史是 `history()` 里的状态字段,按**同一个 EditorState** 记录。
|
||
* 若用 `dispatch({changes: 全文替换})` 装载另一个文件,新文档会继承上一份文档的
|
||
* 撤销栈:随后的 Ctrl+Z 就会把别的文件的历史改动「回退」进当前标签页。
|
||
* `EditorView.setState` 会连同历史字段一起换成新的状态(焦点保留)。
|
||
*
|
||
* 可复用的标签状态由 `stateCache` 提供(见上方);这里只负责「缓存不可用」的情形:
|
||
* 首次打开、或该标签的内容已在别处被改过(并排副面板编辑 / 外部重载)。
|
||
*/
|
||
function buildState(doc: string): EditorState {
|
||
return createEditorState({
|
||
doc,
|
||
config: currentConfig(),
|
||
onDocChanged: next => {
|
||
if (isPane.value && props.tabId) store.setTabContent(props.tabId, next)
|
||
else store.setContent(next)
|
||
scheduleAutosave()
|
||
},
|
||
// 副面板的光标不该覆盖状态栏(状态栏跟随活动文档)
|
||
onSelectionChanged: (line, column) => {
|
||
if (!isPane.value) emit('cursor-moved', line, column)
|
||
}
|
||
})
|
||
}
|
||
|
||
function scheduleAutosave(): void {
|
||
const ms = store.settings.autosaveMs
|
||
if (!ms) return
|
||
if (autosaveTimer) clearTimeout(autosaveTimer)
|
||
autosaveTimer = setTimeout(() => {
|
||
autosaveTimer = null
|
||
void persist().catch(() => undefined)
|
||
}, ms)
|
||
}
|
||
|
||
/** 落盘:主面板存活动文档,副面板存它绑定的标签。 */
|
||
function persist(): Promise<void> {
|
||
return isPane.value && props.tabId ? store.saveTab(props.tabId) : store.saveCurrent()
|
||
}
|
||
|
||
function flushAutosave(): void {
|
||
if (autosaveTimer) {
|
||
clearTimeout(autosaveTimer)
|
||
autosaveTimer = null
|
||
}
|
||
void persist().catch(() => undefined)
|
||
}
|
||
|
||
/** 加载并应用当前文档的语言扩展。 */
|
||
async function applyLanguage(seq: number): Promise<void> {
|
||
if (!view) return
|
||
let extension: Extension | null = null
|
||
try {
|
||
extension = await paneLanguage.value()
|
||
} catch (e) {
|
||
logger.warn(`语言扩展加载失败:${String(e)}`)
|
||
}
|
||
// 期间用户又切了文档 → 这次结果作废
|
||
if (seq !== languageSeq || !view) return
|
||
setLanguageExtension(view, extension)
|
||
}
|
||
|
||
onMounted(() => {
|
||
if (!hostRef.value) return
|
||
view = new EditorView({
|
||
parent: hostRef.value,
|
||
state: buildState(paneContent.value)
|
||
})
|
||
boundKey = paneKey()
|
||
if (boundKey) stateCache.set(boundKey, view.state)
|
||
appliedRevision = paneRevision.value
|
||
void applyLanguage(++languageSeq)
|
||
})
|
||
|
||
/**
|
||
* 整篇装载(切标签 / 打开笔记 / 打开文件 / 重载):换入目标文档的状态。
|
||
*
|
||
* 用 `docRevision` 而不是路径:重载同一篇时路径没变,但内容必须被换掉。
|
||
*
|
||
* 两条路:
|
||
* - **切标签**(缓存键变了)且该标签的缓存内容与当前内容一致 → 装回缓存 state,
|
||
* 撤销历史 / 选区随之保留;
|
||
* - 否则(首次打开、同标签重载、内容已在别处被改过)→ 重建全新 state。
|
||
*/
|
||
watch(
|
||
paneRevision,
|
||
revision => {
|
||
if (!view) return
|
||
if (autosaveTimer) {
|
||
clearTimeout(autosaveTimer)
|
||
autosaveTimer = null
|
||
}
|
||
if (appliedRevision === revision) return
|
||
appliedRevision = revision
|
||
|
||
const key = paneKey()
|
||
const switching = key !== boundKey
|
||
// 离开当前文档前把它的 state 收回缓存(撤销历史 + 选区都在里面)
|
||
if (boundKey && switching) stateCache.set(boundKey, view.state)
|
||
|
||
// 只复用「换到另一个标签」且内容对得上的缓存。内容不一致说明该标签在别处
|
||
// 被改过(并排副面板编辑 / 外部重载),旧 state 的文档与撤销历史都不能再用。
|
||
const cached = switching && key ? stateCache.get(key) : undefined
|
||
if (cached && cached.doc.toString() === paneContent.value) {
|
||
view.setState(cached)
|
||
boundKey = key
|
||
// 缓存期间设置可能变过:主题 / 排版 / Live Preview / wikilink 重新配置。
|
||
// 语言不进 reconfigure(见 currentConfig 的注释),由下面的 applyLanguage 负责。
|
||
try {
|
||
reconfigureEditor(view, currentConfig())
|
||
} catch (e) {
|
||
logger.error(`恢复标签状态后重配置失败:${String(e)}`)
|
||
}
|
||
void applyLanguage(++languageSeq)
|
||
return
|
||
}
|
||
|
||
// 目标光标行要在 setState **之前**取:新状态的 selection 变化会被
|
||
// updateListener 回写成 1,之后再读就只剩第 1 行了。
|
||
const restoreLine = isPane.value ? 1 : store.cursorLine
|
||
// 重建状态而不是 dispatch 整篇替换:撤销历史必须随文档隔离(见 buildState)
|
||
view.setState(buildState(paneContent.value))
|
||
boundKey = key
|
||
if (key) stateCache.set(key, view.state)
|
||
// 标签切换 / 会话恢复:按 store.cursorLine 复位光标(默认第 1 行不动)
|
||
if (restoreLine > 1) {
|
||
const line = Math.min(restoreLine, view.state.doc.lines)
|
||
const pos = view.state.doc.line(line).from
|
||
view.dispatch({ selection: { anchor: pos }, scrollIntoView: false })
|
||
}
|
||
void applyLanguage(++languageSeq)
|
||
}
|
||
)
|
||
|
||
/**
|
||
* 标签集合变化时丢掉已关闭标签的状态。
|
||
*
|
||
* 每个缓存项持有一整份文档 + 撤销栈,不清理会随「开过多少文件」一直增长。
|
||
* 副面板的缓存只有它自己绑定的那一个标签,同样随标签关闭失效。
|
||
*/
|
||
watch(
|
||
() => store.tabs.map(t => t.id).join('\u0000'),
|
||
() => {
|
||
if (!stateCache.size) return
|
||
const alive = new Set(store.tabs.map(t => t.id))
|
||
for (const key of stateCache.keys()) {
|
||
if (!alive.has(key)) stateCache.delete(key)
|
||
}
|
||
}
|
||
)
|
||
|
||
/** 语言变化(异步加载完成 / 切换到另一种语言)。 */
|
||
watch(paneLanguage, () => {
|
||
void applyLanguage(++languageSeq)
|
||
})
|
||
|
||
/**
|
||
* 切换笔记:Live Preview 的图片预览按「相对当前笔记所在目录」解析目标,
|
||
* 因此换一篇就要重建一次装饰(把新的 `currentRelPath` 交给它)。
|
||
*
|
||
* 只动 mode 与 wikilink 两个 compartment:语言由 `applyLanguage` 单独负责,
|
||
* 在这里一并 reconfigure 会把刚异步加载好的语言重置掉。
|
||
*/
|
||
watch(paneRelPath, () => {
|
||
if (!view) return
|
||
try {
|
||
reconfigureEditor(view, currentConfig())
|
||
} catch (e) {
|
||
logger.error(`切换笔记后重配置失败:${String(e)}`)
|
||
}
|
||
})
|
||
|
||
/** 设置 / 深浅 / 视图模式 / 文档类型变化:热重配置,不重建编辑器。 */
|
||
watch(
|
||
() => [store.settings, props.isDark, props.livePreview, paneLarge.value],
|
||
() => {
|
||
if (!view) return
|
||
try {
|
||
reconfigureEditor(view, currentConfig())
|
||
} catch (e) {
|
||
logger.error(`重配置编辑器失败:${String(e)}`)
|
||
}
|
||
},
|
||
{ deep: true }
|
||
)
|
||
|
||
onBeforeUnmount(() => {
|
||
flushAutosave()
|
||
view?.destroy()
|
||
view = null
|
||
stateCache.clear()
|
||
boundKey = ''
|
||
})
|
||
|
||
defineExpose({
|
||
focus: () => view?.focus(),
|
||
getView: () => view,
|
||
/** 大纲点击跳转 */
|
||
jumpTo: (position: number) => {
|
||
if (view) jumpToPosition(view, position)
|
||
},
|
||
/**
|
||
* 跳转到某行某列(统一搜索器的「在目录 / 库中查找」结果点击用)。
|
||
*
|
||
* 行号可能来自**稍早的**检索结果,用户在此期间可能已编辑 —— 越界一律夹到文档
|
||
* 范围内(同 `jumpToPosition` 的取舍:跳到近似位置好过整块报错)。
|
||
*/
|
||
jumpToLine: (line: number, column = 1) => {
|
||
if (!view) return
|
||
const total = view.state.doc.lines
|
||
const number = Math.max(1, Math.min(Math.floor(line), total))
|
||
const info = view.state.doc.line(number)
|
||
const anchor = Math.min(info.to, info.from + Math.max(0, column - 1))
|
||
view.dispatch({ selection: { anchor }, scrollIntoView: true })
|
||
view.focus()
|
||
}
|
||
})
|
||
</script>
|
||
|
||
<template>
|
||
<div
|
||
ref="hostRef"
|
||
class="editor-host h-full min-h-0 overflow-hidden"
|
||
:style="{ background: hostBackground }"
|
||
/>
|
||
</template>
|
||
|
||
<style scoped>
|
||
.editor-host :deep(.cm-editor) {
|
||
height: 100%;
|
||
/* 不写 background: transparent —— 让 CM6 主题自己的底色生效(见 themes.ts) */
|
||
}
|
||
.editor-host :deep(.cm-scroller) {
|
||
padding: 12px 8px 32px;
|
||
overflow: auto;
|
||
/* 滚动条与项目 ScrollArea 一致:细轨 + 圆角 thumb(同终端 xterm 的做法) */
|
||
scrollbar-width: thin;
|
||
scrollbar-color: var(--border) transparent;
|
||
}
|
||
.editor-host :deep(.cm-scroller)::-webkit-scrollbar {
|
||
width: 10px;
|
||
height: 10px;
|
||
}
|
||
.editor-host :deep(.cm-scroller)::-webkit-scrollbar-track {
|
||
background: transparent;
|
||
}
|
||
.editor-host :deep(.cm-scroller)::-webkit-scrollbar-thumb {
|
||
background: var(--border);
|
||
border: 3px solid transparent;
|
||
border-radius: 9999px;
|
||
background-clip: padding-box;
|
||
}
|
||
.editor-host :deep(.cm-scroller)::-webkit-scrollbar-thumb:hover {
|
||
background: var(--muted-foreground);
|
||
background-clip: padding-box;
|
||
}
|
||
.editor-host :deep(.cm-scroller)::-webkit-scrollbar-corner {
|
||
background: transparent;
|
||
}
|
||
.editor-host :deep(.cm-editor.cm-focused) {
|
||
outline: none;
|
||
}
|
||
/* 统一搜索器的命中高亮:改用应用语义色,而不是 @codemirror/search 自带的黄/橙
|
||
—— 自带色在浅色主题下几乎看不见,也与应用观感割裂 */
|
||
.editor-host :deep(.cm-searchMatch) {
|
||
background: color-mix(in srgb, var(--primary) 26%, transparent);
|
||
outline: none;
|
||
border-radius: 2px;
|
||
}
|
||
.editor-host :deep(.cm-searchMatch.cm-searchMatch-selected) {
|
||
background: color-mix(in srgb, var(--primary) 55%, transparent);
|
||
}
|
||
/* 笔记正文里正文与标题之间留些气口,Live Preview 下更接近阅读视图 */
|
||
.editor-host :deep(.cm-content) {
|
||
padding-bottom: 24vh;
|
||
}
|
||
</style>
|