jsontag

README

yze-go-jsontag

A yze analyzer (category data) that reports struct field json/yaml tag keys that are not snake_case, per the gomatic data-format standard that serialized keys are snake_case.

• Rule: yze/jsontag
• Library: exports Analyzer (a standard go/analysis analyzer) and Registration for the yze aggregator and stickler runner.
• Binary: cmd/yze-go-jsontag runs it standalone (text/-json, and as a go vet -vettool).

Built on the go-yze framework.

Documentation

Overview

Package jsontag provides a go/analysis analyzer that reports struct field json/yaml tag keys that are not snake_case, per the gomatic data-format standard that serialized keys are snake_case.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "jsontag",
	Doc:      "reports struct field json/yaml tag keys that are not snake_case, per the gomatic data-format standard",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
}

Analyzer reports struct field json/yaml tag keys that are not snake_case.

var Registration = goyze.Registration{
	Name:       "jsontag",
	Categories: []goyze.Category{"data"},
	URL:        "https://docs.gomatic.dev/yze/jsontag",
	Analyzer:   Analyzer,
}

Registration declares this analyzer to the yze framework.