Add experimentalFeaturesWarning (#17910)

shenglol · web-flow · commit 892c705d946e · 2025-09-02T16:28:32.000-07:00
Added a setting `experimentalFeaturesWarning` to let users control whether experimental feature warnings are displayed. ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/Azure/bicep/pull/17910)
diff --git a/src/Bicep.Cli/Helpers/CommandHelper.cs b/src/Bicep.Cli/Helpers/CommandHelper.cs
@@ -20,7 +20,8 @@ public static int GetExitCode(DiagnosticSummary summary)
 
     public static void LogExperimentalWarning(ILogger logger, Compilation compilation)
     {
-        if (ExperimentalFeatureWarningProvider.TryGetEnabledExperimentalFeatureWarningMessage(compilation.SourceFileGrouping.SourceFiles) is { } warningMessage)
+        if (compilation.GetEntrypointSemanticModel().Configuration.ExperimentalFeaturesWarning &&
+            ExperimentalFeatureWarningProvider.TryGetEnabledExperimentalFeatureWarningMessage(compilation.SourceFileGrouping.SourceFiles) is { } warningMessage)
         {
             logger.LogWarning(warningMessage);
         }
diff --git a/src/Bicep.Core.UnitTests/Configuration/ConfigurationManagerTests.cs b/src/Bicep.Core.UnitTests/Configuration/ConfigurationManagerTests.cs
@@ -97,6 +97,7 @@ public void GetBuiltInConfiguration_NoParameter_ReturnsBuiltInConfigurationWithA
             }
           }
         },
+        "experimentalFeaturesWarning": true,
         "experimentalFeaturesEnabled": {
           "extendableParamFiles": false,
           "symbolicNameCodegen": false,
@@ -179,6 +180,7 @@ public void GetBuiltInConfiguration_DisableAllAnalyzers_ReturnsBuiltInConfigurat
             "az"
         ],
         "analyzers": {},
+        "experimentalFeaturesWarning": true,
         "experimentalFeaturesEnabled": {
           "extendableParamFiles": false,
           "symbolicNameCodegen": false,
@@ -283,6 +285,7 @@ public void GetBuiltInConfiguration_DisableAnalyzers_ReturnsBuiltInConfiguration
             }
           }
         },
+        "experimentalFeaturesWarning": true,
         "experimentalFeaturesEnabled": {
           "extendableParamFiles": false,
           "symbolicNameCodegen": false,
@@ -452,6 +455,7 @@ public void GetBuiltInConfiguration_EnableExperimentalFeature_ReturnsBuiltInConf
                 }
                 }
             },
+            "experimentalFeaturesWarning": true,
             "experimentalFeaturesEnabled": {
                 "symbolicNameCodegen": false,
                 "extendableParamFiles": true,
@@ -702,6 +706,7 @@ public void GetConfiguration_ValidCustomConfiguration_OverridesBuiltInConfigurat
                         }
                       },
                       "cacheRootDirectory": "/home/username/.bicep/cache",
+                      "experimentalFeaturesWarning": false,
                       "experimentalFeaturesEnabled": {},
                       "formatting": {
                         "indentKind": "Space",
@@ -801,6 +806,7 @@ public void GetConfiguration_ValidCustomConfiguration_OverridesBuiltInConfigurat
                     }
                   },
                   "cacheRootDirectory": "/home/username/.bicep/cache",
+                  "experimentalFeaturesWarning": false,
                   "experimentalFeaturesEnabled": {
                     "extendableParamFiles": false,
                     "symbolicNameCodegen": false,
diff --git a/src/Bicep.Core.UnitTests/Configuration/RootConfigurationTests.cs b/src/Bicep.Core.UnitTests/Configuration/RootConfigurationTests.cs
@@ -21,6 +21,7 @@ public void RootConfiguration_LeadingTildeInCacheRootDirectory_ExpandPath(string
                 BicepTestConstants.BuiltInConfiguration.ImplicitExtensions,
                 BicepTestConstants.BuiltInConfiguration.Analyzers,
                 cacheRootDirectory,
+                BicepTestConstants.BuiltInConfiguration.ExperimentalFeaturesWarning,
                 BicepTestConstants.BuiltInConfiguration.ExperimentalFeaturesEnabled,
                 BicepTestConstants.BuiltInConfiguration.Formatting,
                 BicepTestConstants.BuiltInConfiguration.ConfigFileUri,
diff --git a/src/Bicep.Core.UnitTests/Diagnostics/LinterRuleTests/UseRecentApiVersionRuleTests.cs b/src/Bicep.Core.UnitTests/Diagnostics/LinterRuleTests/UseRecentApiVersionRuleTests.cs
@@ -126,6 +126,7 @@ private static RootConfiguration CreateConfigurationWithFakeToday(RootConfigurat
                             .Replace("<TESTING_TODAY_DATE>", today)
                             .Replace("<MAX_AGE_PROP>", maxAgeInDays.HasValue ? $", \"maxAgeInDays\": {maxAgeInDays}" : ""))),
                 original.CacheRootDirectory,
+                original.ExperimentalFeaturesWarning,
                 original.ExperimentalFeaturesEnabled with
                 {
                     SymbolicNameCodegen = true,
diff --git a/src/Bicep.Core/Configuration/AnalyzersConfigurationExtensions.cs b/src/Bicep.Core/Configuration/AnalyzersConfigurationExtensions.cs
@@ -44,6 +44,7 @@ public static RootConfiguration WithAnalyzersConfiguration(this RootConfiguratio
                 current.ImplicitExtensions,
                 analyzersConfiguration,
                 current.CacheRootDirectory,
+                current.ExperimentalFeaturesWarning,
                 current.ExperimentalFeaturesEnabled,
                 current.Formatting,
                 current.ConfigFileUri,
@@ -66,6 +67,7 @@ public static RootConfiguration WithCloudConfiguration(this RootConfiguration cu
             current.ImplicitExtensions,
             current.Analyzers,
             current.CacheRootDirectory,
+            current.ExperimentalFeaturesWarning,
             current.ExperimentalFeaturesEnabled,
             current.Formatting,
             current.ConfigFileUri,
diff --git a/src/Bicep.Core/Configuration/ExperimentalFeaturesExtensions.cs b/src/Bicep.Core/Configuration/ExperimentalFeaturesExtensions.cs
@@ -13,6 +13,7 @@ public static RootConfiguration WithExperimentalFeaturesConfiguration(this RootC
                 current.ImplicitExtensions,
                 current.Analyzers,
                 current.CacheRootDirectory,
+                current.ExperimentalFeaturesWarning,
                 featuresEnabled,
                 current.Formatting,
                 current.ConfigFileUri,
diff --git a/src/Bicep.Core/Configuration/ExtensionsConfigurationExtensions.cs b/src/Bicep.Core/Configuration/ExtensionsConfigurationExtensions.cs
@@ -22,6 +22,7 @@ public static RootConfiguration WithExtensions(this RootConfiguration rootConfig
             rootConfiguration.ImplicitExtensions,
             rootConfiguration.Analyzers,
             rootConfiguration.CacheRootDirectory,
+            rootConfiguration.ExperimentalFeaturesWarning,
             rootConfiguration.ExperimentalFeaturesEnabled,
             rootConfiguration.Formatting,
             rootConfiguration.ConfigFileUri,
@@ -37,6 +38,7 @@ public static RootConfiguration WithImplicitExtensions(this RootConfiguration ro
             rootConfiguration.ImplicitExtensions.WithImplicitExtensions(payload),
             rootConfiguration.Analyzers,
             rootConfiguration.CacheRootDirectory,
+            rootConfiguration.ExperimentalFeaturesWarning,
             rootConfiguration.ExperimentalFeaturesEnabled,
             rootConfiguration.Formatting,
             rootConfiguration.ConfigFileUri,
diff --git a/src/Bicep.Core/Configuration/RootConfiguration.cs b/src/Bicep.Core/Configuration/RootConfiguration.cs
@@ -25,6 +25,8 @@ public class RootConfiguration
 
         public const string CacheRootDirectoryKey = "cacheRootDirectory";
 
+        public const string ExperimentalFeaturesWarningKey = "experimentalFeaturesWarning";
+
         public const string ExperimentalFeaturesEnabledKey = "experimentalFeaturesEnabled";
 
         public const string FormattingKey = "formatting";
@@ -36,6 +38,7 @@ public RootConfiguration(
             ImplicitExtensionsConfiguration implicitExtensions,
             AnalyzersConfiguration analyzers,
             string? cacheRootDirectory,
+            bool experimentalFeaturesWarning,
             ExperimentalFeaturesEnabled experimentalFeaturesEnabled,
             FormattingConfiguration formatting,
             IOUri? configFileUri,
@@ -47,6 +50,7 @@ public RootConfiguration(
             this.ImplicitExtensions = implicitExtensions;
             this.Analyzers = analyzers;
             this.CacheRootDirectory = ExpandCacheRootDirectory(cacheRootDirectory);
+            this.ExperimentalFeaturesWarning = experimentalFeaturesWarning;
             this.ExperimentalFeaturesEnabled = experimentalFeaturesEnabled;
             this.Formatting = formatting;
             this.ConfigFileUri = configFileUri;
@@ -59,13 +63,14 @@ public static RootConfiguration Bind(JsonElement element, IOUri? configFileUri =
             var moduleAliases = ModuleAliasesConfiguration.Bind(element.GetProperty(ModuleAliasesKey), configFileUri);
             var analyzers = new AnalyzersConfiguration(element.GetProperty(AnalyzersKey));
             var cacheRootDirectory = element.TryGetProperty(CacheRootDirectoryKey, out var e) ? e.GetString() : default;
+            var experimentalFeaturesWarning = element.TryGetProperty(ExperimentalFeaturesWarningKey, out var value) && value.GetBoolean();
             var experimentalFeaturesEnabled = ExperimentalFeaturesEnabled.Bind(element.GetProperty(ExperimentalFeaturesEnabledKey));
             var formatting = FormattingConfiguration.Bind(element.GetProperty(FormattingKey));
 
             var extensions = ExtensionsConfiguration.Bind(element.GetProperty(ExtensionsKey));
             var implicitExtensions = ImplicitExtensionsConfiguration.Bind(element.GetProperty(ImplicitExtensionsKey));
 
-            return new(cloud, moduleAliases, extensions, implicitExtensions, analyzers, cacheRootDirectory, experimentalFeaturesEnabled, formatting, configFileUri, null);
+            return new(cloud, moduleAliases, extensions, implicitExtensions, analyzers, cacheRootDirectory, experimentalFeaturesWarning, experimentalFeaturesEnabled, formatting, configFileUri, null);
         }
 
         public CloudConfiguration Cloud { get; }
@@ -80,6 +85,8 @@ public static RootConfiguration Bind(JsonElement element, IOUri? configFileUri =
 
         public string? CacheRootDirectory { get; }
 
+        public bool ExperimentalFeaturesWarning { get; }
+
         public ExperimentalFeaturesEnabled ExperimentalFeaturesEnabled { get; }
 
         public FormattingConfiguration Formatting { get; }
@@ -97,6 +104,7 @@ public RootConfiguration With(
             ImplicitExtensionsConfiguration? implicitExtensions = null,
             AnalyzersConfiguration? analyzers = null,
             string? cacheRootDirectory = null,
+            bool? experimentalFeaturesWarning = null,
             ExperimentalFeaturesEnabled? experimentalFeaturesEnabled = null,
             FormattingConfiguration? formatting = null,
             IOUri? configFileIdentifier = null,
@@ -109,6 +117,7 @@ public RootConfiguration With(
                 implicitExtensions ?? this.ImplicitExtensions,
                 analyzers ?? this.Analyzers,
                 cacheRootDirectory ?? this.CacheRootDirectory,
+                experimentalFeaturesWarning ?? this.ExperimentalFeaturesWarning,
                 experimentalFeaturesEnabled ?? this.ExperimentalFeaturesEnabled,
                 formatting ?? this.Formatting,
                 configFileIdentifier ?? this.ConfigFileUri,
@@ -142,6 +151,8 @@ public string ToUtf8Json()
                     writer.WriteString(CacheRootDirectoryKey, cacheRootDir);
                 }
 
+                writer.WriteBoolean(ExperimentalFeaturesWarningKey, this.ExperimentalFeaturesWarning);
+
                 writer.WritePropertyName(ExperimentalFeaturesEnabledKey);
                 this.ExperimentalFeaturesEnabled.WriteTo(writer);
 
diff --git a/src/Bicep.Core/Configuration/bicepconfig.json b/src/Bicep.Core/Configuration/bicepconfig.json
@@ -60,6 +60,7 @@
       }
     }
   },
+  "experimentalFeaturesWarning": true,
   "experimentalFeaturesEnabled": {},
   "formatting": {}
 }
diff --git a/src/vscode-bicep/schemas/bicepconfig.schema.json b/src/vscode-bicep/schemas/bicepconfig.schema.json
@@ -830,6 +830,10 @@
       "type": "string",
       "description": "The directory in which Bicep may cache templates downloaded from remote registries"
     },
+    "experimentalFeaturesWarning": {
+      "type": "boolean",
+      "description": "Controls whether the Bicep CLI displays a warning when experimental features are used. Defaults to true."
+    },
     "experimentalFeaturesEnabled": {
       "type": "object",
       "description": "The experimental Bicep features that should be enabled or disabled for templates using this configuration file. See https://aka.ms/bicep/experimental-features for more information.",

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ public static int GetExitCode(DiagnosticSummary summary)`
`20`	`20`
`21`	`21`	`public static void LogExperimentalWarning(ILogger logger, Compilation compilation)`
`22`	`22`	`{`
`23`		`- if (ExperimentalFeatureWarningProvider.TryGetEnabledExperimentalFeatureWarningMessage(compilation.SourceFileGrouping.SourceFiles) is { } warningMessage)`
	`23`	`+ if (compilation.GetEntrypointSemanticModel().Configuration.ExperimentalFeaturesWarning &&`
	`24`	`+ ExperimentalFeatureWarningProvider.TryGetEnabledExperimentalFeatureWarningMessage(compilation.SourceFileGrouping.SourceFiles) is { } warningMessage)`
`24`	`25`	`{`
`25`	`26`	`logger.LogWarning(warningMessage);`
`26`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ public void GetBuiltInConfiguration_NoParameter_ReturnsBuiltInConfigurationWithA`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`	`},`
	`100`	`+ "experimentalFeaturesWarning": true,`
`100`	`101`	`"experimentalFeaturesEnabled": {`
`101`	`102`	`"extendableParamFiles": false,`
`102`	`103`	`"symbolicNameCodegen": false,`
`@@ -179,6 +180,7 @@ public void GetBuiltInConfiguration_DisableAllAnalyzers_ReturnsBuiltInConfigurat`
`179`	`180`	`"az"`
`180`	`181`	`],`
`181`	`182`	`"analyzers": {},`
	`183`	`+ "experimentalFeaturesWarning": true,`
`182`	`184`	`"experimentalFeaturesEnabled": {`
`183`	`185`	`"extendableParamFiles": false,`
`184`	`186`	`"symbolicNameCodegen": false,`
`@@ -283,6 +285,7 @@ public void GetBuiltInConfiguration_DisableAnalyzers_ReturnsBuiltInConfiguration`
`283`	`285`	`}`
`284`	`286`	`}`
`285`	`287`	`},`
	`288`	`+ "experimentalFeaturesWarning": true,`
`286`	`289`	`"experimentalFeaturesEnabled": {`
`287`	`290`	`"extendableParamFiles": false,`
`288`	`291`	`"symbolicNameCodegen": false,`
`@@ -452,6 +455,7 @@ public void GetBuiltInConfiguration_EnableExperimentalFeature_ReturnsBuiltInConf`
`452`	`455`	`}`
`453`	`456`	`}`
`454`	`457`	`},`
	`458`	`+ "experimentalFeaturesWarning": true,`
`455`	`459`	`"experimentalFeaturesEnabled": {`
`456`	`460`	`"symbolicNameCodegen": false,`
`457`	`461`	`"extendableParamFiles": true,`
`@@ -702,6 +706,7 @@ public void GetConfiguration_ValidCustomConfiguration_OverridesBuiltInConfigurat`
`702`	`706`	`}`
`703`	`707`	`},`
`704`	`708`	`"cacheRootDirectory": "/home/username/.bicep/cache",`
	`709`	`+ "experimentalFeaturesWarning": false,`
`705`	`710`	`"experimentalFeaturesEnabled": {},`
`706`	`711`	`"formatting": {`
`707`	`712`	`"indentKind": "Space",`
`@@ -801,6 +806,7 @@ public void GetConfiguration_ValidCustomConfiguration_OverridesBuiltInConfigurat`
`801`	`806`	`}`
`802`	`807`	`},`
`803`	`808`	`"cacheRootDirectory": "/home/username/.bicep/cache",`
	`809`	`+ "experimentalFeaturesWarning": false,`
`804`	`810`	`"experimentalFeaturesEnabled": {`
`805`	`811`	`"extendableParamFiles": false,`
`806`	`812`	`"symbolicNameCodegen": false,`
Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,7 @@ private static RootConfiguration CreateConfigurationWithFakeToday(RootConfigurat`
`126`	`126`	`.Replace("<TESTING_TODAY_DATE>", today)`
`127`	`127`	`.Replace("<MAX_AGE_PROP>", maxAgeInDays.HasValue ? $", \"maxAgeInDays\": {maxAgeInDays}" : ""))),`
`128`	`128`	`original.CacheRootDirectory,`
	`129`	`+ original.ExperimentalFeaturesWarning,`
`129`	`130`	`original.ExperimentalFeaturesEnabled with`
`130`	`131`	`{`
`131`	`132`	`SymbolicNameCodegen = true,`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`},`
	`63`	`+ "experimentalFeaturesWarning": true,`
`63`	`64`	`"experimentalFeaturesEnabled": {},`
`64`	`65`	`"formatting": {}`
`65`	`66`	`}`