Skip to content

docs: document VS Code TypeScript version mismatch for - DOCS UPDATE: #247 #248

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

Open
rgved wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document VS Code TypeScript version mismatch for - DOCS UPDATE: #247 #248

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
24 changes: 22 additions & 2 deletions Frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,28 @@ Currently, two official plugins are available:
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration
---

## ⚠️ VS Code TypeScript Version Notice

This project uses **TypeScript 5.5+** features.
VS Code may default to its bundled TypeScript version (for example, 5.2), which can cause
false-positive TypeScript configuration errors in the editor, even though the project builds
and runs correctly.

### Fix: Use Workspace TypeScript Version

To ensure VS Code uses the project’s local TypeScript version:

1. Open any `.ts` or `.tsx` file
2. Press `Ctrl + Shift + P`
3. Select **Preferences: Open Workspace Settings (JSON)**
4. Add the following configuration:
```json
{
"typescript.tsdk": "node_modules/typescript/lib"
}

Comment on lines +27 to 31
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Missing closing backticks for JSON code block.

The JSON configuration snippet on line 27 opens a code block with ```json but lacks a closing ```, causing the markdown to render incorrectly. The subsequent JavaScript code block (line 33) will merge with the JSON block visually.

🔎 Proposed fix 
   ```json
   {
     "typescript.tsdk": "node_modules/typescript/lib"
   }
+  ```
🤖 Prompt for AI Agents 
In Frontend/README.md around lines 27 to 31 the JSON code block starts with
```json but lacks the closing ```; add a closing triple-backtick immediately
after the JSON object (line 31) so the JSON block is properly terminated and the
following JavaScript block renders separately.

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:

```js
export default tseslint.config({
Expand All @@ -29,6 +48,7 @@ export default tseslint.config({
},
},
})

```

You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
Expand Down