-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This tool rewrite Go source files to correctly capitalize acronyms. We used to do that by utilizing gogo/protobuf. However Google's protoc-gen-go doesn't support such customization sadly. Signed-off-by: Kazuyoshi Kato <[email protected]>
- Loading branch information
Showing
5 changed files
with
225 additions
and
9 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| /* | ||
| Copyright The containerd Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
| "fmt" | ||
| "go/format" | ||
| "go/parser" | ||
| "go/token" | ||
| "io" | ||
| "io/ioutil" | ||
| "os" | ||
| "regexp" | ||
| "strings" | ||
| ) | ||
|
|
||
| const name = "go-fix-acronym" | ||
|
|
||
| type stringArray []string | ||
|
|
||
| func (w *stringArray) String() string { | ||
| return strings.Join(*w, ",") | ||
| } | ||
|
|
||
| func (w *stringArray) Set(value string) error { | ||
| *w = append(*w, value) | ||
| return nil | ||
| } | ||
|
|
||
| type config struct { | ||
| overwrite bool | ||
| acronyms stringArray | ||
| } | ||
|
|
||
| func rewriteFile(c config, pattern *regexp.Regexp, path string) error { | ||
| content, err := ioutil.ReadFile(path) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fset := token.NewFileSet() | ||
| tree, err := parser.ParseFile(fset, path, content, parser.ParseComments) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| rewriteNode(pattern, tree) | ||
|
|
||
| var out io.Writer | ||
| if c.overwrite { | ||
| f, err := os.OpenFile(path, os.O_WRONLY, 0) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| out = f | ||
| defer f.Close() | ||
| } else { | ||
| out = os.Stdout | ||
| } | ||
| format.Node(out, fset, tree) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func realMain(c config, args []string) error { | ||
| pattern, err := compilePattern(c) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| for _, path := range args { | ||
| err := rewriteFile(c, pattern, path) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func main() { | ||
| var c config | ||
| flag.BoolVar(&c.overwrite, "w", false, "write result to (source) file instead of stdout") | ||
| flag.Var(&c.acronyms, "a", "acronym to capitalize") | ||
| flag.Parse() | ||
|
|
||
| err := realMain(c, flag.Args()) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "%s: %s\n", name, err) | ||
| os.Exit(1) | ||
| } | ||
| } |
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,48 @@ | ||
| /* | ||
| Copyright The containerd Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "go/ast" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "golang.org/x/tools/go/ast/astutil" | ||
| ) | ||
|
|
||
| func compilePattern(c config) (*regexp.Regexp, error) { | ||
| return regexp.Compile(strings.Join(c.acronyms, "|")) | ||
| } | ||
|
|
||
| func rewriteNode(pattern *regexp.Regexp, node ast.Node) { | ||
| astutil.Apply( | ||
| node, | ||
| func(c *astutil.Cursor) bool { | ||
| node := c.Node() | ||
| ident, ok := node.(*ast.Ident) | ||
| if !ok { | ||
| return true | ||
| } | ||
| name := pattern.ReplaceAllFunc([]byte(ident.Name), func(b []byte) []byte { | ||
| return []byte(strings.ToUpper(string(b))) | ||
| }) | ||
| ident.Name = string(name) | ||
| return false | ||
| }, | ||
| nil, | ||
| ) | ||
| } |
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,50 @@ | ||
| /* | ||
| Copyright The containerd Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "go/format" | ||
| "go/parser" | ||
| "go/token" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestRewrite(t *testing.T) { | ||
| input := "//hello\npackage main\nfunc GetCpu(){}" | ||
| expected := "//hello\npackage main\n\nfunc GetCPU() {}\n" | ||
|
|
||
| fset := token.NewFileSet() | ||
| n, err := parser.ParseFile(fset, "", input, parser.ParseComments) | ||
| if err != nil { | ||
| t.Fatalf("failed to parse: %s", err) | ||
| } | ||
|
|
||
| c := config{acronyms: []string{"Cpu"}} | ||
| p, err := compilePattern(c) | ||
| if err != nil { | ||
| t.Fatalf("failed to compile: %s", err) | ||
| } | ||
|
|
||
| rewriteNode(p, n) | ||
|
|
||
| out := &bytes.Buffer{} | ||
| format.Node(out, fset, n) | ||
| if out.String() != expected { | ||
| t.Fatalf("expected %q, but got %q", expected, out) | ||
| } | ||
| } |
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