Skip to content

Commit 09fb4d7

Browse files
authored
doc: improve Editor Integration section (#3307)
1 parent c050454 commit 09fb4d7

File tree

1 file changed

+44
-26
lines changed

1 file changed

+44
-26
lines changed

docs/src/docs/usage/integrations.mdx

+44-26
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,50 @@ title: Integrations
44

55
## Editor Integration
66

7-
1. [Go for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go).
8-
Recommended settings for VS Code are:
9-
10-
```json
11-
"go.lintTool":"golangci-lint",
12-
"go.lintFlags": [
13-
"--fast"
14-
]
15-
```
16-
17-
Using it in an editor without `--fast` can freeze your editor.
18-
Golangci-lint automatically discovers `.golangci.yml` config for edited file: you don't need to configure it in VS Code settings.
19-
20-
2. Sublime Text - [plugin](https://github.com/SublimeLinter/SublimeLinter-golangcilint) for SublimeLinter.
21-
3. GoLand
22-
- Install [plugin](https://plugins.jetbrains.com/plugin/12496-go-linter)
23-
- Add [File Watcher](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) using existing `golangci-lint` template.
24-
- If your version of GoLand does not have the `golangci-lint` [File Watcher](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) template you can configure your own and use arguments `run --disable=typecheck $FileDir$`.
25-
4. GNU Emacs
26-
- [Spacemacs](https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org#linting)
27-
- [flycheck checker](https://github.com/weijiangan/flycheck-golangci-lint).
28-
5. Vim
29-
- [vim-go](https://github.com/fatih/vim-go)
30-
- syntastic [merged pull request](https://github.com/vim-syntastic/syntastic/pull/2190) with golangci-lint support
31-
- ale [merged pull request](https://github.com/w0rp/ale/pull/1890) with golangci-lint support
32-
6. Atom - [go-plus](https://atom.io/packages/go-plus) supports golangci-lint.
7+
### [Go for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go).
8+
9+
Recommended settings for VS Code are:
10+
11+
```json
12+
"go.lintTool": "golangci-lint",
13+
"go.lintFlags": [
14+
"--fast"
15+
]
16+
```
17+
18+
Using it in an editor without `--fast` can freeze your editor.
19+
Golangci-lint automatically discovers `.golangci.yml` config for edited file: you don't need to configure it in VS Code settings.
20+
21+
### Sublime Text
22+
23+
There is a [plugin](https://github.com/SublimeLinter/SublimeLinter-golangcilint) for SublimeLinter.
24+
25+
### GoLand
26+
27+
How to configure:
28+
29+
- Install [plugin](https://plugins.jetbrains.com/plugin/12496-go-linter)
30+
- Add [File Watcher](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) using existing `golangci-lint` template.
31+
- If your version of GoLand does not have the `golangci-lint` [File Watcher](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) template you can configure your own and use arguments `run --disable=typecheck $FileDir$`.
32+
33+
### GNU Emacs
34+
35+
There are available plugins:
36+
37+
- [Spacemacs](https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org#linting)
38+
- [flycheck checker](https://github.com/weijiangan/flycheck-golangci-lint).
39+
40+
### Vim
41+
42+
The following plugins support `golangci-lint`:
43+
44+
- [vim-go](https://github.com/fatih/vim-go);
45+
- [ALE](https://github.com/w0rp/ale);
46+
- [Syntastic](https://github.com/vim-syntastic/syntastic).
47+
48+
### Atom
49+
50+
[go-plus](https://atom.io/packages/go-plus) supports golangci-lint.
3351

3452
## Shell Completion
3553

0 commit comments

Comments
 (0)