Feature request: Monaco Editor integration option?
See original GitHub issueTell us how you think we can improve Sandpack
Packages affected
- sandpack-client
- sandpack-react
What is this feature?
- An option to use VS Codeās Monaco editor. Codesandbox website uses Monaco, so it would be nice to have a similar experience when cross over between the sandpack version and the codesanbox website (when you click the codesandbox logo in sandpack at the bottom right)
How would your idea work?
- Ideally the API and setup would not be too different from using the existing
@codesanbox/sandpack-react
package. - TODO: need to dig into
monaco-react
package & report API differences & ease of integration
Thoughts regarding monaco-editor
VS Codeās teamās monaco code editor has lots of nice conveniences built right out of the box for a nice text editing experience that code mirror doesnāt have out of the box & require downloading multiple code-mirror add on packages & composing them together
- hover annotations
- peek definition (this can potentially be used to peek content of other files that are already in the sandpack sandbox of the user.
- option clicking editor brings context menu
- command palete
- find all references
https://user-images.githubusercontent.com/6743796/149833470-197826fb-e235-46de-952e-442a1fe0782e.mp4
Demo link (thanks to @aboveyunhai from this Github Discussion #237 )
Questions
Hi @danilowoz,
- Has the team thought about monaco integration in the past?
- Iām probably mixing context & the technical tradeoffs that were made to avoiding getting trapped in the same rabbit holes
- What area of the codebase would I need to look at to help enable this feature if I were to start a new feature branch?
- What level of difficulty or size would you rate this task for a new contributor in this codebase?
Thanks š
References
- monaco-react by @suren-atoyan
- code mirror discussion on running a typescript language server in the browser
- @typescript/vfs - A map based TypeScript Virtual File System
- Run typeScript in the browser
- Run virtual TypeScript environments where files on disk arenāt the source of truth
Issue Analytics
- State:
- Created 2 years ago
- Comments:5 (1 by maintainers)
Top Results From Across the Web
monaco-editor/integrate-esm.md at main - GitHub
This is the easiest method, and it allows for options to be passed into the plugin in order to select only a subset...
Read more >Monaco Editor
The Monaco Editor is the code editor that powers VS Code. A good page describing the code editor's features is here. It is...
Read more >Feature request: add monaco to script editor - Synthetic
Please improve your script editor by integrating monaco. It is the core lib of VSCode from MS and can be used to add...
Read more >Migrating from Monaco Editor to CodeMirror - Sourcegraph
We migrated our search input from Monaco to CodeMirror6. It's been a delightful experience and we are now migrating our Notebooks and otherĀ ......
Read more >Implement Monaco editor in Angular 13 - Stack Overflow
I ended up using import * as monacoRuntime from 'monaco-editor'; export var monaco: typeof import('monaco-editor') = monacoRuntime; to load itĀ ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Hey all, thanks for raising this issue!
Although I wasnāt here when this decision of CodeMirror over Monaco was made, I think I can understand some of the reasons and highlight them here:
Plus, Sandpack is designed to be extensible and provide a basic (but powerful) development experience, so the initial goal was never to support any language server by default but to provide ways (API, documentation, support) for the application consumer (you) implement it by yourself.
Typescript integration So whatās the point of the #237 discussion? We want to empower Sandpack users to use their favorite tools and working environment, but by doing it as an āextensionā and not as a built-in solution. Similar to the approach we took with Prettier and Eslint, we would like to introduce more guides/recipes of how to do it by yourself and customize it in your favor, based on your needs.
Still want to use Monaco? In fact, you can easily switch from CodeMirror to Monaco at your end, as Sandpack exposes all the APIs needed to implement it. Here is an example using Monaco in Sandpack:
Hope it makes clear this whole situation around the LSP and the editor options. Any further questions, Iām more than happy to answer them, otherwise, Iād close this issue. š
Thanks for the awesome responses with added context! š going to close this issue
If anyone else stumbles on this thread, found another good read on monaco vs codemirror technical blog post