A linter that handles struct tags.
Supported string casing:
camelpascalkebabsnakeupperSnakegoCamelRespects Go's common initialisms (e.g. HttpResponse -> HTTPResponse).goPascalRespects Go's common initialisms (e.g. HttpResponse -> HTTPResponse).goKebabRespects Go's common initialisms (e.g. HttpResponse -> HTTPResponse).goSnakeRespects Go's common initialisms (e.g. HttpResponse -> HTTPResponse).headerupperlower
| Source | Camel Case | Go Camel Case |
|---|---|---|
| GooID | gooId | gooID |
| HTTPStatusCode | httpStatusCode | httpStatusCode |
| FooBAR | fooBar | fooBar |
| URL | url | url |
| ID | id | id |
| hostIP | hostIp | hostIP |
| JSON | json | json |
| JSONName | jsonName | jsonName |
| NameJSON | nameJson | nameJSON |
| UneTête | uneTête | uneTête |
| Source | Pascal Case | Go Pascal Case |
|---|---|---|
| GooID | GooId | GooID |
| HTTPStatusCode | HttpStatusCode | HTTPStatusCode |
| FooBAR | FooBar | FooBar |
| URL | Url | URL |
| ID | Id | ID |
| hostIP | HostIp | HostIP |
| JSON | Json | JSON |
| JSONName | JsonName | JSONName |
| NameJSON | NameJson | NameJSON |
| UneTête | UneTête | UneTête |
| Source | Snake Case | Upper Snake Case | Go Snake Case |
|---|---|---|---|
| GooID | goo_id | GOO_ID | goo_ID |
| HTTPStatusCode | http_status_code | HTTP_STATUS_CODE | HTTP_status_code |
| FooBAR | foo_bar | FOO_BAR | foo_bar |
| URL | url | URL | URL |
| ID | id | ID | ID |
| hostIP | host_ip | HOST_IP | host_IP |
| JSON | json | JSON | JSON |
| JSONName | json_name | JSON_NAME | JSON_name |
| NameJSON | name_json | NAME_JSON | name_JSON |
| UneTête | une_tête | UNE_TÊTE | une_tête |
| Source | Kebab Case | Go KebabCase |
|---|---|---|
| GooID | goo-id | goo-ID |
| HTTPStatusCode | http-status-code | HTTP-status-code |
| FooBAR | foo-bar | foo-bar |
| URL | url | URL |
| ID | id | ID |
| hostIP | host-ip | host-IP |
| JSON | json | JSON |
| JSONName | json-name | JSON-name |
| NameJSON | name-json | name-JSON |
| UneTête | une-tête | une-tête |
| Source | Header Case |
|---|---|
| GooID | Goo-Id |
| HTTPStatusCode | Http-Status-Code |
| FooBAR | Foo-Bar |
| URL | Url |
| ID | Id |
| hostIP | Host-Ip |
| JSON | Json |
| JSONName | Json-Name |
| NameJSON | Name-Json |
| UneTête | Une-Tête |
// json and camel case
type Foo struct {
ID string `json:"ID"` // must be "id"
UserID string `json:"UserID"`// must be "userId"
Name string `json:"name"`
Value string `json:"val,omitempty"`// must be "value"
}This tool is about validating tags according to rules you define. The tool also allows to fix tags according to the rules you defined.
This tool is not intended to validate the fact a tag in valid or not.
To do that, you can use go vet, or use golangci-lint "go vet" linter.
Define the rules, you want via your golangci-lint configuration file:
linters-settings:
tagliatelle:
# Check the struct tag name case.
case:
# Define the association between tag name and case.
# Any struct tag name can be used.
# Support string cases:
# - `camel`
# - `pascal`
# - `kebab`
# - `snake`
# - `upperSnake`
# - `goCamel`
# - `goPascal`
# - `goKebab`
# - `goSnake`
# - `upper`
# - `lower`
# - `header`
rules:
json: camel
yaml: camel
xml: camel
toml: camel
bson: camel
avro: snake
mapstructure: kebab
env: upperSnake
envconfig: upperSnake
whatever: snake
# Use the struct field name to check the name of the struct tag.
# Default: false
use-field-name: true
# The field names to ignore.
# Default: []
ignored-fields:
- Bar
- Foo
# Overrides the default/root configuration.
# Default: []
overrides:
-
# The package path. (uses `/` only as separator)
# Required
pkg: foo/bar
# Default: empty or the same as the default/root configuration.
rules:
json: snake
xml: pascal
# Default: false (WARNING: it doesn't follow the default/root configuration)
use-field-name: true
# The field names to ignore.
# Default: [] or the same as the default/root configuration.
ignored-fields:
- Bar
- Foo
# Ignore the package (it takes the precedence over all other configuration).
# Default: false
ignore: trueOverrides case rules for the package foo/bar:
linters-settings:
tagliatelle:
case:
rules:
json: camel
yaml: camel
xml: camel
overrides:
- pkg: foo/bar
rules:
json: snake
xml: pascalIgnore fields inside the package foo/bar:
linters-settings:
tagliatelle:
case:
rules:
json: camel
yaml: camel
xml: camel
overrides:
- pkg: foo/bar
ignored-fields:
- Bar
- FooIgnore the package foo/bar:
linters-settings:
tagliatelle:
case:
rules:
json: camel
yaml: camel
xml: camel
overrides:
- pkg: foo/bar
ignore: trueMore information here https://golangci-lint.run/usage/linters/#tagliatelle
Not recommended.
go install github.com/ldez/tagliatelle/cmd/tagliatelle@latestthen launch it manually.
Here are the default rules for the well known and used tags, when using tagliatelle as a binary or golangci-lint linter:
json:camelyaml:camelxml:camelbson:camelavro:snakeheader:headerenv:upperSnakeenvconfig:upperSnake
The tool is not limited to the tags used in example, you can use it to validate any tag.
You can add your own tag, for example whatever and tells the tool you want to use kebab.
This option is only available via golangci-lint.
linters-settings:
tagliatelle:
# Check the struck tag name case.
case:
rules:
# Any struct tag type can be used.
# Support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
json: camel
yaml: camel
xml: camel
toml: camel
whatever: kebab
# Use the struct field name to check the name of the struct tag.
# Default: false
use-field-name: true