Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maru44/stst
Get information defined as type
https://github.com/maru44/stst
go static-analysis
Last synced: 5 days ago
JSON representation
Get information defined as type
- Host: GitHub
- URL: https://github.com/maru44/stst
- Owner: maru44
- License: mit
- Created: 2023-01-27T01:12:30.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-29T09:07:22.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T12:53:48.923Z (7 months ago)
- Topics: go, static-analysis
- Language: Go
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stst
[](https://github.com/maru44/stst/blob/master/LICENSE)
[](https://goreportcard.com/report/github.com/maru44/stst)
The `stst` is package to get information defined as type in go package by static analysis.
## How to Use
```shell
go get github.com/maru44/stst@latest
```
1. Load package
2. Create `stst.Parser` by `stst.NewParser` with loaded package
3. Execute `Parse` or `ParseFile` method of created `stst.Parser`
sample code:
```go
package main
import (
"fmt"
"github.com/k0kubun/pp"
"github.com/maru44/stst"
"golang.org/x/tools/go/packages"
)
func main() {
ps, _ := loadPackages("github.com/maru44/stst/tests/data/aaa")
var schemas []*stst.Schema
for _, pk := range ps {
p := stst.NewParser(pk)
s := p.Parse()
schemas = append(schemas, s...)
}
pp.Println(schemas)
}
func loadPackages(ps ...string) ([]*packages.Package, error) {
cfg := &packages.Config{
Mode: packages.NeedName | packages.NeedFiles | packages.NeedSyntax | packages.NeedTypes | packages.NeedTypesInfo,
}
pkgs, err := packages.Load(cfg, ps...)
if err != nil {
return nil, fmt.Errorf("failed to load package: %w", err)
}
return pkgs, err
}
```
result:
```go
schemas = []*stst.Schema{
&stst.Schema{
Name: "Intf",
Fields: []*stst.Field{
&stst.Field{
Name: "Hello",
Func: &stst.Func{
Args: []*stst.Field{},
Results: []*stst.Field{
&stst.Field{
Name: "string",
Type: &stst.Type{
Underlying: "string",
TypeName: "string",
},
},
},
},
},
},
Type: &stst.Type{
Underlying: "github.com/maru44/stst/tests/data/aaa.Intf",
PkgID: "github.com/maru44/stst/tests/data/aaa",
PkgPlusName: "aaa.Intf",
TypeName: "Intf",
},
IsInterface: true,
},
&stst.Schema{
Name: "IntSample",
Type: &stst.Type{
Underlying: "int",
TypeName: "int",
},
},
&stst.Schema{
Name: "Sample",
Fields: []*stst.Field{
&stst.Field{
Name: "Str",
Type: &stst.Type{
Underlying: "string",
TypeName: "string",
},
Tags: []*stst.Tag{
&stst.Tag{
Key: "tag0",
Values: []string{
"xxx",
},
RawValue: "xxx",
},
&stst.Tag{
Key: "tag1",
Values: []string{
"yyy",
"zzz",
},
RawValue: "yyy,zzz",
},
},
Comment: []string{
"// comment",
},
},
},
Type: &stst.Type{
Underlying: "github.com/maru44/stst/tests/data/aaa.Sample",
PkgID: "github.com/maru44/stst/tests/data/aaa",
PkgPlusName: "aaa.Sample",
TypeName: "Sample",
},
},
&stst.Schema{
Name: "prefixes",
Type: &stst.Type{
Underlying: "github.com/maru44/stst/tests/data/aaa.prefixes",
PkgID: "github.com/maru44/stst/tests/data/aaa",
PkgPlusName: "aaa.prefixes",
TypeName: "prefixes",
},
TypePrefixes: []stst.TypePrefix{
"[]",
"*",
"[]",
"[]",
"[]",
"*",
},
},
}
```