Skip to content

docs: add a pointer receiver example #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 13, 2025
Merged

docs: add a pointer receiver example #117

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b94370d
docs: add example for custom pointer function support in .golangci.yml
Mar 12, 2025
584a7af
Merge branch 'go-simpler:main' into main
shubham-cmyk Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,24 @@ The same can be done via the `-fn=<name:tag:arg-pos>` flag when using `musttag`
musttag -fn="github.com/hashicorp/hcl/v2/hclsimple.DecodeFile:hcl:2" ./...
```

To report a custom function that works with a pointer to the struct, you need to add its description to `.golangci.yml`.
The following is an example of adding support for [`validate.Struct`][12]:

```yaml
linters-settings:
musttag:
functions:
- name: (*github.com/go-playground/validator/v10.Validate).Struct
tag: validate
arg-pos: 0
```

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

```shell
musttag -fn="(*github.com/go-playground/validator/v10.Validate).Struct:validate:0" ./...
```

[1]: https://github.com/uber-go/guide/blob/master/style.md#use-field-tags-in-marshaled-structs
[2]: https://pkg.go.dev/encoding/json
[3]: https://pkg.go.dev/encoding/xml
Expand All @@ -100,3 +118,4 @@ musttag -fn="github.com/hashicorp/hcl/v2/hclsimple.DecodeFile:hcl:2" ./...
[9]: https://github.com/go-simpler/musttag/releases
[10]: https://golangci-lint.run/usage/linters/#musttag
[11]: https://pkg.go.dev/github.com/hashicorp/hcl/v2/hclsimple#Decode
[12]: https://pkg.go.dev/github.com/go-playground/validator/v10#Validate.Struct
Loading