tldraw/apps/vscode/extension
David Sheldrick f15a8797f0
Independent instance state persistence (#1493)
This PR 

- Removes UserDocumentRecordType
  - moving isSnapMode to user preferences
  - moving isGridMode and isPenMode to InstanceRecordType
  - deleting the other properties which are no longer needed.
 
- Creates a separate pipeline for persisting instance state.
  
Previously the instance state records were stored alongside the document
state records, and in order to load the state for a particular instance
(in our case, a particular tab) you needed to pass the 'instanceId'
prop. This prop ended up totally pervading the public API and people ran
into all kinds of issues with it, e.g. using the same instance id in
multiple editor instances.

There was also an issue whereby it was hard for us to clean up old
instance state so the idb table ended up bloating over time.
  
This PR makes it so that rather than passing an instanceId, you load the
instance state yourself while creating the store. It provides tools to
make that easy.

- Undoes the assumption that we might have more than one instance's
state in the store.

- Like `document`, `instance` now has a singleton id
`instance:instance`.
- Page state ids and camera ids are no longer random, but rather derive
from the page they belong to. This is like having a foreign primary key
in SQL databases. It's something i'd love to support fully as part of
the RecordType/Store api.

Tests to do

- [x] Test Migrations
- [x] Test Store.listen filtering
- [x] Make type sets in Store public and readonly
- [x] Test RecordType.createId
- [x] Test Instance state snapshot loading/exporting
- [x] Manual test File I/O
- [x] Manual test Vscode extension with multiple tabs
- [x] Audit usages of store.query
- [x] Audit usages of changed types: InstanceRecordType, 'instance',
InstancePageStateRecordType, 'instance_page_state', 'user_document',
'camera', CameraRecordType, InstancePresenceRecordType,
'instance_presence'
- [x] Test user preferences
- [x] Manual test isSnapMode and isGridMode and isPenMode
- [ ] Test indexedDb functions
- [x] Add instanceId stuff back


### Change Type

- [x] `major` — Breaking Change


### Test Plan

1. Add a step-by-step description of how to test your PR here.
2.

- [ ] Unit Tests
- [ ] Webdriver tests

### Release Notes

- Add a brief release note for your PR here.
2023-06-05 14:11:07 +00:00
..
.vscode transfer-out: transfer out 2023-04-25 12:01:25 +01:00
assets transfer-out: transfer out 2023-04-25 12:01:25 +01:00
examples transfer-out: transfer out 2023-04-25 12:01:25 +01:00
scripts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
src Rename tlstore to store (#1507) 2023-06-03 08:59:04 +00:00
.gitignore transfer-out: transfer out 2023-04-25 12:01:25 +01:00
.vscodeignore transfer-out: transfer out 2023-04-25 12:01:25 +01:00
CHANGELOG.md VS Code version bump, changelog. (#1497) 2023-06-01 18:14:35 +00:00
icon.png transfer-out: transfer out 2023-04-25 12:01:25 +01:00
LICENSE transfer-out: transfer out 2023-04-25 12:01:25 +01:00
package.json Rename tlstore to store (#1507) 2023-06-03 08:59:04 +00:00
README.md transfer-out: transfer out 2023-04-25 12:01:25 +01:00
tsconfig.json Independent instance state persistence (#1493) 2023-06-05 14:11:07 +00:00

Introduction

tldraw is a very good whiteboard for the web. This extension will let you use tldraw inside of VS Code, using offline .tldr files. Create drawings, diagrams, or visual documentation, and then commit the files alongside your code!

A screenshot of tldraw in VS Code

Usage

  • To create a new tldraw file, use the provided command: "tldraw: New tldraw File".

A recording of opening tldraw in VS Code

  • To view an existing tldraw file, open a file with the .tldr extension in VS Code.

Tip: The .tldr files you create with this extension can also be opened in the tldraw web app. You can also use this extension to open .tldr files saved from the web app.

Community

Support

Need help? Please open an issue for support.

Discussion

Want to connect with the developers or users? Visit the Discord channel.