musttag

package module
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

musttag

checks pkg.go.dev goreportcard codecov

A Go linter that enforces field tags in (un)marshaled structs.

📌 About

musttag checks that exported fields of a struct passed to a Marshal-like function are annotated with the relevant tag:

// BAD:
var user struct {
    Name string
}
data, err := json.Marshal(user)

// GOOD:
var user struct {
    Name string `json:"name"`
}
data, err := json.Marshal(user)

The rational from Uber Style Guide:

The serialized form of the structure is a contract between different systems. Changes to the structure of the serialized form, including field names, break this contract. Specifying field names inside tags makes the contract explicit, and it guards against accidentally breaking the contract by refactoring or renaming fields.

🚀 Features

The following packages are supported out of the box:

In addition, any custom package can be added to the list.

📦 Install

musttag is integrated into golangci-lint, and this is the recommended way to use it.

To enable the linter, add the following lines to .golangci.yml:

linters:
  enable:
    - musttag

Alternatively, you can download a prebuilt binary from the Releases page to use musttag standalone.

📋 Usage

Run golangci-lint with musttag enabled. See the list of available options to configure the linter.

When using sloglint standalone, pass the options as flags.

Custom packages

To report a custom function, you need to add its description to .golangci.yml. The following is an example of adding support for hclsimple.Decode:

linters-settings:
  musttag:
    functions:
        # The full name of the function, including the package.
      - name: github.com/hashicorp/hcl/v2/hclsimple.Decode
        # The struct tag whose presence should be ensured.
        tag: hcl
        # The position of the argument to check.
        arg-pos: 2

The same can be done via the -fn=<name:tag:arg-pos> flag when using musttag standalone:

musttag -fn="github.com/hashicorp/hcl/v2/hclsimple.DecodeFile:hcl:2" ./...

Documentation

Overview

Package musttag implements the musttag analyzer.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(funcs ...Func) *analysis.Analyzer

New creates a new musttag analyzer. To report a custom function, provide its description as Func.

Types

type Func

type Func struct {
	Name   string // The full name of the function, including the package.
	Tag    string // The struct tag whose presence should be ensured.
	ArgPos int    // The position of the argument to check.
	// contains filtered or unexported fields
}

Func describes a function call to look for, e.g. json.Marshal.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL