refactor: migrate to Codemirror@6 and update editor functionalities#1586
Merged
refactor: migrate to Codemirror@6 and update editor functionalities#1586
Codemirror@6 and update editor functionalities#1586Conversation
🦋 Changeset detectedLatest commit: 3615599 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
commit: |
Collaborator
【预览链接】
|
Contributor
|
Size Change: +686 kB (+10.58%) Total Size: 7.17 MB 📦 View Changed
ℹ️ View Unchanged
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the Cherry Markdown editor from CodeMirror 5.58.2 to CodeMirror 6.0.1+, introducing a comprehensive compatibility layer (CM6Adapter) to maintain backward compatibility with the existing API while leveraging the new architecture.
Key changes:
- Complete replacement of CodeMirror 5 with CodeMirror 6 modular packages
- Implementation of CM6Adapter class providing CM5-compatible API surface
- Migration of all editor-related utilities and components to CM6 APIs
- Updates to event handling, selection management, and DOM interactions
Reviewed changes
Copilot reviewed 44 out of 49 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Replaces CM5 dependencies with CM6 modular packages, upgrades TypeScript to 5.7.3 |
| types/editor.d.ts | Adds CM6Adapter interface with comprehensive API compatibility definitions |
| types/codemirror.d.ts | Replaces CM5 type extensions with CM6LineBlock interface |
| types/cherry.d.ts | Updates editor type from CM5 Editor to CM6 EditorView |
| src/Editor.js | Implements CM6Adapter class, migrates to CM6 APIs, adds custom syntax highlighter |
| src/Cherry.js | Updates all editor interactions to use CM6 APIs through adapter |
| src/Previewer.js | Adjusts scrolling logic and editor refresh calls for CM6 |
| src/utils/selection.js | Rewrites selection utilities using CM6 state/transaction APIs |
| src/utils/shortcutKey.js | Removes CM5 browser util dependency, implements platform detection |
| src/utils/regexp.js | Refactors regex construction to avoid backreference issues |
| src/utils/pasteHelper.js | Updates DOM queries and event handling for CM6 |
| src/utils/file.js | Changes from doc.replaceSelection to adapter.replaceSelection |
| src/utils/autoindent.js | Adapts list autoindent logic for CM6Adapter |
| src/toolbars/MenuBase.js | Comprehensive rewrite of selection/cursor manipulation for CM6 |
| src/toolbars/hooks/* | Updates all toolbar hooks to use CM6 state.doc.sliceString |
| src/toolbars/Bubble.js | Migrates to CM6 DOM structure (.cm-editor) and coordsAtPos API |
| src/toolbars/FloatMenu.js | Creates compatibility layer for cursor activity events |
| src/toolbars/Toolbar.js | Simplifies toolbar visibility methods |
| src/toolbars/Toc.js | Switches from CM5 events to Cherry event system |
| src/core/hooks/Suggester.js | Updates panel positioning using CM6 coordsAtPos |
| src/sass/*.scss | Updates CSS selectors from .CodeMirror-* to .cm-* |
| yarn.lock | Adds CM6 package dependencies and removes CM5 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
CodeMirror 5 → 6 参考以下进行未来测试覆盖✅ 核心 API 功能列表文档操作
选择操作
光标操作
坐标转换
滚动操作
搜索功能
标记功能
DOM 操作
🎬 事件系统
⚙️ 编辑器配置支持的配置项
⌨️ 键盘快捷键Sublime 风格快捷键 (默认)通过以下 keymap 组合实现：
支持的快捷键：
Vim 模式支持完整的 Vim 键位，可通过配置或运行时切换。 🎨 语法高亮支持的语法元素：
🔧 已修复的问题
📦 依赖变化
🏗️ 架构改进
✨ 新增功能
🧪 测试建议功能测试
性能测试
兼容性测试
📚 相关资源 |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 50 out of 55 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 54 out of 59 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
|
RSS1102
changed the title
Codemirror @6 and update editor functionalitiesCodemirror@6 and update editor functionalities
RSS1102
force-pushed
the
upgrade_codemirror_v6_251213
branch
from
4dd9303 to
ef26ae6
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 60 out of 65 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 60 out of 65 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 60 out of 65 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: Saraph1nes <52569690+Saraph1nes@users.noreply.github.com>
Contributor
|
📦 cherry-markdown dev preview published
Install NPM with : pnpm add cherry-markdown@npm:@cherry-markdown/cherry-markdown-dev@0.11.0-alpha-5-202604030738.c2b9e9eyarn add cherry-markdown@npm:@cherry-markdown/cherry-markdown-dev@0.11.0-alpha-5-202604030738.c2b9e9enpm i cherry-markdown@npm:@cherry-markdown/cherry-markdown-dev@0.11.0-alpha-5-202604030738.c2b9e9e如果你使用了其他以 cherry-markdown 作为同等依赖（peer dependency）的元框架，你需要在 package.json 文件中覆盖 cherry-markdown 依赖，具体操作方式会因你使用的包管理器而略有不同 If you use a meta framework that has cherry-markdown as peer dependency, you have to override the cherry-markdown dependency in your package.json, which works slightly different depending on your package manager # npm
{
"overrides": {
"cherry-markdown": "npm:@cherry-markdown/cherry-markdown-dev@0.11.0-alpha-5-202604030738.c2b9e9e"
}
}
# yarn
{
"resolutions": {
"cherry-markdown": "npm:@cherry-markdown/cherry-markdown-dev@0.11.0-alpha-5-202604030738.c2b9e9e"
}
}
# pnpm
{
"pnpm": {
"overrides": {
"cherry-markdown": "npm:@cherry-markdown/cherry-markdown-dev@0.11.0-alpha-5-202604030738.c2b9e9e"
}
}
}在添加 overrides 之后，重新安装你的依赖并像往常一样启动你的开发服务器或构建你的项目即可，无需进一步的配置更改 After adding these overrides, reinstall your dependencies and start your development server or build your project as usual. No further configuration changes are required |
Contributor
Merged
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.
close #1204