Skip to content

Commit ae57516

Browse files
committed
Update README
1 parent b3eb50b commit ae57516

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,6 @@ go install github.com/bombsimon/wsl/v4/cmd/wsl@master
2828

2929
## Usage
3030

31-
> **Note**: This linter provides a fixer that can fix most issues with the
32-
> `--fix` flag. However, currently `golangci-lint` [does not support suggested
33-
> fixes](https://github.com/golangci/golangci-lint/issues/1779) so the `--fix`
34-
> flag in `golangci-lint` will **not** work.
35-
3631
`wsl` uses the [analysis](https://pkg.go.dev/golang.org/x/tools/go/analysis)
3732
package meaning it will operate on package level with the default analysis flags
3833
and way of working.
@@ -47,9 +42,12 @@ wsl --allow-cuddle-declarations --fix ./...
4742
`wsl` is also integrated in [`golangci-lint`](https://golangci-lint.run)
4843

4944
```sh
50-
golangci-lint run --no-config --disable-all --enable wsl
45+
golangci-lint run --no-config --disable-all --enable wsl --fix
5146
```
5247

48+
> **Note**: If you're not sure what the diagnostic is trying to tell you, use
49+
> any of the fix approaches to fix the code for you.
50+
5351
## Issues and configuration
5452

5553
The linter suppers a few ways to configure it to satisfy more than one kind of
@@ -62,10 +60,6 @@ documentation](doc/configuration.md).
6260
Below are the available checklist for any hit from `wsl`. If you do not see any,
6361
feel free to raise an [issue](https://github.com/bombsimon/wsl/issues/new).
6462

65-
> **Note**: this linter doesn't take in consideration the issues that will be
66-
> fixed with `go fmt -s` so ensure that the code is properly formatted before
67-
> use.
68-
6963
* [Anonymous switch statements should never be cuddled](doc/rules.md#anonymous-switch-statements-should-never-be-cuddled)
7064
* [Append only allowed to cuddle with appended value](doc/rules.md#append-only-allowed-to-cuddle-with-appended-value)
7165
* [Assignments should only be cuddled with other assignments](doc/rules.md#assignments-should-only-be-cuddled-with-other-assignments)

0 commit comments

Comments
 (0)