Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add visibility extension to support recursive default_visibility conf…
…iguration (#783) (#1343) Under a new /bazel/ subdirectory, this language-agnostic extension allows a directive to control the default_visibility templated out to all BUILD.bazel files in or under the directory. This feature is intended to allow large codebases to define hierarchical visibility defaults.
- Loading branch information
Showing
10 changed files
with
390 additions
and
35 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 |
|---|---|---|
|
|
@@ -6,3 +6,4 @@ | |
| /tests/bcr/bazel-bin | ||
| /tests/bcr/bazel-out | ||
| /tests/bcr/bazel-testlogs | ||
| .DS_STORE | ||
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,9 @@ | ||
| filegroup( | ||
| name = "all_files", | ||
| testonly = True, | ||
| srcs = [ | ||
| "BUILD.bazel", | ||
| "//language/bazel/visibility:all_files", | ||
| ], | ||
| visibility = ["//visibility:public"], | ||
| ) |
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,51 @@ | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test") | ||
|
|
||
| go_library( | ||
| name = "visibility", | ||
| srcs = [ | ||
| "config.go", | ||
| "lang.go", | ||
| "resolve.go", | ||
| ], | ||
| importpath = "github.com/bazelbuild/bazel-gazelle/language/bazel/visibility", | ||
| visibility = ["//visibility:public"], | ||
| deps = [ | ||
| "//config", | ||
| "//label", | ||
| "//language", | ||
| "//repo", | ||
| "//resolve", | ||
| "//rule", | ||
| ], | ||
| ) | ||
|
|
||
| alias( | ||
| name = "go_default_library", | ||
| actual = ":visibility", | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| go_test( | ||
| name = "visibility_test", | ||
| srcs = ["lang_test.go"], | ||
| deps = [ | ||
| ":visibility", | ||
| "//config", | ||
| "//label", | ||
| "//language", | ||
| "//rule", | ||
| ], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "all_files", | ||
| testonly = True, | ||
| srcs = [ | ||
| "BUILD.bazel", | ||
| "config.go", | ||
| "lang.go", | ||
| "lang_test.go", | ||
| "resolve.go", | ||
| ], | ||
| visibility = ["//visibility:public"], | ||
| ) |
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,64 @@ | ||
| package visibility | ||
|
|
||
| import ( | ||
| "flag" | ||
| "strings" | ||
|
|
||
| "github.com/bazelbuild/bazel-gazelle/config" | ||
| "github.com/bazelbuild/bazel-gazelle/rule" | ||
| ) | ||
|
|
||
| const ( | ||
| _directiveName = "default_visibility" | ||
| ) | ||
|
|
||
| type visConfig struct { | ||
| visibilityTargets []string | ||
| } | ||
|
|
||
| // getVisConfig directly returns the internal configuration struct rather | ||
| // than a pointer because we explicitly want pass-by-value symantics so | ||
| // configurations down a directory tree don't accidentially update upstream. | ||
| func getVisConfig(c *config.Config) visConfig { | ||
| cfg := c.Exts[_extName] | ||
| if cfg == nil { | ||
| return visConfig{} | ||
| } | ||
| return cfg.(visConfig) | ||
| } | ||
|
|
||
| // RegisterFlags noops because we only parameterize behavior with a directive. | ||
| func (*visibilityExtension) RegisterFlags(fs *flag.FlagSet, cmd string, c *config.Config) {} | ||
|
|
||
| // CheckFlags noops because no flags are referenced. | ||
| func (*visibilityExtension) CheckFlags(fs *flag.FlagSet, c *config.Config) error { | ||
| return nil | ||
| } | ||
|
|
||
| // KnownDirectives returns the only directive this extension operates on. | ||
| func (*visibilityExtension) KnownDirectives() []string { | ||
| return []string{_directiveName} | ||
| } | ||
|
|
||
| // Configure identifies the visibility targets from the directive value, if it exists. | ||
| // | ||
| // To set multiple visibility targets, either multiple directives can be used, or a | ||
| // list can be provided with comma-separated values. | ||
| func (*visibilityExtension) Configure(c *config.Config, _ string, f *rule.File) { | ||
| cfg := getVisConfig(c) | ||
| if f == nil { | ||
| return | ||
| } | ||
|
|
||
| for _, d := range f.Directives { | ||
| switch d.Key { | ||
| case _directiveName: | ||
| for _, target := range strings.Split(d.Value, ",") { | ||
| cfg.visibilityTargets = append(cfg.visibilityTargets, target) | ||
| } | ||
| } | ||
| } | ||
| c.Exts[_extName] = cfg | ||
| } | ||
|
|
||
| // /Configurator embed |
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,52 @@ | ||
| package visibility | ||
|
|
||
| import ( | ||
| "github.com/bazelbuild/bazel-gazelle/config" | ||
| "github.com/bazelbuild/bazel-gazelle/language" | ||
| "github.com/bazelbuild/bazel-gazelle/rule" | ||
| ) | ||
|
|
||
| type visibilityExtension struct{} | ||
|
|
||
| // NewLanguage constructs a new language.Language modifying visibility. | ||
| func NewLanguage() language.Language { | ||
| return &visibilityExtension{} | ||
| } | ||
|
|
||
| // Kinds instructs gazelle to match any 'package' rule as BUILD files can only have one. | ||
| func (*visibilityExtension) Kinds() map[string]rule.KindInfo { | ||
| return map[string]rule.KindInfo{ | ||
| "package": { | ||
| MatchAny: true, | ||
| MergeableAttrs: map[string]bool{ | ||
| "default_visibility": true, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // Loads noops because there are no imports to add | ||
| func (*visibilityExtension) Loads() []rule.LoadInfo { | ||
| return nil | ||
| } | ||
|
|
||
| // GenerateRules does the hard work of setting the default_visibility if a config exists. | ||
| func (*visibilityExtension) GenerateRules(args language.GenerateArgs) language.GenerateResult { | ||
| res := language.GenerateResult{} | ||
| cfg := getVisConfig(args.Config) | ||
|
|
||
| if len(cfg.visibilityTargets) == 0 { | ||
| return res | ||
| } | ||
|
|
||
| r := rule.NewRule("package", "") | ||
| r.SetAttr("default_visibility", cfg.visibilityTargets) | ||
|
|
||
| res.Gen = append(res.Gen, r) | ||
| // we have to add a nil to Imports because there is length-matching validation with Gen. | ||
| res.Imports = append(res.Imports, nil) | ||
| return res | ||
| } | ||
|
|
||
| // Fix noop because there is nothing out there to fix yet | ||
| func (*visibilityExtension) Fix(c *config.Config, f *rule.File) {} |
Oops, something went wrong.