Skip to content

Commit 261cd55

Browse files
authored
docs: add README for Rslint VS Code extension (#248)
1 parent dcfb5b2 commit 261cd55

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Rslint VS Code Extension
2+
3+
The official VS Code extension for [Rslint](https://github.com/web-infra-dev/rslint), a high-performance JavaScript and TypeScript linter written in Go.
4+
5+
## 📦 Installation
6+
7+
- **VS Code**: Install the extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=rstack.rslint)
8+
- **Cursor/Trae**: Install the extension from the [Open VSX Registry](https://open-vsx.org/extension/rstack/rslint).
9+
10+
## ⚙️ Configuration
11+
12+
The extension can be configured through VS Code settings:
13+
14+
### rslint.enable
15+
16+
- **Type:** `boolean`
17+
- **Default:** `true`
18+
19+
Enable/disable Rslint.
20+
21+
### rslint.binPath
22+
23+
- **Type:** `"local"` | `"built-in"` | `"custom"`
24+
- **Default:** `"local"`
25+
26+
Choose which Rslint binary to use:
27+
28+
- `local`: Use workspace node_modules Rslint binary
29+
- `built-in`: Use extension's built-in Rslint binary
30+
- `custom`: Use a custom path to Rslint binary
31+
32+
### rslint.customBinPath
33+
34+
- **Type:** `string`
35+
- **Default:** `undefined`
36+
37+
Custom path to Rslint executable. Only used when `rslint.binPath` is set to `custom`. Requires reloading VS Code to take effect.
38+
39+
### rslint.trace.server
40+
41+
- **Type:** `"off"` | `"messages"` | `"verbose"`
42+
- **Default:** `"off"`
43+
44+
Traces the communication between VS Code and the language server.
45+
46+
## 💬 Community
47+
48+
Join our community:
49+
50+
- [GitHub](https://github.com/web-infra-dev/rslint) - Report bugs and request features
51+
- [Discord](https://discord.gg/uPSudkun2b) - Chat with the team and community

scripts/dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ subclassing
9090
symb
9191
symbolname
9292
thenables
93+
trae
9394
tses
9495
tseslint
9596
tsgo

0 commit comments

Comments
 (0)