tsconf-checker

tsconf-checker ⚡ Welcome 😀

tsconf-checker

Validate the tsconfig.json file used in the typescript file and display a warning.

Supports TypeScript version 4.4.x.

Usage

For example, if the following tsconfig.json file exists.

{
    "compilerOptions": {
        "target": "esnext",
        "module": "commonjs",
        "baseUrl": "./src",
        "resolveJsonModule": true,
        "outDir": "./dist",
        "esModuleInterop": true,
        "forceConsistentCasingInFileNames": true,
        "strict": true,
        "strictFunctionTypes": true,
        "skipLibCheck": true
    }
}

npx tsconf-checker index.ts

or

npm i -D tsconf-checker

#!/usr/bin/env node
import { checkTsconf } from 'tsconf-checker';

checkTsconf('index.ts');

A warning is displayed as shown below.

Warning: strictFunctionTypes is implicitly true because 'strict' option is true.
Warning: 'skipLibCheck' option is officially recommended to be false.
Warning: 'esModuleInterop' option is officially recommended to be false.
Warning: 'forceConsistentCasingInFileNames' option is officially recommended to be false.

Principles of conduct

Please see the principles of conduct when building a site.

License

This library is licensed under the MIT license.