From a8f7fd25e8ca21fb094e6756f8274c156e2a80b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Ch=C5=82odnicki?= Date: Sat, 9 Nov 2024 10:50:06 +0100 Subject: [PATCH] Major breaking change update message (#245) --- README.md | 11 +++++------ messages/1.0.8.txt | 45 --------------------------------------------- messages/2.2.0.txt | 8 -------- messages/3.0.0.txt | 7 +++++++ 4 files changed, 12 insertions(+), 59 deletions(-) delete mode 100644 messages/1.0.8.txt delete mode 100644 messages/2.2.0.txt create mode 100644 messages/3.0.0.txt diff --git a/README.md b/README.md index 1b4b614..aee6533 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # LSP-volar -This is a helper package that automatically installs and updates the [Volar Language Server](https://github.com/johnsoncodehk/volar) for you. +This is a helper package that automatically installs and updates the [Volar Language Server](https://github.com/vuejs/language-tools/tree/v1.8.27) for you. + +> **Warning** +> This package integrates with the legacy 1.x version of the Vue Language Features (formerly Volar). +> To use the latest version of Vue Language Features migrate to `LSP-vue`. ## Table of Contents - [Installation](#installation) @@ -123,8 +127,3 @@ To enable inlay hints: ``` > NOTE: Inlay hints require TypeScript 4.4+. - -### Vue 2 support - -Please see [Volar's Installation](https://github.com/johnsoncodehk/volar/blob/master/docs/installation.md) for setup instructions. - diff --git a/messages/1.0.8.txt b/messages/1.0.8.txt deleted file mode 100644 index 9a0d05c..0000000 --- a/messages/1.0.8.txt +++ /dev/null @@ -1,45 +0,0 @@ -==> LSP-volar@1.0.8 - -# Enable for non-Vue files - -Allow LSP-volar to start in `*.ts | *.tsx | *.js | *.jsx` files. - -## Per project: - -Create a sublime project file with the following contents: - -``` -{ - "folders": - [ - { - "path": "." - } - ], - "settings": { - "LSP": { - "LSP-volar": { - "selector": "text.html.vue | source.ts | source.tsx | source.js | source.jsx" - }, - "LSP-typescript": { - "enabled": false - } - } - } -} -``` - -## Globally: - -From the command palette select `Preferences: LSP-volar Settings` and paste the following: - -``` -// Settings in here override those in "LSP-volar/LSP-volar.sublime-settings" - -{ - "selector": "text.html.vue | source.ts | source.tsx | source.js | source.jsx" -} -``` - -> NOTE: When enabling LSP-volar for non-Vue files, it is advisable to disable the LSP-typescript package to avoid showing duplicate results. - diff --git a/messages/2.2.0.txt b/messages/2.2.0.txt deleted file mode 100644 index fc2ba42..0000000 --- a/messages/2.2.0.txt +++ /dev/null @@ -1,8 +0,0 @@ -# Breaking change - - - External imports are longer suggested in completions. - ("javascript.suggest.autoImports" and "typescript.suggest.autoImports" settings are disabled by default) - -That's due to Sublime Text not handling a large number of completions (8MB of payload some cases) too well and causing UI freezes. - -If you rely on that feature then you can override those settings manually from "Preferences: LSP-volar Settings" in Command Palette. diff --git a/messages/3.0.0.txt b/messages/3.0.0.txt new file mode 100644 index 0000000..c1d787d --- /dev/null +++ b/messages/3.0.0.txt @@ -0,0 +1,7 @@ +# Breaking change + +This server, which is based on Vue Language Server 1.x is now deprecated. + +Migrate to LSP-vue which is based on the latest version of the Vue Language Server (2.x+). + +Currently used settings can be preserved by copying them from the LSP-volar to LSP-vue settings but note that some of the settings have changed or got removed.