Skip to content

Commit b1e3021

Browse files
committed
clarify what @ts-migrating does
1 parent 64c112f commit b1e3021

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
🚀 **TypeScript keeps evolving — and your `tsconfig` should too.**
44

5-
But upgrading often breaks existing code, and fixing all errors at once is unrealistic.
5+
This plugin lets you enable your desired `compilerOptions` (e.g. `strict`, `noUncheckedIndexedAccess`, `erasableSyntaxOnly`) across your entire codebase, while selectively disabling problematic lines.
6+
7+
Upgrading `tsconfig` often breaks existing code, and fixing all errors at once is unrealistic.
68

79
**`@ts-migrating`** helps your team migrate to a desired `tsconfig` gradually and safely.
810

@@ -21,7 +23,7 @@ The philosophy behind the plugin follows three simple steps:
2123

2224
2. 🔧 **Reduction**
2325

24-
* Lines marked with `@ts-migrating` are temporarily suppressed.
26+
* Lines marked with `@ts-migrating` will still be typechecked with your original `tsconfig`. Ensuring type-safety throughout.
2527
* Developers can progressively fix these lines, reducing violations over time.
2628

2729
3.**Migration**
@@ -36,7 +38,7 @@ The philosophy behind the plugin follows three simple steps:
3638
1. 🔌 **[TypeScript Language Service Plugin](https://github.com/microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin)**
3739

3840
* Enables IDEs to show errors from the `tsconfig` you're migrating to.
39-
* Suppresses errors on lines marked with `@ts-migrating`.
41+
* Revert lines marked with `@ts-migrating` to be type-checked with your original `tsconfig`.
4042

4143
2. 🖥️ **Standalone CLI: `ts-migrating`**
4244

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ts-migrating",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "Progressively Upgrade `tsconfigs.json`",
55
"author": "Jason Yu <me@ycmjason.com>",
66
"license": "MIT",

0 commit comments

Comments
 (0)