musttag

README

musttag

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

📌 About

musttag checks if struct fields used in Marshal/Unmarshal 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.

Currently musttag supports only the json tag, see Roadmap for future plans.

📦 Install

go install github.com/junk1tm/musttag/cmd/musttag

📋 Usage

With go vet:

go vet -vettool=$(which musttag) ./...

📅 Roadmap

• Support xml
• Support yaml
• Support toml
• Support mapstructure
• Support custom tags via config

Documentation

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "musttag",
	Doc:      "check if struct fields used in Marshal/Unmarshal are annotated with the relevant tag",
	Requires: []*analysis.Analyzer{inspectpass.Analyzer},
	Run:      run,
}