Improves the docs for allowUnreachableCode

agilgur5 · Jul 16, 2020 · ea8407c · ea8407c
1 parent 2adacdd
commit ea8407c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/packages/tsconfig-reference/copy/en/options/allowUnreachableCode.md b/packages/tsconfig-reference/copy/en/options/allowUnreachableCode.md
@@ -3,7 +3,12 @@ display: "Allow Unreachable Code"
 oneline: "Error when code will never be called"
 ---
 
-Set to false to disable warnings about unreachable code.
+When:
+
+- `undefined` (default) provide suggestions as warnings to editors
+- `true` unreachable code is ignored
+- `false` raises compiler errors about unreachable code
+
 These warnings are only about code which is provably unreachable due to the use of JavaScript syntax, for example:
 
 ```ts

diff --git a/packages/tsconfig-reference/scripts/tsconfigRules.ts b/packages/tsconfig-reference/scripts/tsconfigRules.ts
@@ -92,7 +92,7 @@ export const defaultsForOptions = {
   allowJs: "false",
   allowSyntheticDefaultImports: 'module === "system" or esModuleInterop',
   allowUmdGlobalAccess: "false",
-  allowUnreachableCode: "false",
+  allowUnreachableCode: "undefined",
   allowUnusedLabels: "false",
   alwaysStrict: "`false`, unless `strict` is set",
   charset: "utf8",