tsconf-validator

A CLI tool to validate your TypeScript configuration files (tsconfig.json). It helps catch common configuration issues, typos, and potential problems in your TypeScript project setup.

Features

• ✅ Validates tsconfig.json files for common issues
• 🔍 Checks for non-existent paths in include, exclude, and paths
• 🚨 Validates rootDir and other compiler options
• ⚠️ Warns about potentially problematic patterns
• 🔄 Works with multiple tsconfig.json files in monorepos
• 🛠️ Zero configuration - works out of the box

Installation

You can install it globally to use across all your projects:

npm install -g tsconf-validator
# or
yarn global add tsconf-validator
# or
pnpm add -g tsconf-validator

Or use it directly with npx:

npx tsconf-validator

Usage

Basic Usage

To validate all tsconfig.json files in your project:

tsconf-validator

This will recursively find and validate all tsconfig.json files in your project, excluding node_modules.

Validate a Specific File

To validate a specific tsconfig.json file:

# Validate all tsconfig*.json files

validate-tsconfigs
# Validate specific file
tsconf-validator --config path/to/your/tsconfig.json
# or
validate-tsconfigs -c path/to/your/tsconfig.json

Integration with npm scripts

Add it to your package.json:

{
  "scripts": {
    "validate:tsconfig": "tsconf-validator"
  }
}

Then run:

npm run validate:tsconfig

What It Checks

The validator performs the following checks:

Include/Exclude Patterns

• Verifies that all patterns in the include array match at least one file/directory
• Warns about potentially problematic exclude patterns that don't match anything
• Ignores common patterns like node_modules, dist, build, etc.

Paths and Aliases

• Validates that all path aliases in compilerOptions.paths resolve to existing files/directories
• Helps catch typos in path mappings

Root Directory

• Verifies that compilerOptions.rootDir exists and is a directory
• Ensures your source directory structure is correctly configured

Exit Codes

• 0: All configurations are valid (may have warnings)
• 1: One or more configurations have errors
• 2: No tsconfig.json files found

License

Distributed under the MIT License. See LICENSE for more information.

Support

If you find this project helpful, please consider giving it a ⭐️ on GitHub!