i18next-gitbook icon indicating copy to clipboard operation
i18next-gitbook copied to clipboard

Intellisense works only with TypeScript v5, while in documentation it's just recommendation to use v5

Open ddubrava opened this issue 1 year ago • 2 comments

Documentation issue

The current i18next TypeScript documentation mentions that TypeScript version 5 is recommended to be used. In practice, intellisense does not work at all in TypeScript version 4. So developers must use TypeScript version 5 if they use the code from the documentation.

https://www.i18next.com/overview/typescript

Screenshot 2023-09-14 at 21 42 21

To reproduce it, you can use this example and downgrade TypeScript to v4.

Screenshot 2023-09-14 at 21 47 24

In my case, the problem was that I had not noticed the 'Intellisense not working' section in troubleshooting and was trying to use the examples from the documentation using v4.

Motivation

To provide accurate guidance and improve the developer experience, it is crucial to update the documentation and clearly state that intellisense support is only available starting from TypeScript version 5.

The documentation should highlight that all examples and solutions related to TypeScript and i18next are applicable and relevant only to TypeScript version 5 onwards.

This clarification will help developers avoid spending unnecessary time trying to set up Intellisense support for i18next with TypeScript version 4, and ensure that they are aware of the minimum TypeScript version requirement.

ddubrava avatar Sep 14 '23 19:09 ddubrava