https://github.com/nvms/svelte-vscode-extension-boilerplate

Visual Studio Code extension boilerplate, using Svelte for the Webview UI
https://github.com/nvms/svelte-vscode-extension-boilerplate

svelte vscode-extension

Last synced: about 2 months ago
JSON representation

Visual Studio Code extension boilerplate, using Svelte for the Webview UI

• Host: GitHub
• URL: https://github.com/nvms/svelte-vscode-extension-boilerplate
• Owner: nvms
• License: other
• Created: 2023-12-07T02:29:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-11T13:07:06.000Z (about 1 year ago)
• Last Synced: 2023-12-11T14:28:16.832Z (about 1 year ago)
• Topics: svelte, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 627 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# svelte-vscode-boilerplate

This is a boilerplate for building a Visual Studio Code extension. This extension has a Webview that hosts a Svelte application. It's based on the Wingman extension: https://github.com/nvms/wingman

![image](.github/media/preview.png)

# Development

1. In `/webview`: `npm run dev`. This is a Svelte project that outputs to `/extension/dist`.

2. In `/extension`: `npm run build:watch`

3. Run the extension using the debug panel.

The `dev` script in `/webview` runs both `vite` and `vite build --watch`. This is so that you can use either http://localhost:5173 (with HMR) or the VSCode extension host (no HMR) to build your UI.

# Releasing

Run the `release` script in `/extension` to bump package.json, create a git tag and push changes to the remote origin. There's a Github workflow that, on tag, builds the extension and publishes to the Visual Studio Marketplace. You'll need to set the repo secret `VS_MARKETPLACE_TOKEN` to your PAT.