Skip to content

Update README.md, add note about @typescript-eslint #264

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,15 @@ declare module '*.module.styl' {
}
```

#### @typescript-eslint not picking up global declarations
`@typescript-eslint` may require explicit typings even if you have global declarations in your library.
The full declaration above may clash in such a case. To make everything work together, just add something like this instead of the explicit declarations above:
```ts
/// <reference path="../node_modules/vite/client.d.ts" />
```
That sample is for [vite](https://vitejs.dev). You need to use the proper path for your project.
You can find the correct path through your Editor if everything else works correctly.

## Troubleshooting

For troubleshooting and debugging, you can view the TypeScript Server Log in Visual Studio Code by entering `Typescript: Open TS Server log` in the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
Expand Down