mirror of
https://github.com/mgechev/revive.git
synced 2025-03-17 20:57:58 +02:00
Update readme
This commit is contained in:
parent
fcfe170bd2
commit
e5083a384e
23
README.md
23
README.md
@ -1,11 +1,30 @@
|
||||
# revive
|
||||
|
||||
Linter for Go.
|
||||
Fast, configurable, extensible, and beautiful linter for Go.
|
||||
|
||||
<p align="center">
|
||||
<img src="./assets/logo.png" alt="" width="200">
|
||||
</p>
|
||||
|
||||
# License
|
||||
## Usage
|
||||
|
||||
Revive is **configurable** linter which you can fit your needs.
|
||||
|
||||
### Command Line Flags
|
||||
|
||||
Revive accepts only three command line parameters:
|
||||
|
||||
* `config` - path to config file in TOML format.
|
||||
* `exclude` - pattern for files/directories/packages to be excluded for linting. You can specify the files you want to exclude for linting either as package name (i.e. `github.com/mgechev/revive`), list them as individual files (i.e. `file.go file2.go`), directories (i.e. `./foo/...`), or any combination of the three.
|
||||
* `formatter` - formatter to be used for the output. The currently available formatters are:
|
||||
* `default` - will output the warnings the same way that `golint` does.
|
||||
* `json` - outputs the warnings in JSON format.
|
||||
* `cli` - formats the warnings in a table.
|
||||
|
||||
### Configuration
|
||||
|
||||
Revive can be configured with a TOML file
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
Loading…
x
Reference in New Issue
Block a user