Skip to content

Commit 6aeecb7

Browse files
committed
docs for #222: add info about VS Code configuration
1 parent 17508ab commit 6aeecb7

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,16 @@ $ golangci-lint run --disable-all -E errcheck
156156

157157
# Editor Integration
158158
1. [Go for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go).
159+
Recommended settings for VS Code are:
160+
```json
161+
"go.lintTool":"golangci-lint",
162+
"go.lintFlags": [
163+
"--fast"
164+
]
165+
```
166+
Using it in an editor without `--fast` can freeze your editor.
167+
Golangci-lint automatically discovers `.golangci.yml` config for edited file: you don't need to configure it in VS Code settings.
168+
159169
2. Sublime Text - [plugin](https://github.com/alecthomas/SublimeLinter-contrib-golang-cilint) for SublimeLinter.
160170
3. GoLand
161171
- Configure [File Watcher](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) with arguments `run --print-issued-lines=false $FileDir$`.

README.tmpl.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,16 @@ $ golangci-lint run --disable-all -E errcheck
129129

130130
# Editor Integration
131131
1. [Go for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go).
132+
Recommended settings for VS Code are:
133+
```json
134+
"go.lintTool":"golangci-lint",
135+
"go.lintFlags": [
136+
"--fast"
137+
]
138+
```
139+
Using it in an editor without `--fast` can freeze your editor.
140+
Golangci-lint automatically discovers `.golangci.yml` config for edited file: you don't need to configure it in VS Code settings.
141+
132142
2. Sublime Text - [plugin](https://github.com/alecthomas/SublimeLinter-contrib-golang-cilint) for SublimeLinter.
133143
3. GoLand
134144
- Configure [File Watcher](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) with arguments `run --print-issued-lines=false $FileDir$`.

0 commit comments

Comments
 (0)