File tree 2 files changed +20
-2
lines changed
2 files changed +20
-2
lines changed Original file line number Diff line number Diff line change @@ -20,6 +20,24 @@ This is the linter for Oxc. The currently supported features are listed below.
20
20
- Support for ` source.fixAll.oxc ` as a code action provider. Configure this in your settings ` editor.codeActionsOnSave `
21
21
to automatically apply fixes when saving the file.
22
22
23
+ ## Configuration
24
+
25
+ Following configuration are supported via ` settings.json ` :
26
+
27
+ | Key | Default Value | Possible Values | Description |
28
+ | ------------------ | ------------- | -------------------------------- | --------------------------------------------------------------------------- |
29
+ | ` oxc.lint.run ` | ` onType ` | ` onSave ` \| ` onType ` | Run the linter on save (onSave) or on type (onType) |
30
+ | ` oxc.enable ` | ` true ` | ` true ` \| ` false ` | Enables the language server to receive lint diagnostics |
31
+ | ` oxc.trace.server ` | ` off ` | ` off ` \| ` messages ` \| ` verbose ` | races the communication between VS Code and the language server. |
32
+ | ` oxc.configPath ` | ` null ` | ` null ` \| ` <string> ` | Path to ESlint configuration. Keep it empty to enable nested configuration. |
33
+ | ` oxc.path.server ` | - | ` <string> ` | Path to Oxc language server binary. Mostly for testing the language server. |
34
+ | ` oxc.flags ` | - | ` Record<string, string> ` | Specific Oxlint flags to pass to the language server. |
35
+
36
+ ### Flags
37
+
38
+ - ` key: disable_nested_config ` : Disabled nested configuration and searches only for ` configPath `
39
+ - ` key: fix_kind ` : default: ` "safe_fix" ` , possible values ` "safe_fix" | "safe_fix_or_suggestion" | "dangerous_fix" | "dangerous_fix_or_suggestion" | "none" | "all" `
40
+
23
41
## Testing
24
42
25
43
Run ` pnpm server:build:debug ` to build the language server.
Original file line number Diff line number Diff line change 106
106
"oxc.path.server" : {
107
107
"type" : " string" ,
108
108
"scope" : " window" ,
109
- "description" : " Path to Oxc language server binary."
109
+ "description" : " Path to Oxc language server binary. Mostly for testing the language server. "
110
110
},
111
111
"oxc.flags" : {
112
112
"type" : " object" ,
113
113
"scope" : " window" ,
114
114
"default" : {},
115
- "description" : " Oxc options that would normally be passed when executing on the command line ."
115
+ "description" : " Specific Oxlint flags to pass to the language server ."
116
116
}
117
117
}
118
118
},
You can’t perform that action at this time.
0 commit comments