From 8187146a08f92685053c46b5ab60c8dcc3ae3cce Mon Sep 17 00:00:00 2001 From: Dmitry Fuks Date: Tue, 25 Jun 2024 04:13:31 +0300 Subject: [PATCH] update readme --- .yarn/versions/009c1bb6.yml | 2 ++ packages/plugin/README.md | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 .yarn/versions/009c1bb6.yml diff --git a/.yarn/versions/009c1bb6.yml b/.yarn/versions/009c1bb6.yml new file mode 100644 index 0000000..b212163 --- /dev/null +++ b/.yarn/versions/009c1bb6.yml @@ -0,0 +1,2 @@ +releases: + ts-overrides-plugin: patch diff --git a/packages/plugin/README.md b/packages/plugin/README.md index 4fe76ef..9c0f63c 100644 --- a/packages/plugin/README.md +++ b/packages/plugin/README.md @@ -8,6 +8,8 @@ A plugin for `TypeScript` that allows overriding `tsconfig` for specific files ## Why is it needed? +The plugin partially addresses [this issue](https://github.com/microsoft/TypeScript/issues/33407). + The most popular use case is migrating a project from `strict: false` to `strict: true`, but it can also be used for any other cases where you need to override the `tsconfig` settings for specific files. @@ -120,7 +122,7 @@ with `ts-patch` (`yarn ts-patch install`), then there is nothing more to do. For `TypesSript 3` and `TypesSript 4` version, it is possible to use only the Persistent Patch option with. If, however, you are using [`Live Compiler`](https://github.com/nonara/ts-patch?tab=readme-ov-file#method-1-live-compiler) (Only `TypeScript 5`, -the following steps are necessary: +the following steps are necessary): For the `tsc` command – replace it with `tspc` in `package.json`: