Use 'optional' instead of 'ignoreMissingFile' for Json to be consistent with UserSecrets.

Author: StephenMolloy

README.md

@@ -101,7 +101,7 @@ up connection information from the execution environment.
 <add name="SimpleJson"
     [mode|prefix|stripPrefix]
     jsonFile="~\config.json"
-    [ignoreMissingFile="true"]
+    [optional="true"]
     [jsonMode="(Flat|Sectional)"]
     type="Microsoft.Configuration.ConfigurationBuilders.SimpleJsonConfigBuilder, Microsoft.Configuration.ConfigurationBuilders.Json" />
 ```
@@ -114,7 +114,7 @@ begins with 'Simple.' Think of the backing json file as a simple dictionary, rat
 
 There are three additional attributes that can be used to configure this builder:
   * `jsonFile` - A required attribute specifying the json file to draw from. The '~' character can be used at the start to reference the app root.
-  * `ignoreMissingFile` - A simple boolean to avoid throwing exceptions if the secrets file cannot be found. The default is `true`.
+  * `optional` - A simple boolean to avoid throwing exceptions if the json file cannot be found. The default is `true`.
   * `jsonMode` - `[Flat|Sectional]`. 'Flat' is the default.
     - This attribute requires a little more explanation. It says above to think of the json file as a single flat key/value source. This is the usual that applies to other key/value config builders like `EnvironmentConfigBuilder` and `AzureKeyVaultConfigBuilder` because those sources provide no other option. If the `SimpleJsonConfigBuilder` is configured in 'Sectional' mode, then the json file is conceptually divided just at the top level into multiple simple dictionaries. Each one of those dictionaries will only be applied to the config section that matches the top-level property name attached to them. For example:
 ```json

src/Json/SimpleJsonConfigBuilder.cs

@@ -16,15 +16,15 @@ namespace Microsoft.Configuration.ConfigurationBuilders
     public class SimpleJsonConfigBuilder : KeyValueConfigBuilder
     {
         public const string jsonFileTag = "jsonFile";
-        public const string ignoreMissingFileTag = "ignoreMissingFile";
+        public const string optionalTag = "optional";
         public const string jsonModeTag = "jsonMode";
         public const string keyDelimiter = ":";
 
         private string _currentSection;
         private Dictionary<string, Dictionary<string, string>> _allSettings;
 
         public string JsonFile { get; protected set; }
-        public bool IgnoreMissingFile { get; protected set; }
+        public bool Optional { get; protected set; }
         public SimpleJsonConfigBuilderMode JsonMode { get; protected set; } = SimpleJsonConfigBuilderMode.Flat; // Flat dictionary, like core secrets.json
 
         public override void Initialize(string name, NameValueCollection config)
@@ -33,9 +33,9 @@ public override void Initialize(string name, NameValueCollection config)
 
             _allSettings = new Dictionary<string, Dictionary<string, string>>(StringComparer.OrdinalIgnoreCase);
 
-            // IgnoreMissingFile
-            bool ignoreMissing;
-            IgnoreMissingFile = (Boolean.TryParse(config?[ignoreMissingFileTag], out ignoreMissing)) ? ignoreMissing : true;
+            // Optional
+            bool optional;
+            Optional = (Boolean.TryParse(config?[optionalTag], out optional)) ? optional : true;
 
             // JsonFile
             string jsonFile = config?[jsonFileTag];
@@ -46,7 +46,7 @@ public override void Initialize(string name, NameValueCollection config)
             JsonFile = Utils.MapPath(jsonFile);
             if (!File.Exists(JsonFile))
             {
-                if (IgnoreMissingFile)
+                if (Optional)
                 {
                     // This empty dictionary allows us to effectively no-op any attempt to get values.
                     _allSettings[""] = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);

src/UserSecrets/UserSecretsConfigBuilder.cs

@@ -24,8 +24,8 @@ public override void Initialize(string name, NameValueCollection config)
         {
             base.Initialize(name, config);
 
-            bool ignoreMissing;
-            Optional = (Boolean.TryParse(config?[optionalTag], out ignoreMissing)) ? ignoreMissing : true;
+            bool optional;
+            Optional = (Boolean.TryParse(config?[optionalTag], out optional)) ? optional : true;
 
             // Explicit file reference takes precedence over an identifier.
             string secretsFile = config?[userSecretsFileTag];

test/Microsoft.Configuration.ConfigurationBuilders.Test/Test/SimpleJsonTests.cs

@@ -18,7 +18,7 @@ public SimpleJsonTests()
         // ======================================================================
         //    - See Parameters section of BaseTests for examples
         // jsonFile
-        // ignoreMissingFile
+        // optional
         // jsonMode
 
         // ======================================================================
@@ -40,6 +40,6 @@ public void SimpleJson_GetAllValues()
         // ======================================================================
         // Make sure various expected exceptions from SimpleJson contain the name of the builder
         // no file specified
-        // can't find file and ignoreMissingFile is false
+        // can't find file and optional is false
     }
 }

test/Microsoft.Configuration.ConfigurationBuilders.Test/Test/UserSecretsTests.cs

@@ -19,7 +19,7 @@ public UserSecretsTests()
         //    - See Parameters section of BaseTests for examples
         // userSecretsFile
         // userSecretsId
-        // ignoreMissingFile
+        // optional
         // Verify that userSecretsFile takes priority over userSecretsId when both are given
 
 
@@ -41,6 +41,6 @@ public void UserSecrets_GetAllValues()
         // ======================================================================
         // Make sure various expected exceptions from UserSecrets contain the name of the builder
         // No file AND no ID specified
-        // File and/or ID specified, but can't be found and ignoreMissingFile = false
+        // File and/or ID specified, but can't be found and optional = false
     }
 }