tscx

Runs TypeScript type checking and filters the results to show only errors from specific files.

Installation

Install this tool using pip:

pip install tscx

Usage

Basic Usage

Run TypeScript type checking and show all errors:

tscx

Filter errors for specific files:

tscx path/to/file1.ts path/to/file2.ts

Filter errors for files in specific directories:

tscx src/components src/utils

Options

• -p, --project PATH: Specify the TypeScript project path (default: current directory)
• --tsc-path PATH: Specify the path to TypeScript compiler (default: node_modules/.bin/tsc)

Note: If the TypeScript compiler is not found at the default path (node_modules/.bin/tsc), the tool will automatically try to use the global tsc command.

Examples

Check a specific project:

tscx -p ./my-ts-project

Use a custom TypeScript compiler path:

tscx --tsc-path /custom/path/to/tsc

Filter errors for specific files in a project:

tscx -p ./my-ts-project src/components/Button.tsx src/utils/helpers.ts

Filter errors for all files in specific directories:

tscx -p ./my-ts-project src/components src/utils

For help, run:

tscx --help

You can also use:

python -m tscx --help

Development

Using UV (Recommended)

To contribute to this tool using UV, first checkout the code:

cd tscx

Use UV to set up the project and install dependencies:

uv sync

Run commands using UV:

# Run tests
uv run pytest

# Run the CLI tool
uv run tscx --help

# Or run via Python module
uv run python -m tscx --help

Using Traditional pip/venv

Alternatively, you can use the traditional approach:

cd tscx
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e '.[test]'

To run the tests:

python -m pytest