Skip to content

Commit 955dabf

Browse files
committed
chore(vscode): update extension metadata and dependencies
- Add icon and update extension category to 'Snippets' - Update description and README to reflect official Vuetify extension - Downgrade @types/vscode from 1.108.1 to 1.107.0 for compatibility - Add LICENSE file for the Vuetify extension
1 parent b4e9924 commit 955dabf

File tree

6 files changed

+62
-36
lines changed

6 files changed

+62
-36
lines changed

packages/vscode/LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016-now Vuetify, LLC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/vscode/README.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,50 @@
1-
# Vuetify
1+
# Vuetify for VS Code
22

33
[![Version](https://img.shields.io/visual-studio-marketplace/v/vuetify.vuetify)](https://marketplace.visualstudio.com/items?itemName=vuetify.vuetify) [![Installs](https://img.shields.io/visual-studio-marketplace/i/vuetify.vuetify)](https://marketplace.visualstudio.com/items?itemName=vuetify.vuetify) [![Reactive VSCode](https://img.shields.io/badge/made_with-reactive--vscode-%23007ACC?style=flat&labelColor=%23229863)](https://kermanx.com/reactive-vscode/)
44

5-
A VS Code extension created with [reactive-vscode](https://kermanx.com/reactive-vscode/).
5+
The official VS Code extension for [Vuetify](https://vuetifyjs.com/).
66

7-
## Directory Structure
7+
## Features
88

9-
- `package.json` - this is the manifest file in which you declare your extension and command.
10-
- `src/extension.ts` - this is the main file where you write your extension.
9+
### ⚡️ Snippets
10+
Boost your productivity with auto-generated snippets for all Vuetify components. Simply type `v-` followed by the component name (e.g., `v-btn`, `v-card`).
1111

12-
## Get started
12+
### 📚 Documentation Integration
13+
Access Vuetify documentation directly from your editor:
14+
- **Hover**: Hover over any Vuetify component tag to see links to its API and Component documentation.
15+
- **Context Menu**: Right-click on a component and select **Vuetify > Open API/Component Documentation**.
16+
- **Quick Fix**: Use the lightbulb icon (Code Actions) to quickly open docs.
1317

14-
- Open this repository in VS Code.
15-
- Run `pnpm install` to install the dependencies.
16-
- Run `pnpm dev` to compile the extension and watch for changes.
17-
- Press `F5` to open a new window with your extension loaded.
18-
- Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
19-
- Set breakpoints in your code inside `src/extension.ts` to debug your extension.
20-
- Find output from your extension in the debug console.
18+
### 🚀 Project Creation
19+
Start a new project easily with the **Vuetify: Create Project** command.
2120

22-
## Make changes
21+
## Commands
2322

24-
- You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
25-
- You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
23+
- `Vuetify: Create Project` - Scaffold a new Vuetify project.
24+
- `Vuetify: Open API Documentation` - Open the API docs for the component under the cursor.
25+
- `Vuetify: Open Component Documentation` - Open the guide page for the component under the cursor.
2626

27-
## Go further
27+
## Development
2828

29-
- [Follow UX guidelines](https://code.visualstudio.com/api/ux-guidelines/overview) to create extensions that seamlessly integrate with VS Code's native interface and patterns.
30-
- [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace.
31-
- Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).
29+
This extension is built with [reactive-vscode](https://kermanx.com/reactive-vscode/).
30+
31+
### Directory Structure
32+
33+
- `package.json` - Manifest file declaring the extension and commands.
34+
- `src/extension.ts` - Main entry point.
35+
- `src/commands/` - Command implementations.
36+
- `src/providers.ts` - Hover and Code Action providers.
37+
38+
### Get Started
39+
40+
1. Open this repository in VS Code.
41+
2. Run `pnpm install` to install dependencies.
42+
3. Run `pnpm dev` to compile and watch for changes.
43+
4. Press `F5` to open a new window with the extension loaded.
44+
5. Set breakpoints in `src/extension.ts` to debug.
45+
46+
### Make Changes
47+
48+
- Relaunch the extension from the debug toolbar after changing code.
49+
- Reload (`Ctrl+R` or `Cmd+R`) the VS Code window to apply changes.
50+
x

packages/vscode/images/icon.png

15.3 KB
Loading

packages/vscode/package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
"version": "0.0.14",
77
"private": true,
88
"categories": [
9-
"Other"
9+
"Snippets"
1010
],
11-
"description": "Vuetify extension for Visual Studio Code (WIP)",
11+
"icon": "images/icon.png",
12+
"description": "Vuetify extension for Visual Studio Code",
1213
"author": "Andrey Yolkin <andreyyolkin@gmail.com>",
1314
"license": "MIT",
1415
"repository": {
@@ -25,7 +26,7 @@
2526
],
2627
"main": "./dist/extension.cjs",
2728
"engines": {
28-
"vscode": "^1.99.0"
29+
"vscode": "^1.107.0"
2930
},
3031
"activationEvents": [
3132
"onStartupFinished"
@@ -105,7 +106,7 @@
105106
},
106107
"devDependencies": {
107108
"@types/node": "catalog:",
108-
"@types/vscode": "catalog:",
109+
"@types/vscode": "1.107.0",
109110
"@vuetify/cli-shared": "workspace:*",
110111
"giget": "catalog:",
111112
"nypm": "catalog:",

pnpm-lock.yaml

Lines changed: 8 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pnpm-workspace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ catalog:
99
'@types/node': ^24.10.7
1010
'@types/semver': ^7.7.1
1111
'@types/validate-npm-package-name': ^4.0.2
12-
'@types/vscode': ^1.108.1
12+
'@types/vscode': 'catalog:'
1313
'@typescript-eslint/parser': ^8.53.0
1414
bumpp: ^10.3.2
1515
citty: ^0.1.6

0 commit comments

Comments
 (0)