ts-ide-overrides

ts-ide-overrides

TypeScript language service plugin to override strict mode family and boolean type checking options within an editor.

The plugin helps raise visibility of strict mode issues without breaking your build process.

The strict mode family options are strict and the 8 related options: alwaysStrict, strictNullChecks, strictBindCallApply, strictFunctionTypes, strictPropertyInitialization, noImplicitAny, noImplicitThis, and useUnknownInCatchVariables.

The the other boolean type-checking options supported are allowUnreachableCode, allowUnusedLabels, exactOptionalPropertyTypes, noFallthroughCasesInSwitch, noImplicitOverride, noImplicitReturns, noPropertyAccessFromIndexSignature, noUncheckedIndexedAccess, noUnusedLocals and noUnusedParameters.

Install

Install as a dev-dependency using a package manager:

npm install --save-dev ts-ide-overrides

yarn add --save-dev ts-ide-overrides

pnpm add --save-dev ts-ide-overrides

bun add --development ts-ide-overrides

Configuration

Add plugin to tsconfig.json:

{
  "compilerOptions": {
    // (other options ommitted)
    "plugins": [
      {
        "name": "ts-ide-overrides",
        "overrides": {
          // just an example...
          "strict": true,
          "noImplicitAny": false,
          "useUnknownInCatchVariables": false
        }
      }
    ]
  }
}

Comments

The plugin supports code comments to toggle any of the 9 options for the current file:

// @ts-ide-disable-strict @ts-ide-enable-strict-null-checks