linters/README.md
Alexander Chuprov df29d08821
All checks were successful
Tests and linters / Lint (pull_request) Successful in 1m19s
Tests and linters / Tests (pull_request) Successful in 1m58s
Tests and linters / Build lib (pull_request) Successful in 2m17s
Tests and linters / Staticcheck (pull_request) Successful in 1m7s
[#5] linters: refactoring
Signed-off-by: Alexander Chuprov <a.chuprov@yadro.com>
2023-07-31 12:59:51 +03:00

41 lines
No EOL
923 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 .golangci.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
```