Documentation
¶
Index ¶
- Constants
- type Config
- func (c *Config) AddAnnotationProcessorPlugin(annotationClass types.ClassName, processorClass types.ClassName)
- func (c *Config) AddExcludedArtifact(s string) error
- func (c *Config) AttributesForAnnotation(annotation string) (map[string]bzl.Expr, bool)
- func (c *Config) CanSetResolveToJavaExports() bool
- func (c Config) ExcludedArtifacts() map[string]struct{}
- func (c *Config) ExtensionEnabled() bool
- func (c *Config) GenerateBinary() bool
- func (c *Config) GenerateProto() bool
- func (c *Config) GenerateProtoServices() bool
- func (c *Config) GenerateResources() bool
- func (c *Config) GetAnnotationProcessorPluginClasses(annotationClass types.ClassName) *sorted_set.SortedSet[types.ClassName]
- func (c *Config) GetCustomJavaTestFileSuffixes() *[]string
- func (c *Config) IsJavaTestFile(basename string) bool
- func (c Config) IsModuleRoot() bool
- func (c *Config) IsTestRule(ruleKind string) bool
- func (c *Config) KotlinEnabled() bool
- func (c *Config) MapAnnotationToAttribute(annotation string, key string, value bzl.Expr)
- func (c *Config) MapAnnotationToWrapper(annotation string, wrapper string)
- func (c Config) MavenIndexFile() string
- func (c Config) MavenInstallFile() string
- func (c *Config) MavenRepositoryName() string
- func (c Config) ModuleGranularity() string
- func (c *Config) NewChild() *Config
- func (c *Config) ResolveToJavaExports() bool
- func (c *Config) SetExtensionEnabled(enabled bool)
- func (c *Config) SetGenerateBinary(generate bool)
- func (c *Config) SetGenerateProto(generate bool)
- func (c *Config) SetGenerateProtoServices(generate bool)
- func (c *Config) SetGenerateResources(enabled bool)
- func (c *Config) SetJavaTestFileSuffixes(suffixesString string) error
- func (c *Config) SetKotlinEnabled(enabled bool)
- func (c *Config) SetMavenIndexFile(filename string)
- func (c *Config) SetMavenInstallFile(filename string)
- func (c *Config) SetMavenRepositoryName(name string)
- func (c *Config) SetModuleGranularity(granularity string) error
- func (c *Config) SetResolveToJavaExports(resolve bool)
- func (c *Config) SetSourcesetRoot(root string)
- func (c *Config) SetStripResourcesPrefix(prefix string)
- func (c *Config) SetTestMode(mode string) error
- func (c *Config) SourcesetRoot() string
- func (c *Config) StripResourcesPrefix() string
- func (c Config) TestMode() string
- func (c *Config) WrapperForAnnotation(annotation string) (string, bool)
- type Configs
- type LoadInfo
Constants ¶
View Source
const ( // JavaExcludeArtifact tells the resolver to disregard a given maven artifact. // Can be repeated. JavaExcludeArtifact = "java_exclude_artifact" // JavaExtensionDirective represents the directive that controls whether // this Java extension is enabled or not. Sub-packages inherit this value. // Can be either "enabled" or "disabled". Defaults to "enabled". JavaExtensionDirective = "java_extension" // JavaMavenInstallFile represents the directive that controls where the // maven_install.json file is located. // Defaults to "maven_install.json". JavaMavenInstallFile = "java_maven_install_file" // MavenIndexFile represents the directive that controls where the index // file generated by `rules_jvm_external` is located. // Defaults to "maven_index.json" MavenIndexFile = "maven_index_file" // JavaModuleGranularityDirective represents the directive that controls whether // this Java module has a module granularity (Gradle) or a package // granularity (bazel). // Can be either "package" or "module". Defaults to "package". JavaModuleGranularityDirective = "java_module_granularity" // JavaTestFileSuffixes indicates within a test directory which files are test classes vs utility classes, // based on their basename. // It should be set up to match the value used for java_test_suite's test_suffixes attribute. // Accepted values are a comma-delimited list of strings. JavaTestFileSuffixes = "java_test_file_suffixes" // JavaTestMode allows user to choose from per file test or per directory test suite. JavaTestMode = "java_test_mode" // JavaGenerateProto tells the code generator whether to generate `java_proto_library` (and `java_library`) // rules when a `proto_library` rule is present. // Can be either "true" or "false". Defaults to "true". JavaGenerateProto = "java_generate_proto" // JavaGenerateProtoServices tells the code generator whether to generate `java_grpc_library` // rules when a `proto_library` rule with services is present. // Can be either "true" or "false". Defaults to "true". JavaGenerateProtoServices = "java_generate_proto_services" // JavaMavenRepositoryName tells the code generator what the repository name that contains all maven dependencies is. // Defaults to "maven" JavaMavenRepositoryName = "java_maven_repository_name" // JavaAnnotationProcessorPlugin tells the code generator about specific java_plugin targets needed to process // specific annotations. JavaAnnotationProcessorPlugin = "java_annotation_processor_plugin" // JavaResolveToJavaExports tells the code generator to favour resolving dependencies to java_exports where possible. // If enabled, generated libraries will try to depend on java_exports targets that export a given package, instead of the underlying library. // This allows monorepos to closely match a traditional Gradle/Maven model where subprojects are published in jars. // Can be either "true" or "false". Defaults to "true". // Inherited by children packages, can only be set at the root of the repository. JavaResolveToJavaExports = "java_resolve_to_java_exports" // JavaSourcesetRoot explicitly marks a directory as the root of a sourceset. // This provides a clear override to the auto-detection algorithm. // Example: # gazelle:java_sourceset_root my/custom/src JavaSourcesetRoot = "java_sourceset_root" // JavaStripResourcesPrefix overrides the path-stripping behavior for resources. // This is a direct way to specify the resource_strip_prefix for all resources in a directory. // Example: # gazelle:java_strip_resources_prefix my/data/config JavaStripResourcesPrefix = "java_strip_resources_prefix" //JavaGenerateBinary tells the code generator to generate the `java_binary` rules // Can be either "true" or "false". Defaults to "true" JavaGenerateBinary = "java_generate_binary" // JvmKotlinEnabled tells the code generator whether to support `kt_jvm_library` rules for Kotlin sources. // Can be either "true" or "false". Defaults to "true". // This requires importing the `@rules_kotlin` repository into your workspace if there are any Kotlin sources in the repo. JvmKotlinEnabled = "jvm_kotlin_enabled" // Tells the code generator to generate `pkg_files` rules for the resources directories JavaGenerateResources = "java_generate_resources" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
Config represents a config extension for a specific Bazel package.
func (*Config) AddAnnotationProcessorPlugin ¶ added in v0.26.0
func (*Config) AddExcludedArtifact ¶ added in v0.10.0
func (*Config) AttributesForAnnotation ¶ added in v0.6.0
func (*Config) CanSetResolveToJavaExports ¶ added in v0.30.0
func (Config) ExcludedArtifacts ¶ added in v0.10.0
func (*Config) ExtensionEnabled ¶ added in v0.6.0
ExtensionEnabled returns whether the extension is enabled or not.
func (*Config) GenerateBinary ¶ added in v0.31.0
func (*Config) GenerateProto ¶ added in v0.14.0
func (*Config) GenerateProtoServices ¶ added in v0.33.0
func (*Config) GenerateResources ¶ added in v0.32.0
func (*Config) GetAnnotationProcessorPluginClasses ¶ added in v0.26.0
func (*Config) GetCustomJavaTestFileSuffixes ¶ added in v0.10.0
func (*Config) IsJavaTestFile ¶ added in v0.10.0
func (Config) IsModuleRoot ¶
func (*Config) IsTestRule ¶ added in v0.24.0
func (*Config) KotlinEnabled ¶ added in v0.31.0
func (*Config) MapAnnotationToAttribute ¶ added in v0.6.0
func (*Config) MapAnnotationToWrapper ¶ added in v0.24.0
func (Config) MavenIndexFile ¶ added in v0.33.0
func (Config) MavenInstallFile ¶
func (*Config) MavenRepositoryName ¶ added in v0.18.0
func (Config) ModuleGranularity ¶
func (*Config) NewChild ¶
NewChild creates a new child Config. It inherits desired values from the current Config and sets itself as the parent to the child.
func (*Config) ResolveToJavaExports ¶ added in v0.30.0
func (*Config) SetExtensionEnabled ¶ added in v0.6.0
SetExtensionEnabled sets whether the extension is enabled or not.
func (*Config) SetGenerateBinary ¶ added in v0.31.0
func (*Config) SetGenerateProto ¶ added in v0.14.0
func (*Config) SetGenerateProtoServices ¶ added in v0.33.0
func (*Config) SetGenerateResources ¶ added in v0.32.0
func (*Config) SetJavaTestFileSuffixes ¶ added in v0.10.0
func (*Config) SetKotlinEnabled ¶ added in v0.31.0
func (*Config) SetMavenIndexFile ¶ added in v0.33.0
func (*Config) SetMavenInstallFile ¶
func (*Config) SetMavenRepositoryName ¶ added in v0.18.0
func (*Config) SetModuleGranularity ¶
func (*Config) SetResolveToJavaExports ¶ added in v0.30.0
func (*Config) SetSourcesetRoot ¶ added in v0.31.0
func (*Config) SetStripResourcesPrefix ¶ added in v0.31.0
func (*Config) SetTestMode ¶
func (*Config) SourcesetRoot ¶ added in v0.31.0
func (*Config) StripResourcesPrefix ¶ added in v0.31.0
type Configs ¶
Configs is an extension of map[string]*Config. It provides finding methods on top of the mapping.
func (*Configs) ParentForPackage ¶
ParentForPackage returns the parent Config for the given Bazel package.
Click to show internal directories.
Click to hide internal directories.