From 100c2c2113e356aa06e39c188766cf702b7b200c Mon Sep 17 00:00:00 2001 From: Tristan <85427980+tristanbay@users.noreply.github.com> Date: Tue, 11 Feb 2025 02:24:37 -0800 Subject: [PATCH] Update the readme (#856) Remove reference to Volar in the README. --- README.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f4d987c8..88a2a12b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) \ No newline at end of file