Skip to content

Commit 0f84bfd

Browse files
committed
docs: add framework support explanation to How It Works
1 parent 8cd3f7b commit 0f84bfd

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ TSSLint integrates into `tsserver` via the TypeScript plugin system, leveraging
3434
<img src="architecture.png" alt="TSSLint Architecture Diagram" width="700">
3535
</p>
3636

37+
### Framework Support (Vue, MDX, Astro, etc.)
38+
39+
Since TSSLint operates directly within `tsserver`, it naturally supports any framework that integrates with the TypeScript plugin system.
40+
41+
In editors like VSCode, when using extensions like **Vue Official (Volar)**, **MDX**, or **Astro**, these tools virtualize non-TypeScript files (like `.vue`, `.mdx`, or `.astro`) into virtual TypeScript source files for `tsserver`. Because TSSLint is a `tsserver` plugin, it can seamlessly access and lint the TypeScript code within these virtual files without any additional configuration.
42+
3743
## Getting Started
3844

3945
### 1. Install

0 commit comments

Comments
 (0)