create-vscode-editor

Create VS Code Editors

Easily create custom VS Code editors, using React for the UI.

This is an opionated VS Code extension generator with the following features out of the box:

• Editor UIs are built with React
• Editors will automatically work in all VS Code distributions:
  • VS Code desktop
  • github.dev
  • vscode.dev
  • Github Codespaces
• Fast HMR using Vite (Coming soon)
• VS Code (F5) launching integrating
• Instructions and scripts for automatically publishing to the VS Code Marketplace

Checkout the Tldraw VS Code editor extension, that others and I built. This code is extracted from the Tldraw repo.

Install and Run

1. yarn create vscode-editor my-editor
2. cd my-editor
3. yarn start
4. This will automatically open your editor project in VS Code
5. Now iterate on your custom editor by
6. Changing the code in editor/src
7. Use Command+R to reload the extension after you make changes to the editor code ()
8. Rinse and repeat
9. To share your extension:
10. Create an extension installer, you can share directly to people 1. yarn package
11. Coming soon: automated publishing to the Marketplace. For now you can use the workflow where you upload the .vsix installer file

Todos

• Register create-vscode-editor. Running it would be
• yarn create vscode-editor my-editor
• Make it follow the yarn create / create-react-app approach for easily quickly creating a new project
• https://classic.yarnpkg.com/en/docs/cli/create
• https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/
• Switch out Tldraw for a much simpler editor example. Make sure it's somewhat compelling and matches the vision of the project.
• Make yarn start work. Currently you need to have two windows running
  • auto open VS Code to project root
• Remove need to have a VS Code window to debug/run the extension
• Get installer building working
• Make sure setup instructions are accurate
• Add npm publish script

Future Work

• Add tests
  • For the generator
  • To the template to provide ready to go VS Code extension testing for editors
• Add instructions and scripts for publishing automatically to the Marketplace
• Add hot reloading to both the extension and editor app. Switch from esbuild to Vite (uses esbuild anyway)
• Optimize editor instance launch times. Feels like >1sec right now on github.dev, vscode.dev, Codespaces
  • It's much faster on desktop but still not code editor level fast. Tldraw itself might need some optimizing for initialization speed.
  • Can we PWA functionality to cache the frontend?
• Make bidirectional document syncing patch based. This is important for github.dev, vscode.dev, and Codespaces as it reduces network traffic between the extension host and extension browser clientxw.
• Make patching underlying model patch based
• Make the project evolvable. Currently users would have to generate fresh project to get the latest. Instead they should just be able to update the dependency via yarn/npm.
• Provide some optional useful editor building infrastructure
• An undo/redo manager
• An app data model
• Multiplayer framework or Live Share integration
• Utilities for maintaining file formats with best practices for being easily evolvable/serializable.
• Add CLI support for flags for language ts/js and UI frameworks other than react like vue
• Use a proper CLI framework for the generator

This folder contains the source for the tldraw VS Code extension.

Developing

1. Install dependencies

• Run yarn from the root folder

2. Build @tldraw/tldraw

• Run yarn start from the root folder.

3. Start the editor

In the root folder:

• Run yarn start:vscode.

This will start the development server for the vscode/editor project and open the vscode/extension folder in a new window.

In the vscode/extension window, open the terminal and run:

• Install dependencies (yarn)
• Start the VS Code debugger (Menu > Run > Start Debugging)

Open a .tldr file or create a new .tldr file from the command palette.

Publishing

To publish, chat with the team on the Discord channel.

• Install vsce globally
• Run vsce login tldraw-org and sign in

In the vscode/extension folder:

• Run yarn vscode:publish

References

• yarn create
• Yarn Create & Yarn 1.0
• VS Code Marketplace Manager
• Web Extensions Guide
  • Test Your Web Extension
  • Web Extension Testing
  • An example custom editor that does work as a Web Extension
    • https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio
    • https://github.com/hediet/vscode-drawio
• VS Code Extension API/Landing Page
• Getting Started
• Custom Editor API
• github.com/microsoft/vscode-extension-samples
• Extensions Guide -> Webviews
• Publishing Extensions