-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
40 changed files
with
5,222 additions
and
1,901 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,18 @@ | ||
| module github.com/xoctopus/x | ||
|
|
||
| go 1.22.0 | ||
| go 1.23.0 | ||
|
|
||
| require ( | ||
| github.com/onsi/gomega v1.33.1 | ||
| github.com/pkg/errors v0.9.1 | ||
| golang.org/x/exp v0.0.0-20240716175740-e3f259677ff7 | ||
| golang.org/x/tools v0.23.0 | ||
| golang.org/x/tools v0.28.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/google/go-cmp v0.6.0 // indirect | ||
| golang.org/x/mod v0.19.0 // indirect | ||
| golang.org/x/net v0.27.0 // indirect | ||
| golang.org/x/sync v0.7.0 // indirect | ||
| golang.org/x/text v0.16.0 // indirect | ||
| golang.org/x/mod v0.22.0 // indirect | ||
| golang.org/x/net v0.32.0 // indirect | ||
| golang.org/x/sync v0.10.0 // indirect | ||
| golang.org/x/text v0.21.0 // indirect | ||
| gopkg.in/yaml.v3 v3.0.1 // indirect | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| package pkgx | ||
|
|
||
| import ( | ||
| "go/ast" | ||
| "go/token" | ||
| "sort" | ||
| "strings" | ||
| ) | ||
|
|
||
| func newCommentScanner(fs *token.FileSet, f *ast.File) *CommentScanner { | ||
| return &CommentScanner{ | ||
| File: f, | ||
| CommentMap: ast.NewCommentMap(fs, f, f.Comments), | ||
| } | ||
| } | ||
|
|
||
| type CommentScanner struct { | ||
| *ast.File | ||
| ast.CommentMap | ||
| } | ||
|
|
||
| func (c *CommentScanner) CommentsOf(n ast.Node) []string { | ||
| groups := c.CommentGroupsOf(n) | ||
| comments := make([]string, len(groups)) | ||
| for i, g := range groups { | ||
| text := g.Text() | ||
| if strings.HasPrefix(text, "go:") { | ||
| continue | ||
| } | ||
| comments[i] = strings.TrimSpace(text) | ||
| } | ||
| return comments | ||
| } | ||
|
|
||
| func (c *CommentScanner) CommentGroupsOf(n ast.Node) (cgs []*ast.CommentGroup) { | ||
| if n == nil { | ||
| return | ||
| } | ||
|
|
||
| switch n.(type) { | ||
| case *ast.File, *ast.Field, ast.Stmt, ast.Decl: | ||
| if comments, ok := c.CommentMap[n]; ok { | ||
| cgs = comments | ||
| } | ||
| case ast.Spec: | ||
| if comments, ok := c.CommentMap[n]; ok { | ||
| cgs = append(cgs, comments...) | ||
| } | ||
| if len(cgs) == 0 { | ||
| for node, comments := range c.CommentMap { | ||
| if decl, ok := node.(*ast.GenDecl); ok { | ||
| for _, spec := range decl.Specs { | ||
| if n == spec { | ||
| cgs = append(cgs, comments...) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| default: | ||
| var ( | ||
| pos token.Pos = -1 | ||
| parent ast.Node | ||
| ) | ||
| ast.Inspect(c.File, func(node ast.Node) bool { | ||
| switch node.(type) { | ||
| case *ast.Field, ast.Stmt, ast.Decl, ast.Spec: | ||
| if n.Pos() >= node.Pos() && n.End() <= node.End() { | ||
| next := n.Pos() - node.Pos() | ||
| if pos == -1 || next <= pos { | ||
| pos, parent = next, node | ||
| } | ||
| } | ||
| } | ||
| return true | ||
| }) | ||
| if parent != nil { | ||
| cgs = c.CommentGroupsOf(parent) | ||
| } | ||
| } | ||
| sort.Slice(cgs, func(i, j int) bool { | ||
| return cgs[i].Pos() < cgs[j].Pos() | ||
| }) | ||
| return | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package pkgx_test | ||
|
|
||
| import ( | ||
| "go/types" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| // func TestCommentScanner(t *testing.T) { | ||
| // fset := token.NewFileSet() | ||
| // | ||
| // fpth, err := filepath.Abs(path.Join(root, "comments.go")) | ||
| // if err != nil { | ||
| // t.Error(err) | ||
| // return | ||
| // } | ||
| // | ||
| // fast, err := parser.ParseFile(fset, fpth, nil, parser.ParseComments) | ||
| // if err != nil { | ||
| // t.Error(err) | ||
| // return | ||
| // } | ||
| // | ||
| // ast.Inspect(fast, func(node ast.Node) bool { | ||
| // comments := strings.Split(NewCommentScanner(fset, fast).CommentsOf(node), "\n") | ||
| // NewWithT(t).Expect(3 >= len(comments)).To(BeTrue()) | ||
| // return true | ||
| // }) | ||
| // } | ||
|
|
||
| func TestPkgComments(t *testing.T) { | ||
| for _, v := range []struct { | ||
| name string | ||
| object types.Object // identifier object | ||
| expect []string // expect identifier's comment | ||
| }{ | ||
| {"Date", pkg.TypeName("Date"), []string{"Date defines corresponding time.Time"}}, | ||
| {"Test", pkg.Var("test"), []string{"var"}}, | ||
| {"A", pkg.Const("A"), []string{"A comment", "A inline comment"}}, | ||
| {"Print", pkg.Func("Print"), []string{"Print function"}}, | ||
| } { | ||
| t.Run(v.name, func(t *testing.T) { | ||
| NewWithT(t).Expect(pkg.CommentsOf(pkg.IdentOf(v.object))).To(Equal(v.expect)) | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.