a95b581e07
* Changed Wardlt use back to Tldraw. Added some VS Code marketplace categories * Missed removing one Wardlt mention * Initial support for esbuild based vscode extension workflow. * Hacky start of vs code extension build script * Fixed categories of extension * Added script for generating VS Code extension installer * Temp fix for file format change affecting VS Code extension * Temp fix for file format change issue * Cleanup, prevent changes from saving pagestates * Remove logic around saving pageState * standardize capitalization * v0.1.8 * Edit readme, scripts * Update .eslintignore * v0.1.9 * v0.1.10 * cleans up build scripts, adds publishing notes * Added VS Code extension implementation references links. start:vscode now auto opens the extension folder in VS Code * Removed step from VS Code README to manually open the extensions folder * Removed file * v0.1.11 * v0.1.12 * Fix empty file * v0.1.13 * README cleanup * v0.1.14 * Update TLDrawEditorProvider.ts * v0.1.15 * Fix types for file extension (sort of) build script for extension Co-authored-by: Steve Ruiz <steveruizok@gmail.com> |
||
---|---|---|
.. | ||
editor | ||
extension | ||
README.md |
@tldraw/vscode
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 build:packages
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
- 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
- VS Code Extension API/Landing Page
- Getting Started
- Custom Editor API
- github.com/microsoft/vscode-extension-samples
- Extensions Guide -> Webviews
- Publishing Extensions