https://github.com/kazhuravlev/structspec
Generate results of struct reflection
https://github.com/kazhuravlev/structspec
codegen go golang struct tool
Last synced: about 1 year ago
JSON representation
Generate results of struct reflection
- Host: GitHub
- URL: https://github.com/kazhuravlev/structspec
- Owner: kazhuravlev
- License: mit
- Created: 2022-12-07T15:55:10.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T16:46:10.000Z (almost 2 years ago)
- Last Synced: 2025-04-01T16:16:19.146Z (about 1 year ago)
- Topics: codegen, go, golang, struct, tool
- Language: Go
- Homepage:
- Size: 31.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# structspec
Generate static results of struct reflection.
This tool generates special structs that contain all fields from the source
struct.
It allows mentioning some fields of source structs without the need to remember
the field names. This especially helps when you write queries to the database,
validating JSON/XML/etc fields.
## Installation
```shell
go install github.com/kazhuravlev/structspec/cmd/structspec@latest
```
## Usage
```shell
$ structspec gen --help
NAME:
structspec gen - Generate and write result
USAGE:
structspec gen [command options] [arguments...]
OPTIONS:
--src value Source directory
--structs value [ --structs value ] Which structs should be included. Default: all founded
--ignore value [ --ignore value ] Which structs should be ignored. Default: no one
--tag value [ --tag value ] Which tags should be used for generation. Default: all founded
--out-file value Output filename
--out-pkg value Output package name
--help, -h show help (default: false)
$ structspec gen \
--src ./path/to/package/with/target/structs \
--out-pkg mypackage
```
## Example
Source struct:
```go
package structs
type User struct {
ID string `json:"id" sql:"user_id"`
Username string `json:"username" sql:"username"`
}
```
Generated code:
```go
package structs
func (User) Spec() UserSpec {
return UserSpecData
}
type UserSpec struct {
Json UserSpecFields
Sql UserSpecFields
}
type UserSpecFields struct {
ID FieldName
Username FieldName
}
var UserSpecData = UserSpec{
Json: UserSpecFields{
ID: "id",
Username: "username",
},
Sql: UserSpecFields{
ID: "user_id",
Username: "username",
},
}
// and helper functions ....
```
Usage in sql query builder:
```go
package storage
import "fmt"
func ExampleGetUserByID(id string) {
queryTpl := `select %s, %s from users where %s = ?`
query := fmt.Sprintf(
queryTpl,
structs.UserSpecData.Sql.ID,
structs.UserSpecData.Sql.Username,
structs.UserSpecData.Sql.ID,
)
fmt.Println(query)
// select id, username from users where id = ?
}
```
This tool guarantees you never forget to update your queries after updating
source structs. All you need is to run `go generate` and the go compiler will
highlight what you forgot to update.