-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
47 additions
and
613 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,47 @@ | ||
# vscode-webvue | ||
|
||
vscode webview extension template using vue 3 and vite ⚡ | ||
 | ||
|
||
## 🚀 How to use it? | ||
An easy solution for building visual studio code extensions using vue and vite ecosystem ⚡ | ||
|
||
The project is build with monorepo structure containing two packages. The first one is the client and the second one is the vscode extension code itself. | ||
## 🚀 How to use | ||
|
||
For running project in development mode use: | ||
 | ||
|
||
### Install dependencies | ||
|
||
```bash | ||
yarn | ||
``` | ||
|
||
For running project in development mode use | ||
|
||
```bash | ||
yarn run watch | ||
yarn watch | ||
``` | ||
|
||
after vscode instance opened up use command pallate and then select the `hello world` command | ||
### Adding more commands | ||
|
||
Then after VSCode development host opens, use command pallet and select the `hello world` command. | ||
|
||
To add more commands to your extension, edit the `package.json` located in the `/packages/extension` directory, and use the keys in your `extension.ts` file using `vscode.commands.registerCommand` method. | ||
|
||
## 🔧 How it works | ||
|
||
The project is built with monorepo structure containing two packages. The first one being the client, and the second being the visual studio code extension program. | ||
|
||
when you start developing on the `/packages/client/` vue application directory, your changes will be watched using nodemon, then rebuilt and be opened inside vscode extension host ready to be used with vscode command pallet! | ||
|
||
Here you can see your vue project already built and injected using vscode webview API. you can utilize the full functionality of vue such as its amazing reactivity and its available additions (like `vue-router`) out of the box! | ||
|
||
Inside the vue application code, the `vscode` object is globally accessible and can be used to send messages to the vscode runtime and perform tasks such as read/writing files, etc. | ||
|
||
 | ||
 | ||
|
||
Here you can see your vue project already built and injected using vscode webview API. you can utilize the full functionality of vue such as its amazing reactivity and its available plugins out of the box! | ||
## 📄 Blogs | ||
|
||
when you start developing on the `/packages/client/` vue application directory, your changes will be watched using nodemon, then rebuilt and be opened inside vscode extension host ready to be used with vscode command pallate! | ||
[Developing a VS Code Extension using Vue 3 and WebView Panels API](https://medium.com/@mhdi_kr/developing-a-vs-code-extension-using-vue-3-and-webview-panels-api-536d87ce653a) | ||
|
||
Inside the vue application code, the `vscode` object is globally injected and can be used to send messages to the vscode runtime and perform tasks such as read/writing files, etc. | ||
## 🤝 Contribution | ||
|
||
 | ||
If you have any questions or recommendations please create a new issue for it, and if you've hacked together any feature or enhancement, a pull request is more than welcome here! 🙏 |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.