Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hankei6km/vscode-ext-start-webcontainer
Start WebContainer from VS Codde for the Web, and use Jsh and Preview URL.
https://github.com/hankei6km/vscode-ext-start-webcontainer
node vscode-extension webcontainer
Last synced: 16 days ago
JSON representation
Start WebContainer from VS Codde for the Web, and use Jsh and Preview URL.
- Host: GitHub
- URL: https://github.com/hankei6km/vscode-ext-start-webcontainer
- Owner: hankei6km
- License: mit
- Created: 2023-05-25T08:41:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T11:08:01.000Z (6 months ago)
- Last Synced: 2024-05-29T02:35:03.362Z (6 months ago)
- Topics: node, vscode-extension, webcontainer
- Language: TypeScript
- Homepage:
- Size: 2.78 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Start WebContainer
Start [WebContainer](https://webcontainers.io/), and use Jsh and Preview URL.
This extension dynamically generates an external tab with Cross Origin isolation enabled using [Nodebox](https://sandpack.codesandbox.io/docs/advanced-usage/nodebox)(the `Server` tab in the figure below). Therefore, the [`?vscode-coi=on`](https://github.com/microsoft/vscode/issues/137884) parameter is not required in VS Code for the Web.
> ⚠️ VS Code Insiders
>
> VS Code insides for the Web has Cross Origin isolation turned on by default.
>
> https://code.visualstudio.com/blogs/2023/06/05/vscode-wasm-wasi#_vs-codes-wasi-implementation
>
> > The only difficulty with this approach is that `SharedArrayBuffer` and `Atomics` require the site to be [cross-origin isolated](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements), which, because CORS is very viral, can be an endeavor by itself. This is why it is currently only enabled by default on the Insiders version [insiders.vscode.dev](https://insiders.vscode.dev/) and must be enabled using the query parameter `?vscode-coi=on` on [vscode.dev](https://vscode.dev/).
>
> If you use Start WebContainer, you have to set `?vscode-coi=off`.
## Features
- Start WebContainer from VS Code for the Web
- Open a terminal with Jsh
- Open Preview URL with Simple Browser
- Automatically reflect changes to WebContainer when there are any changes to the Workspace file
- Import WebContainer files to Workspace
Background file sync is not supported.
Does not supported to multi-root workspace.
Containers are not persistent.
## Usage
### Start WebContainer(Open terminal with Jsh)
1. Open the Workspace(Local folder or Remote repository)
2. Execute the `Start WebContainer: Start` command from the command palette
3. The URL(`https://*.nodebox.codesandbox.io/`) for starting WebContainer will open in an external tab
4. Workspace files will be loaded to WebContainer
When you edit files in the editor, they will be automatically reflected in WebContainer. However, it will not be reflected in the following cases.
- Changes outside the editor
- Create and delete files
> 📘 `npm install`:
>
> - `npm install` is not executed automatically. Please execute it manually
> - Even if `package.json` and` package-lock.json` are updated, they will not be automatically reflected in the Workspace(See `Start WebContainer: Pick up all files from a container` below)
### Open Preview URL
1. Execute the `Start WebContainer: Preview` command from the command palette
2. Select from the list of available Prview URLs
3. The Preview URL will open in the Simple Browser
### Pick up all files from a WebContainer
1. Execute the `Start WebContainer: Pick up all files from a container` command from the command palette
2. The files in the WebContainer will be overwritten to the Workspace