-
-
Notifications
You must be signed in to change notification settings - Fork 676
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Gazelle: sort srcs and deps string lists in buildifier order (#613)
This is a workaround for bazelbuild/buildtools#122. When buildifier sorts lists, it only processes list expressions as arguments for certain attributes. It doesn't process lists inside select or lists concatenated with select. When that bug is fixed, this code can be removed. Fixes #584
- Loading branch information
Showing
4 changed files
with
226 additions
and
0 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
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,130 @@ | ||
| package rules | ||
|
|
||
| import ( | ||
| "sort" | ||
| "strings" | ||
|
|
||
| bf "github.com/bazelbuild/buildtools/build" | ||
| ) | ||
|
|
||
| var ( | ||
| goRuleKinds = map[string]bool{ | ||
| "cgo_library": true, | ||
| "go_binary": true, | ||
| "go_library": true, | ||
| "go_test": true, | ||
| } | ||
| sortedAttrs = []string{"srcs", "deps"} | ||
| ) | ||
|
|
||
| // SortLabels sorts lists of strings in "srcs" and "deps" attributes of | ||
| // Go rules using the same order as buildifier. Buildifier also sorts string | ||
| // lists, but not those involved with "select" expressions. | ||
| // TODO(jayconrod): remove this when bazelbuild/buildtools#122 is fixed. | ||
| func SortLabels(f *bf.File) { | ||
| for _, s := range f.Stmt { | ||
| c, ok := s.(*bf.CallExpr) | ||
| if !ok { | ||
| continue | ||
| } | ||
| r := bf.Rule{c} | ||
| if !goRuleKinds[r.Kind()] { | ||
| continue | ||
| } | ||
| for _, key := range []string{"srcs", "deps"} { | ||
| attr := r.AttrDefn(key) | ||
| if attr == nil { | ||
| continue | ||
| } | ||
| bf.Walk(attr.Y, sortExprLabels) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func sortExprLabels(e bf.Expr, _ []bf.Expr) { | ||
| list, ok := e.(*bf.ListExpr) | ||
| if !ok || len(list.List) == 0 { | ||
| return | ||
| } | ||
|
|
||
| keys := make([]stringSortKey, len(list.List)) | ||
| for i, elem := range list.List { | ||
| s, ok := elem.(*bf.StringExpr) | ||
| if !ok { | ||
| return // don't sort lists unless all elements are strings | ||
| } | ||
| keys[i] = makeSortKey(i, s) | ||
| } | ||
|
|
||
| before := keys[0].x.Comment().Before | ||
| keys[0].x.Comment().Before = nil | ||
| sort.Sort(byStringExpr(keys)) | ||
| keys[0].x.Comment().Before = append(before, keys[0].x.Comment().Before...) | ||
| for i, k := range keys { | ||
| list.List[i] = k.x | ||
| } | ||
| } | ||
|
|
||
| // Code below this point is adapted from | ||
| // github.com/bazelbuild/buildtools/build/rewrite.go | ||
|
|
||
| // A stringSortKey records information about a single string literal to be | ||
| // sorted. The strings are first grouped into four phases: most strings, | ||
| // strings beginning with ":", strings beginning with "//", and strings | ||
| // beginning with "@". The next significant part of the comparison is the list | ||
| // of elements in the value, where elements are split at `.' and `:'. Finally | ||
| // we compare by value and break ties by original index. | ||
| type stringSortKey struct { | ||
| phase int | ||
| split []string | ||
| value string | ||
| original int | ||
| x bf.Expr | ||
| } | ||
|
|
||
| func makeSortKey(index int, x *bf.StringExpr) stringSortKey { | ||
| key := stringSortKey{ | ||
| value: x.Value, | ||
| original: index, | ||
| x: x, | ||
| } | ||
|
|
||
| switch { | ||
| case strings.HasPrefix(x.Value, ":"): | ||
| key.phase = 1 | ||
| case strings.HasPrefix(x.Value, "//"): | ||
| key.phase = 2 | ||
| case strings.HasPrefix(x.Value, "@"): | ||
| key.phase = 3 | ||
| } | ||
|
|
||
| key.split = strings.Split(strings.Replace(x.Value, ":", ".", -1), ".") | ||
| return key | ||
| } | ||
|
|
||
| // byStringExpr implements sort.Interface for a list of stringSortKey. | ||
| type byStringExpr []stringSortKey | ||
|
|
||
| func (x byStringExpr) Len() int { return len(x) } | ||
| func (x byStringExpr) Swap(i, j int) { x[i], x[j] = x[j], x[i] } | ||
|
|
||
| func (x byStringExpr) Less(i, j int) bool { | ||
| xi := x[i] | ||
| xj := x[j] | ||
|
|
||
| if xi.phase != xj.phase { | ||
| return xi.phase < xj.phase | ||
| } | ||
| for k := 0; k < len(xi.split) && k < len(xj.split); k++ { | ||
| if xi.split[k] != xj.split[k] { | ||
| return xi.split[k] < xj.split[k] | ||
| } | ||
| } | ||
| if len(xi.split) != len(xj.split) { | ||
| return len(xi.split) < len(xj.split) | ||
| } | ||
| if xi.value != xj.value { | ||
| return xi.value < xj.value | ||
| } | ||
| return xi.original < xj.original | ||
| } |