Skip to content

docs(readme): add TypeScript version requirement under Installation #196

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
imjuni merged 1 commit into from
May 2, 2026
Merged

docs(readme): add TypeScript version requirement under Installation #196

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,17 @@ A [barrel](https://basarat.gitbook.io/typescript/main-1/barrel) is a way to roll
npm install ctix --save-dev
```

> **TypeScript version requirement**
>
> ctix 2.8.0 requires **TypeScript >=5.0.0 and <6.0.0**.
>
> TypeScript 6.x shifts to ESM-first defaults and introduces breaking changes to `moduleResolution` and `baseUrl` that are not yet supported by ctix. Until ctix adds ESM support, please keep your TypeScript version in the 5.x range.
>
> ```bash
> # install a compatible TypeScript version explicitly
> npm install typescript@">=5 <6" --save-dev
> ```

## Usage

```bash
Expand Down
Loading