Skip to content

Commit

Permalink
Update the readme (#856)
Browse files Browse the repository at this point in the history
Remove reference to Volar in the README.
  • Loading branch information
tristanbay authored Feb 11, 2025
1 parent 7ff9e2f commit 100c2c2
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,22 +193,11 @@ The app is built using [Vue](https://vuejs.org/). This information should help g

## Recommended IDE Setup

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) + [Vitest](https://marketplace.visualstudio.com/items?itemName=vitest.explorer).
[VSCode](https://code.visualstudio.com/) with [Vitest](https://marketplace.visualstudio.com/items?itemName=vitest.explorer), [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), and [Cypress Helper](https://marketplace.visualstudio.com/items?itemName=shevtsov.vscode-cy-helper)

## Type Support for `.vue` Imports in TS
**OR**

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.

## Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).
[VSCodium](https://vscodium.com/) with the above extensions from [OpenVSX Registry](https://open-vsx.org/).

## Project Setup

Expand Down Expand Up @@ -285,4 +274,4 @@ MIT, see [LICENSE](LICENSE) for details.
* Basic utilities from [xen-dev-utils](https://github.com/xenharmonic-devs/xen-dev-utils)
* Lattice tools [ji-lattice](https://github.com/xenharmonic-devs/ji-lattice)
* Synth for making sound [sw-synth](https://github.com/xenharmonic-devs/sw-synth)
* Keyboard layout [isomorphic-qwerty](https://github.com/xenharmonic-devs/isomorphic-qwerty)
* Keyboard layout [isomorphic-qwerty](https://github.com/xenharmonic-devs/isomorphic-qwerty)

0 comments on commit 100c2c2

Please sign in to comment.