Disable cue_consolidated_instance generation by default

examples/gazelle/BUILD.bazel

@@ -1,6 +1,7 @@
 load("@gazelle//:def.bzl", "gazelle")
 
 # gazelle:prefix github.com/abcue/rules_cue/examples/gazelle
+# gazelle:cue_gen_consolidated_instance
 
 # Run this to update BUILD.bazel files:
 # bazel run //:gazelle

examples/gazelle/README.md

@@ -203,6 +203,12 @@ You can customize Gazelle behavior using directives in BUILD.bazel files:
 # Control output format for CUE exports (json, yaml, text, or cue)
 # gazelle:cue_output_format yaml
 
+# Generate cue_consolidated_instance rules (opt-in)
+# gazelle:cue_gen_consolidated_instance
+
+# Disable in a subdirectory
+# gazelle:cue_gen_consolidated_instance false
+
 # Generate cue_exported_instance rules
 # gazelle:cue_gen_exported_instance
 

examples/gazelle/services/api/BUILD.bazel

@@ -1,4 +1,6 @@
-load("@rules_cue//cue:cue.bzl", "cue_consolidated_instance", "cue_instance")
+load("@rules_cue//cue:cue.bzl", "cue_instance")
+
+# gazelle:cue_gen_consolidated_instance false
 
 cue_instance(
     name = "api_cue_instance",
@@ -10,10 +12,3 @@ cue_instance(
     ancestor = "//cue.mod:cue.mod",
     visibility = ["//visibility:public"],
 )
-
-cue_consolidated_instance(
-    name = "api_cue_def",
-    instance = ":api_cue_instance",
-    output_format = "cue",
-    visibility = ["//visibility:public"],
-)

gazelle/cue/config.go

@@ -31,10 +31,15 @@ type cueConfig struct {
 	cueTestGoldenFilename string
 
 	// cueGenExportedInstance controls whether to generate cue_exported_instance rules
-	// for each cue_instance. When true, a corresponding cue_exported_instance rule will be created.
-	// #gazelle:cue_exported_instance
+	// for each cue_instance. When not false, a corresponding cue_exported_instance rule will be created.
+	// #gazelle:cue_gen_exported_instance
 	cueGenExportedInstance bool
 
+	// cueGenConsolidatedInstance controls whether to generate cue_consolidated_instance rules
+	// for each cue_instance. When not false, a corresponding cue_consolidated_instance rule will be created.
+	// #gazelle:cue_gen_consolidated_instance
+	cueGenConsolidatedInstance bool
+
 	// cueOutputFormat specifies the output format for CUE exports.
 	// Valid values are "json", "yaml", and "text".
 	// Default is "json" if not specified.
@@ -45,7 +50,7 @@ type cueConfig struct {
 // Configurer can interpret. Gazelle prints errors for directives that
 // are not recognized by any Configurer.
 func (s *cueLang) KnownDirectives() []string {
-	return []string{"prefix", "cue_test_golden_suffix", "cue_test_golden_filename", "cue_output_format", "cue_gen_exported_instance"}
+	return []string{"prefix", "cue_test_golden_suffix", "cue_test_golden_filename", "cue_output_format", "cue_gen_exported_instance", "cue_gen_consolidated_instance"}
 }
 
 // RegisterFlags registers command-line flags used by the
@@ -117,7 +122,9 @@ func (s *cueLang) Configure(c *config.Config, rel string, f *rule.File) {
 				conf.cueTestGoldenFilename = d.Value
 				conf.cueTestGoldenSuffix = strings.TrimPrefix(path.Ext(d.Value), ".")
 			case "cue_gen_exported_instance":
-				conf.cueGenExportedInstance = true
+				conf.cueGenExportedInstance = d.Value != "false"
+			case "cue_gen_consolidated_instance":
+				conf.cueGenConsolidatedInstance = d.Value != "false"
 			case "cue_output_format":
 				conf.cueOutputFormat = d.Value
 			}

gazelle/cue/generate.go

@@ -61,7 +61,7 @@ func (cl *cueLang) GenerateRules(args language.GenerateArgs) language.GenerateRe
 		consolidatedInstances:    make(map[string]*cueConsolidatedInstance),
 		exportedGoldenFiles:      make(map[string]*GoldenFile), // key: filename
 		cueTestRules:             make(map[string]*cueTest),
-		genConsolidatedInstances: true,
+		genConsolidatedInstances: conf.cueGenConsolidatedInstance,
 		genExportedInstances:     conf.cueGenExportedInstance,
 	}