autonolint

README

autonolint

Insert //nolint comment automatically for golangci-lint

Installation

$ go install github.com/utgwkk/autonolint/cmd/autonolint

Usage

1. Run golangci-lint with --out-format=json.
2. (Optional) Extract Issues field of JSON.
3. Pass to autonolint with standard input.

$ golangci-lint run --out-format=json | autonolint

# Or:
$ golangci-lint run --out-format=json | jq .Issues | autonolint

You can specify content of a comment for //nolint directive via -comment option.

$ golangci-lint run --out-format=json | autonolint -comment "TODO: refactor"

DEMO

Documentation

Index

• func Process(issues []Issue, comment string) error
• type ExecResult
• type InsertComment
  • func (c *InsertComment) Comment() string
• type Issue
  • func ParseInput(in []byte) ([]Issue, error)
• type Pos

Functions

func Process

func Process(issues []Issue, comment string) error

Types

type ExecResult

type ExecResult struct {
	Issues []Issue
}

type InsertComment

type InsertComment struct {
	Filename string

	Line int

	FromLinter string

	Reason string
}

func (*InsertComment) Comment

func (c *InsertComment) Comment() string

type Issue

type Issue struct {
	FromLinter string

	Text string

	Pos Pos
}

func ParseInput

func ParseInput(in []byte) ([]Issue, error)

type Pos

type Pos struct {
	Filename string

	Offset int
	Line   int
	Column int
}