Skip to content

Commit fe1445b

Browse files
committed
docs(readme): add update guide for the latest configuration version
1 parent ac7d657 commit fe1445b

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,39 @@ The ruleset is inspired by the Tiger Style coding principles and pretty much boi
1313
1. Explicit over implicit code
1414
2. Consistent code style
1515

16-
## Documentation
16+
## Updating TypeScript & Configuration Versions
1717

18-
As the configuration only handles `compilerOptions`, the reasoning behind each setting can be found in [compilerOptions](./src/compilerOptions.ts).
18+
### TypeScript `>=6.0.0` & Configuration `>=0.1.0`
19+
20+
The following options were deprecated by TypeScript and will not be part of the configuration going forward:
21+
22+
1. `downlevelIteration`
23+
2. `outFile`
24+
3. `alwaysStrict`
25+
4. `baseUrl`
26+
5. `esModuleInterop`
27+
6. `allowSyntheticDefaultImport`
28+
29+
In case your `@types/*` packages are not recognized by the TypeScript compiler, they will have to be added into your `tsconfig.json`. TypeScript has stopped automatically loading every `@types/*` package [starting with version 6.0.0](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-6-0.html#types-now-defaults-to-). A simple example of registering `@types/node` would be:
30+
31+
```json
32+
{
33+
"compilerOptions": {
34+
"types": ["node"]
35+
}
36+
}
37+
```
1938

2039
## Versioning
2140

2241
For TypeScript versions `<6.0.0`, the configuration versions of `0.0.X` are recommended. Starting with `0.1.0`, many `compilerOptions` were removed with the major release and will not be maintained in the future versions of the configuration.
2342

2443
The `0.0.X` configuration versions will still be maintained to provide compatibility for older TypeScript versions.
2544

45+
## Documentation
46+
47+
As the configuration only handles `compilerOptions`, the reasoning behind each setting can be found in [compilerOptions](./src/compilerOptions.ts).
48+
2649
## Installation
2750

2851
First add the package as a development dependency using your package manager of choice.

0 commit comments

Comments
 (0)