From 42d07e27d468dd67812270e946c999897939b8d3 Mon Sep 17 00:00:00 2001 From: johnsoncodehk Date: Fri, 21 Oct 2022 15:35:46 +0800 Subject: [PATCH 1/2] docs: update takeover mode link --- docs/content/1.getting-started/2.installation.md | 6 +++--- docs/content/3.api/5.commands/typecheck.md | 2 +- docs/content/6.bridge/1.overview.md | 2 +- docs/content/7.migration/2.configuration.md | 2 +- packages/schema/src/config/typescript.ts | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/content/1.getting-started/2.installation.md b/docs/content/1.getting-started/2.installation.md index edaaf5b3190..2eedba9174a 100644 --- a/docs/content/1.getting-started/2.installation.md +++ b/docs/content/1.getting-started/2.installation.md @@ -19,9 +19,9 @@ Before getting started, please make sure you have installed the recommended setu * **Node.js*** (latest LTS version) 👉 [[Download](https://nodejs.org/en/download/)] * **Visual Studio Code** 👉 [[Download](https://code.visualstudio.com/)] -* **Volar Extension** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar)] - * Either enable [**Take Over Mode**](https://github.com/johnsoncodehk/volar/discussions/471) (recommended) - * ... or add **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin)] +* **Volar Extension** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=vue.volar)] + * Either enable [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) (recommended) + * ... or add **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=vue.vscode-typescript-vue-plugin)] * If you already have Node.js installed, check with `node --version` that you are using version 14.16 or above 16.11. diff --git a/docs/content/3.api/5.commands/typecheck.md b/docs/content/3.api/5.commands/typecheck.md index 16cfc40aea5..b3f7eab5746 100644 --- a/docs/content/3.api/5.commands/typecheck.md +++ b/docs/content/3.api/5.commands/typecheck.md @@ -9,7 +9,7 @@ description: The typecheck command runs vue-tsc to check types throughout your a npx nuxi typecheck [rootDir] ``` -The `typecheck` command runs [`vue-tsc`](https://github.com/johnsoncodehk/volar/tree/master/packages/vue-tsc) to check types throughout your app. +The `typecheck` command runs [`vue-tsc`](https://github.com/johnsoncodehk/volar/tree/master/vue-language-tools/vue-tsc) to check types throughout your app. Option | Default | Description -------------------------|-----------------|------------------ diff --git a/docs/content/6.bridge/1.overview.md b/docs/content/6.bridge/1.overview.md index a61017de6d1..259300ce9d3 100644 --- a/docs/content/6.bridge/1.overview.md +++ b/docs/content/6.bridge/1.overview.md @@ -134,7 +134,7 @@ If you are using TypeScript, you can edit your `tsconfig.json` to benefit from a As `.nuxt/tsconfig.json` is generated and not checked into version control, you'll need to generate that file before running your tests. Add `nuxi prepare` as a step before your tests, otherwise you'll see `TS5083: Cannot read file '~/.nuxt/tsconfig.json'` :: ::alert -You may also need to add `@vue/runtime-dom` as a devDependency if you are struggling to get template type inference working with [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar). +You may also need to add `@vue/runtime-dom` as a devDependency if you are struggling to get template type inference working with [Volar](https://marketplace.visualstudio.com/items?itemName=vue.volar). :: ::alert Keep in mind that all options extended from `./.nuxt/tsconfig.json` will be overwritten by the options defined in your `tsconfig.json`. diff --git a/docs/content/7.migration/2.configuration.md b/docs/content/7.migration/2.configuration.md index a99d49adb40..82bb8f118fc 100644 --- a/docs/content/7.migration/2.configuration.md +++ b/docs/content/7.migration/2.configuration.md @@ -89,7 +89,7 @@ It will be much easier to migrate your application if you use Nuxt's TypeScript You can read more about Nuxt's TypeScript support [in the docs](/guide/concepts/typescript). ::alert{icon=📦} -Nuxt can type-check your app using [`vue-tsc`](https://github.com/johnsoncodehk/volar/tree/master/packages/vue-tsc) with `nuxi typecheck` command. +Nuxt can type-check your app using [`vue-tsc`](https://github.com/johnsoncodehk/volar/tree/master/vue-language-tools/vue-tsc) with `nuxi typecheck` command. :: ### Migration diff --git a/packages/schema/src/config/typescript.ts b/packages/schema/src/config/typescript.ts index 4d0e0021461..396818d0afe 100644 --- a/packages/schema/src/config/typescript.ts +++ b/packages/schema/src/config/typescript.ts @@ -38,7 +38,7 @@ export default defineUntypedSchema({ /** * Generate a `*.vue` shim. * - * We recommend instead either enabling [**Take Over Mode**](https://github.com/johnsoncodehk/volar/discussions/471) or adding **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin)]. + * We recommend instead either enabling [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) or adding **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=vue.vscode-typescript-vue-plugin)]. */ shim: true } From f0912302e431e1a49fb4c26f8ac9f4ab7e852ebc Mon Sep 17 00:00:00 2001 From: johnsoncodehk Date: Fri, 21 Oct 2022 15:41:54 +0800 Subject: [PATCH 2/2] chore: extensions id casing --- docs/content/1.getting-started/2.installation.md | 4 ++-- docs/content/6.bridge/1.overview.md | 2 +- packages/schema/src/config/typescript.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/1.getting-started/2.installation.md b/docs/content/1.getting-started/2.installation.md index 2eedba9174a..b93f3102bd6 100644 --- a/docs/content/1.getting-started/2.installation.md +++ b/docs/content/1.getting-started/2.installation.md @@ -19,9 +19,9 @@ Before getting started, please make sure you have installed the recommended setu * **Node.js*** (latest LTS version) 👉 [[Download](https://nodejs.org/en/download/)] * **Visual Studio Code** 👉 [[Download](https://code.visualstudio.com/)] -* **Volar Extension** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=vue.volar)] +* **Volar Extension** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.volar)] * Either enable [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) (recommended) - * ... or add **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=vue.vscode-typescript-vue-plugin)] + * ... or add **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)] * If you already have Node.js installed, check with `node --version` that you are using version 14.16 or above 16.11. diff --git a/docs/content/6.bridge/1.overview.md b/docs/content/6.bridge/1.overview.md index 259300ce9d3..f1625c7b062 100644 --- a/docs/content/6.bridge/1.overview.md +++ b/docs/content/6.bridge/1.overview.md @@ -134,7 +134,7 @@ If you are using TypeScript, you can edit your `tsconfig.json` to benefit from a As `.nuxt/tsconfig.json` is generated and not checked into version control, you'll need to generate that file before running your tests. Add `nuxi prepare` as a step before your tests, otherwise you'll see `TS5083: Cannot read file '~/.nuxt/tsconfig.json'` :: ::alert -You may also need to add `@vue/runtime-dom` as a devDependency if you are struggling to get template type inference working with [Volar](https://marketplace.visualstudio.com/items?itemName=vue.volar). +You may also need to add `@vue/runtime-dom` as a devDependency if you are struggling to get template type inference working with [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar). :: ::alert Keep in mind that all options extended from `./.nuxt/tsconfig.json` will be overwritten by the options defined in your `tsconfig.json`. diff --git a/packages/schema/src/config/typescript.ts b/packages/schema/src/config/typescript.ts index 396818d0afe..702c044aa41 100644 --- a/packages/schema/src/config/typescript.ts +++ b/packages/schema/src/config/typescript.ts @@ -38,7 +38,7 @@ export default defineUntypedSchema({ /** * Generate a `*.vue` shim. * - * We recommend instead either enabling [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) or adding **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=vue.vscode-typescript-vue-plugin)]. + * We recommend instead either enabling [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) or adding **TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)]. */ shim: true }