Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DiFuks committed Jun 25, 2024
1 parent 8b235e7 commit 8187146
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .yarn/versions/009c1bb6.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
releases:
ts-overrides-plugin: patch
4 changes: 3 additions & 1 deletion packages/plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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`:

Expand Down

0 comments on commit 8187146

Please sign in to comment.