forked from TrueCloudLab/linters
41 lines
796 B
Markdown
41 lines
796 B
Markdown
|
# linters
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
|
||
|
|
`linters` is a project that enables the integration of custom linting rules into the [golangci-lint](https://github.com/golangci/golangci-lint) framework.
|
||
|
|
|
||
|
|
|
||
|
|
## Available linters
|
||
|
|
|
||
|
|
| Name | Description |
|
||
|
|
| ----------- | ----------- |
|
||
|
|
| noliteral | The tool prohibits the use of literal string arguments in logging functions |
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git clone git.frostfs.info/TrueCloudLab/linters
|
||
|
|
cd linters
|
||
|
|
make lib OUT_DIR=<Path to the directory with libraries>
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Add to .golagci.yml
|
||
|
|
|
||
|
|
```yml
|
||
|
|
|
||
|
|
linters-settings:
|
||
|
|
custom:
|
||
|
|
custom-linters:
|
||
|
|
path: <Path to the directory with libraries>
|
||
|
|
original-url: git.frostfs.info/TrueCloudLab/linters
|
||
|
|
|
||
|
|
linters:
|
||
|
|
enable:
|
||
|
|
custom-linters
|
||
|
|
```
|