Fixes#91670
- Move model type logic out of `CustomEditorInput` and into two different implementations of `ICustomEditorModel`
- Add `CustomTextEditorModel` that owns a proper model reference to a text document. This should ensure the text document is disposed of if there are no more references to it
- Move most of the previous `CustomEditorModel` into `mainThreadWebviews` directly. This removes some of the indirection that was previously required (such as using `waitUntil`)
For #77131
**Motivation**
While our existing webview editor API proposal more or less works, building an editable webview editor is fairly tricky using it! This is especially true for simple text based editors.
It'd also be nice if we could get bi-directional live editing for text files. For example, if I open the same file in a webview editor and in VS Code's normal editor, edits on either side should be reflected in the other. While this can sort of be implemented using the existing API, it has some big limitations
**Overview of changes**
To address these problems, we've decided have two types of webview editors:
- Text based webview editors. These editors used a `TextDocument` as their data model, which considerably simplifies implementing an editable webview. In almost all cases, this should be what you use for text files
- Complex webview editors. This is basically the existing proposed API. This gives extension hooks into all the VS Code events, such as `save`, `undo`, and so on. These should be used for binary files or in very complex text editor cases.
Both editor types now have an explicit model layer based on documents. Text editor use `TextDocument` for this, while custom editors use `WebviewEditorCustomDocument`. This replaces the delegate based approach previously used.
Adds a backup method to the custom editor API proposal. This method allows custom editors to hook in to VS Code's hot exit behavior
If `backup` is not implemented, VS Code will assume that the custom editor cannot be hot exited.
When `backup` is implemented, VS Code will invoke the method after every edit (this is debounced). At this point, this extension should back up the current resource. The result is a promise indicating if the backup was successful or not
VS Code will only hot exit if all backups were successful.
For #88719
With this change, instead of passing custom editor edit json back and forth with the extension host, we keep the original edit objects on the extension host. This means that we can pass extensions back the exact same edit object they first hand to us. It also means that edits no longer need to be json serializable.
When the core references `vscode`, we only want to import the types and never generate a real import (which will fail to load). Use `import type` to better enforce this
If multiple instances of the same custom editor are opened for the same resource, the edit stack should be shared between them. This matches how we work with text files
Split out from #77131
The current webview editor api is very procedural. This model has some problems when it comes to supporting editing resources, but actually does make a lot of sense for webviews that aren't backed by real file system resources. For example, if you have a webview that edits some document in the cloud, you should not be required to implement a custom file system provider just to enable basic saving.
This change moves the `onWillSave` and `webviewEditorState` properties back onto `WebviewPanel` instead of keeping them specific to `WebviewEditor`. The save implementation does not fully work yet, as the will require #81521
This fixes an issue where webviews for custom editors did not have any associated extension information, which caused them try reading `file:` uri resources instead of remote uri resources
* Custom Editor exploration
For #77131
Adds a prototype of custom editors contributed by extensions. This change does the following:
- Introduces a new contribution point for the declarative parts of a custom editor
- Adds API for registering a webview editor provider. This lets VS Code decided when to create a webview editor
- Adds an `openWith` command that lets you select which editor to use to open a resource from the file explorer
- Adds a setting that lets you say that you always want to use a custom editor for a given file extension
- Hooks up auto opening of a custom editor when opening a file from quick open or explorer
- Adds a new extension that contributes a custom image preview for png and jpg files
Still needs a lot of UX work and testing. We are also going to explore a more generic "open handler" based approach for supporting custom editors
Revert
* Re-use existing custom editor if one is already open
* Don't re-create custom editor webview when clicking on already visible custom editor
* Move customEditorInput to own file
* First draft of serializing custom editor inputs
* Use glob patterns instead of simple file extensions for matching custom resoruces for custom editors
* Add descriptions
* Try opening standard editor while prompting for custom editor
* Make sure we hide image status on dispose
* Make sure we restore editor group too
* Use glob patterns for workbench.editor.custom
* Allow users to configure custom editors for additional file types
* Use filename glob instead of glob on full resource path
* Adding placeholder for prompt open with
* Add enableByDefault setting for editor contributions
* Enable custom editors by default and add `discretion` enum
Changes `enableByDefault` boolean to a `discretion` enum. This should give more flexibility if we want other options (such as forcing a given custom editor to always be used even if there are other default ones)
* Allow custom editors to specify both a scheme and filenamePattern they are active for
* Rework custom editor setting
* Don't allow custom editors to be enabled for all resources by a config mistake
* Replace built-in image editor with one from extension
* Adding reopen with command
* Improve comment
* Remove commented code
* Localize package.json and remove image
* Remove extra lib setting from tsconfig
Fixes#79492
Simplifies view state management logic in `mainThreadWebviews` to:
* Not be stateful
* Handle cases where a webview's view state changes through a more complex means (see #79492 for an example of this)
