docs: changelog in separate file, add 4.0.0 changelog

simonhaenisch · Jul 1, 2024 · 0e19fb8 · 0e19fb8
1 parent 3929ec3
commit 0e19fb8
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 31 deletions.
diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,33 @@
+Version `4.0.0` upgrades/replaces the Volar packages used for Vue support, to use the latest `vue-tsc` package that's part of Volar 2. To migrate, you just have to remove `@volar/vue-typescript` and if you're using it, also `@volar/vue-language-plugin-pug`, and replace it with `vue-tsc` and `@vue/language-plugin-pug` respectively. There are no breaking changes other than this.
+
+Version `3.2.4` implements a fix to skip when formatting ranges (i.e. if the plugin is requested to format a range, it doesn't do anything because it would lack the full file context).
+
+Version `3.2.3` updates the readme with instructions for Prettier 3.
+
+Version `3.2.2` fixes a performance regression introduced in `3.2.0`.
+
+Version `3.2.1` fixes the implementation of the language service host's `getCurrentDirectory` method to return the directory containing the tsconfig, rather than using `ts.sys.getCurrentDirectory` (which returns `process.cwd()`). This should prevent issues with resolving compiler plugins with Volar (which is used for Vue support).
+
+Version `3.2.0` adds and fixes support for pug templates in Vue files (via `@volar/vue-language-plugin-pug`). Please be aware that you'll need to update your version of the `@volar/vue-typescript` peer dependency from `0.x` to `1.x`.
+
+Version `3.1.0` adds an option to skip destructive code actions like removing unused imports.
+
+Version `3.0.3` fixes a performance regression introduced in `3.0.2`.
+
+Version `3.0.2` fixes a regression introduced by adding some file-system related methods to the language service host (to fix a bug), which revealed that another method's implementation was incorrect.
+
+Version `3.0.1` bumps the `@volar/vue-typescript` version to fix more edge cases, e. g. not removing imports when a component is used via kebab-case naming. `@volar/vue-typescript` is now defined as an optional peer dependency and you'll need to install version `0.39` or later. Furthermore a fix has been added that should help support more module resolution algorithms.
+
+Version `3.0.0` switches to a different package for Vue support, which fixes some more issues, e. g. support for setup scripts. No breaking changes otherwise.
+
+Version `2.3.4` fixes an issue with Vue v2 files.
+
+Version `2.3.3` fixes a bug where default imports were removed erroneously.
+
+Version `2.3.1` adds debug logs and fixes Vue.js support.
+
+Version `2.2.0` adds a compiler options cache to improve performance.
+
+Version `2.1.0` adds support for Vue.js (`.vue` files).
+
+Version `2.0.0` adds support for the parsers `babel` (i. e. JavaScript) and `babel-ts` which are only available since Prettier v2 (and thus the peer dependency has received a major bump).
diff --git a/readme.md b/readme.md
@@ -90,37 +90,7 @@ This plugin acts outside of [Prettier's scope](https://prettier.io/docs/en/ratio
 
 ## Changelog
 
-Version `3.2.4` implements a fix to skip when formatting ranges (i.e. if the plugin is requested to format a range, it doesn't do anything because it would lack the full file context).
-
-Version `3.2.3` updates the readme with instructions for Prettier 3.
-
-Version `3.2.2` fixes a performance regression introduced in `3.2.0`.
-
-Version `3.2.1` fixes the implementation of the language service host's `getCurrentDirectory` method to return the directory containing the tsconfig, rather than using `ts.sys.getCurrentDirectory` (which returns `process.cwd()`). This should prevent issues with resolving compiler plugins with Volar (which is used for Vue support).
-
-Version `3.2.0` adds and fixes support for pug templates in Vue files (via `@volar/vue-language-plugin-pug`). Please be aware that you'll need to update your version of the `@volar/vue-typescript` peer dependency from `0.x` to `1.x`.
-
-Version `3.1.0` adds an option to skip destructive code actions like removing unused imports.
-
-Version `3.0.3` fixes a performance regression introduced in `3.0.2`.
-
-Version `3.0.2` fixes a regression introduced by adding some file-system related methods to the language service host (to fix a bug), which revealed that another method's implementation was incorrect.
-
-Version `3.0.1` bumps the `@volar/vue-typescript` version to fix more edge cases, e. g. not removing imports when a component is used via kebab-case naming. `@volar/vue-typescript` is now defined as an optional peer dependency and you'll need to install version `0.39` or later. Furthermore a fix has been added that should help support more module resolution algorithms.
-
-Version `3.0.0` switches to a different package for Vue support, which fixes some more issues, e. g. support for setup scripts. No breaking changes otherwise.
-
-Version `2.3.4` fixes an issue with Vue v2 files.
-
-Version `2.3.3` fixes a bug where default imports were removed erroneously.
-
-Version `2.3.1` adds debug logs and fixes Vue.js support.
-
-Version `2.2.0` adds a compiler options cache to improve performance.
-
-Version `2.1.0` adds support for Vue.js (`.vue` files).
-
-Version `2.0.0` adds support for the parsers `babel` (i. e. JavaScript) and `babel-ts` which are only available since Prettier v2 (and thus the peer dependency has received a major bump).
+See [changelog.md](/changelog.md).
 
 ## License