Skip to content

Improves the docs for allowUnreachableCode #776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
orta merged 1 commit into from
Jul 16, 2020
Merged

Improves the docs for allowUnreachableCode #776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion packages/tsconfig-reference/copy/en/options/allowUnreachableCode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/tsconfig-reference/scripts/tsconfigRules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down