Disable file watching for the Bicep linter config file (#3044)

anthony-c-martin · web-flow · commit 7ebed03284e0 · 2021-06-04T12:35:26.000-07:00
diff --git a/src/Bicep.Core/Configuration/ConfigHelper.cs b/src/Bicep.Core/Configuration/ConfigHelper.cs
@@ -50,7 +50,9 @@ private IConfigurationRoot BuildConfig(string? localFolder)
                 // last added json settings take precedent - add local settings last
                 if (DiscoverLocalConfigurationFile(localFolder) is string localConfig)
                 {
-                    configBuilder.AddJsonFile(localConfig, true, true);
+                    // we must set reloadOnChange to false here - if it set to true, then ConfigurationBuilder will initialize 
+                    // a FileSystem.Watcher instance - which has severe performance impact on non-Windows OSes (https://github.com/dotnet/runtime/issues/42036)
+                    configBuilder.AddJsonFile(localConfig, optional: true, reloadOnChange: false);
                     this.CustomSettingsFileName = localConfig;
                 }
                 else

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,9 @@ private IConfigurationRoot BuildConfig(string? localFolder)`
`50`	`50`	`// last added json settings take precedent - add local settings last`
`51`	`51`	`if (DiscoverLocalConfigurationFile(localFolder) is string localConfig)`
`52`	`52`	`{`
`53`		`- configBuilder.AddJsonFile(localConfig, true, true);`
	`53`	`+ // we must set reloadOnChange to false here - if it set to true, then ConfigurationBuilder will initialize`
	`54`	`+ // a FileSystem.Watcher instance - which has severe performance impact on non-Windows OSes (https://github.com/dotnet/runtime/issues/42036)`
	`55`	`+ configBuilder.AddJsonFile(localConfig, optional: true, reloadOnChange: false);`
`54`	`56`	`this.CustomSettingsFileName = localConfig;`
`55`	`57`	`}`
`56`	`58`	`else`