From 3ff30f83cea7dfe8230e0b555e3dcc2df1633e28 Mon Sep 17 00:00:00 2001 From: ByungJoon Lee Date: Sat, 2 May 2026 13:50:33 +0900 Subject: [PATCH] docs(readme): add TypeScript version requirement under Installation ctix 2.8.0 supports TypeScript >=5.0.0 <6.0.0. TypeScript 6.x introduces ESM-first defaults with breaking changes to moduleResolution and baseUrl that are not yet supported. Added a callout with an explicit install command. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 6cac162..26a3d8a 100644 --- a/README.md +++ b/README.md @@ -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