go/revive
1
0
Fork 0
mirror of https://github.com/mgechev/revive.git synced 2025-10-30 23:37:49 +02:00
Code Issues Releases Activity

docs: enhance struct-tag rule description (#1512)

Browse Source
This commit is contained in:
Oleksandr Redko
2025-09-04 15:36:58 +03:00
committed by GitHub
parent 4d5fd518ca
commit 490b37dbbe
1 changed files with 24 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
RULES_DESCRIPTIONS.md
View File

@@ -1228,13 +1228,33 @@ _Configuration_: N/A
## struct-tag
_Description_: Struct tags are not checked at compile time.
This rule spots errors in struct tags of the following types:
asn1, bson, datastore, default, json, mapstructure, properties, protobuf, required, spanner, toml, url, validate, xml, yaml.
_Description_: The rule spots errors in struct tags.
This is useful because struct tags are not checked at compile time.
_Configuration_: (optional) list of user defined options.
The list of [supported tags](https://go.dev/wiki/Well-known-struct-tags):
| Tag | Documentation |
| ------------- | ------------------------------------------------------------------------ |
| `asn1` | <https://pkg.go.dev/encoding/asn1> |
| `bson` | <https://pkg.go.dev/go.mongodb.org/mongo-driver/bson> |
| `datastore` | <https://pkg.go.dev/cloud.google.com/go/datastore> |
| `default` | The type of "default" must match the type of the field. |
| `json` | <https://pkg.go.dev/encoding/json> |
| `mapstructure` | <https://pkg.go.dev/github.com/mitchellh/mapstructure> |
| `properties` | <https://pkg.go.dev/github.com/magiconair/properties#Properties.Decode> |
| `protobuf` | <https://github.com/golang/protobuf> |
| `required` | Should be only "true" or "false". |
| `spanner` | <https://pkg.go.dev/cloud.google.com/go/spanner> |
| `toml` | <https://pkg.go.dev/github.com/pelletier/go-toml/v2> |
| `url` | <https://github.com/google/go-querystring> |
| `validate` | <https://github.com/go-playground/validator> |
| `xml` | <https://pkg.go.dev/encoding/xml> |
| `yaml` | <https://pkg.go.dev/gopkg.in/yaml.v2> |
_Configuration_: (optional) The list of struct tags that can be accepted by the rule additionally to the supported tags.
Configuration example:
To accept the `inline` option in JSON tags (and `outline` and `gnu` in BSON tags) you must provide the following configuration
```toml