linters/README.md

linters

Overview

linters is a project that enables the integration of custom linting rules into the golangci-lint framework.

Available linters

Name	Description
noliteral	The tool prohibits the use of literal string arguments in logging functions

Linters Configuration

The settings for linters are available if golangci-lint >= 1.5.4 is used.

noliteral

linters-settings:
    custom:
        noliteral:
            path: .bin/external_linters.so
            original-url: git.frostfs.info/TrueCloudLab/linters.git 
            settings:
                target-methods : ["reportFlushError", "reportError"] #optional. Enabled by default "Debug", "Info", "Warn", "Error"
                constants-package: "git.frostfs.info/rep/logs" #if not set, then the check is disabled

Installation

    git clone git.frostfs.info/TrueCloudLab/linters
    cd linters
    make lib OUT_DIR=<Path to the directory with libraries>

Usage

Add to .golangci.yml

    linters-settings:
    custom:
        custom-linters:
            path: <Path to the directory with libraries>
            original-url: git.frostfs.info/TrueCloudLab/linters


    linters:
        enable:
            custom-linters