Skip to content

Commit fa49a70

Browse files
committed
docs: update readme files
1 parent d579f9a commit fa49a70

File tree

4 files changed

+15
-126
lines changed

4 files changed

+15
-126
lines changed

README.md

Lines changed: 10 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -7,43 +7,41 @@
77
<a href="https://nightly.link/vuejs/language-tools/workflows/extension-build/master/extensions.zip"><img src="https://img.shields.io/badge/Nightly%20Build-18181B" alt="Nightly Build"></a>
88
</p>
99

10-
> High-performance Vue language tooling based-on [Volar.js](https://volarjs.dev/)
10+
> ⚡ Vue language toolset with native TypeScript performance based-on [Volar.js](https://volarjs.dev/)
1111
1212
💬 **#language-tools** on our [Discord Server](https://discord.gg/vue)
1313

1414
## Packages
1515

16-
- [Vue Language Features](https://github.com/vuejs/language-tools/tree/master/extensions/vscode) \
16+
- [Vue (Official)](https://github.com/vuejs/language-tools/tree/master/extensions/vscode) \
1717
*Vue, Vitepress, petite-vue language support extension for VSCode*
1818
- [vue-tsc](https://github.com/vuejs/language-tools/tree/master/packages/tsc) \
1919
*Type-check and dts build command line tool*
2020
- [vue-component-meta](https://github.com/vuejs/language-tools/tree/master/packages/component-meta) \
2121
*Component props, events, slots types information extract tool*
22-
- [vite-plugin-vue-component-preview](https://github.com/johnsoncodehk/vite-plugin-vue-component-preview) \
23-
*Vite plugin for support Vue component preview view with `Vue Language Features`*
2422
- [`@vue/language-server`](/packages/language-server/) \
2523
*The language server itself*.
2624
- [`@vue/typescript-plugin`](/packages/typescript-plugin/) \
27-
*Typescript plugin for the language server*.
25+
*TypeScript LanguageService Plugin for Vue*.
2826

2927
## Community Integration
3028

31-
[yaegassy/coc-volar](https://github.com/yaegassy/coc-volar) ⚡ 🤝 🅿️ \
29+
[yaegassy/coc-volar](https://github.com/yaegassy/coc-volar) \
3230
*Vue language client for coc.nvim*
3331

34-
[neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) ⚡ 🤝 \
32+
[neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) \
3533
*Vue language server configuration for Neovim*, check documentation [here](https://github.com/vuejs/language-tools/wiki/Neovim) to set it up.
3634

37-
[mattn/vim-lsp-settings](https://github.com/mattn/vim-lsp-settings) \
35+
[mattn/vim-lsp-settings](https://github.com/mattn/vim-lsp-settings) \
3836
*Vue language server auto configuration for vim-lsp*
3937

40-
[sublimelsp/LSP-volar](https://github.com/sublimelsp/LSP-volar) 🤝 \
38+
[sublimelsp/LSP-volar](https://github.com/sublimelsp/LSP-volar) \
4139
*Vue language client for Sublime*
4240

4341
[kabiaa/atom-ide-volar](https://github.com/kabiaa/atom-ide-volar) \
4442
*Vue language client for Atom*
4543

46-
[emacs-lsp/lsp-mode](https://github.com/emacs-lsp/lsp-mode) ([jadestrong/lsp-volar](https://github.com/jadestrong/lsp-volar)) ⚡ 🤝 \
44+
[emacs-lsp/lsp-mode](https://github.com/emacs-lsp/lsp-mode) ([jadestrong/lsp-volar](https://github.com/jadestrong/lsp-volar)) \
4745
*Vue language client for Emacs*
4846

4947
[tommasongr/nova-vue](https://github.com/tommasongr/nova-vue) \
@@ -61,10 +59,6 @@
6159
[Eclipse WildWebDeveloper](https://github.com/eclipse-wildwebdeveloper/wildwebdeveloper) \
6260
*Vue language server configuration for Eclipse*
6361

64-
\* ⚡ support [multiple servers](https://github.com/vuejs/language-tools/discussions/393#discussioncomment-1213736) \
65-
\* 🤝 support [take over mode](https://github.com/vuejs/language-tools/discussions/471) \
66-
\* 🅿️ support [extra preview features](https://twitter.com/johnsoncodehk/status/1507024137901916161)
67-
6862
<!-- Editor link: https://www.mermaidchart.com/app/projects/c62d8944-0e06-47f0-a8de-f89a7378490f/diagrams/91fd02c0-5c91-4f72-a8b4-7af21b7c4d86/version/v0.1/edit -->
6963

7064
<a href="https://www.mermaidchart.com/raw/91fd02c0-5c91-4f72-a8b4-7af21b7c4d86?theme=light&version=v0.1&format=svg">
@@ -93,82 +87,9 @@ Additional info for contributing to open source projects can be found here: http
9387

9488
To develop with upstream Volar.js modules, you can setup workspace with https://github.com/volarjs/workspace.
9589

96-
---
97-
98-
<table>
99-
<tbody>
100-
<tr>
101-
<td align="center" valign="middle" colspan="6">
102-
<b>Special Sponsor</b>
103-
</td>
104-
</tr>
105-
<tr>
106-
<td align="center" valign="middle" colspan="6">
107-
<br>
108-
<a href="https://voidzero.dev/">
109-
<img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/VoidZero.svg" height="60" />
110-
</a>
111-
<h3>Next Generation Tooling</h3>
112-
</td>
113-
</tr>
114-
<tr>
115-
<td align="center" valign="middle" colspan="6">
116-
<b>Platinum Sponsors</b>
117-
</td>
118-
</tr>
119-
<tr>
120-
<td align="center" valign="middle" width="50%" colspan="3">
121-
<a href="https://vuejs.org/">
122-
<img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/Vue.svg" height="80" />
123-
</a>
124-
<p>An approachable, performant and versatile framework for building web user interfaces.</p>
125-
</td>
126-
<td align="center" valign="middle" width="50%" colspan="3">
127-
<a href="https://astro.build/">
128-
<!-- Expire: 2025-02-04 -->
129-
<img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/Astro.svg" width="200" />
130-
</a>
131-
<p>Astro powers the world's fastest websites, client-side web apps, dynamic API endpoints, and everything in-between.</p>
132-
</td>
133-
</tr>
134-
<tr>
135-
<td align="center" valign="middle" colspan="3">
136-
<!-- Expire: 2025-02-04 -->
137-
<a href="https://www.jetbrains.com/">
138-
<img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/JetBrains.svg" width="80" />
139-
</a>
140-
<p>Essential tools for software developers and teams.</p>
141-
</td>
142-
<td align="center" valign="middle" colspan="3">
143-
<a href="https://stackblitz.com/">
144-
<img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/StackBlitz.svg" width="240" />
145-
</a>
146-
<p>Stay in the flow with instant dev experiences.<br>No more hours stashing/pulling/installing locally</p>
147-
<p><b> — just click, and start coding.</b></p>
148-
</td>
149-
</tr>
150-
<tr>
151-
<td align="center" valign="middle" colspan="6">
152-
<b>Silver Sponsors</b>
153-
</td>
154-
</tr>
155-
<tr>
156-
<td align="center" valign="middle" width="33.3%" colspan="2">
157-
<a href="https://www.prefect.io/"><img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/Prefect.svg" width="200" /></a>
158-
</td>
159-
<td align="center" valign="middle" width="33.3%" colspan="2">
160-
<a href="https://www.techjobasia.com/"><img src="https://raw.githubusercontent.com/johnsoncodehk/sponsors/master/logos/TechJobAsia.svg" width="200" /></a>
161-
</td>
162-
<td align="center" valign="middle" width="33.3%" colspan="2">
163-
<a href="https://haoqun.blog/"><img src="https://avatars.githubusercontent.com/u/3277634?v=4" height="80" /></a>
164-
</td>
165-
</tr>
166-
</tbody>
167-
</table>
90+
## ❤️ Thanks to Our Sponsors
16891

169-
<p align="center">
170-
<a href="https://github.com/sponsors/johnsoncodehk">Become a sponsor</a>
171-
</p>
92+
This project is made possible thanks to our generous sponsors:
17293

17394
<p align="center">
17495
<a href="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg">

extensions/vscode/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,17 @@
77
- [petite](https://github.com/JessicaSachs/petite)
88
- [volar-starter](https://github.com/johnsoncodehk/volar-starter) (For bug report and experiment features testing)
99

10-
## Insiders Program 🚀
1110

12-
This project is community-driven. If you would like to support this project, consider joining the [Insiders Program](https://github.com/vuejs/language-tools/wiki/Get-Insiders-Edition) to improve the sustainability of this project and unlock more features.
11+
## ❤️ Thanks to Our Sponsors
12+
13+
This project is made possible thanks to our generous sponsors:
1314

1415
<p align="center">
1516
<a href="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg">
1617
<img src="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.png"/>
1718
</a>
1819
</p>
1920

20-
<p align="center">
21-
<a href="https://github.com/sponsors/johnsoncodehk">Become a sponsor</a>
22-
</p>
23-
2421
## Credits
2522

2623
- [vscode-extension-samples](https://github.com/microsoft/vscode-extension-samples) shows all the knowledge required to develop the extension.

packages/component-meta/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -169,11 +169,3 @@ You need to add `as const` to variable definition:
169169
- [tests](https://github.com/vuejs/language-tools/blob/master/packages/component-meta/tests/index.spec.ts)
170170
- [Anu's components' API automation](https://github.com/jd-solanki/anu/blob/main/scripts/gen-component-meta.ts)
171171
- [Discord chat for dynamic usage](https://discord.com/channels/793943652350427136/1027819645677350912)
172-
173-
## Sponsors ❤️
174-
175-
<p align="center">
176-
<a href="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg">
177-
<img src="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg"/>
178-
</a>
179-
</p>

packages/tsc/README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
# vue-tsc
22

3-
Install: `npm i vue-tsc -D`
4-
5-
Usage: `vue-tsc --noEmit && vite build`
6-
7-
Vue 3 command line Type-Checking tool base on IDE plugin [Volar](https://github.com/vuejs/language-tools).
8-
9-
Roadmap:
10-
11-
- [x] Type-Checking with `--noEmit`
12-
- [x] Use released LSP module
13-
- [x] Make `typescript` as peerDependencies
14-
- [x] Cleaner dependencies (remove `prettyhtml`, `prettier` etc.) (with `vscode-vue-languageservice` version >= 0.26.4)
15-
- [x] dts emit support
16-
- [x] Watch mode support
3+
Vue 3 command line Type-Checking tool.
174

185
## Usage
196

@@ -25,12 +12,4 @@ Build dts:
2512

2613
`vue-tsc --declaration --emitDeclarationOnly`
2714

28-
Check out https://github.com/vuejs/language-tools/discussions/640#discussioncomment-1555479 for example repo.
29-
30-
## Sponsors
31-
32-
<p align="center">
33-
<a href="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg">
34-
<img src="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg"/>
35-
</a>
36-
</p>
15+
Check out https://github.com/vuejs/language-tools/discussions/640#discussioncomment-1555479 for the example repo.

0 commit comments

Comments
 (0)