Rename Config.arraySep to valueSep (#184)

Author: andrey-zherikov

README.md

@@ -29,6 +29,8 @@
 
   * `Config.addHelp` is renamed to `Config.addHelpArgument`.
 
+  * `Config.arraySep` is renamed to `Config.valueSep`.
+
 * `Style.namedArgumentName` is renamed to `Style.argumentName`.
 
 * Underlying type of `ansiStylingArgument` argument is changed. It can now be directly cast to boolean instead comparing against `Config.StylingMode`.

docs/code_snippets/config_arraySep.d

@@ -9,7 +9,7 @@ T t1;
 assert(CLI!T.parseArgs(t1, ["-a","1:2:3","-a","4","5"]));
 assert(t1 == T(["1:2:3","4","5"]));
 
-enum Config cfg = { arraySep: ':' };
+enum Config cfg = { valueSep: ':' };
 
 T t2;
 assert(CLI!(cfg, T).parseArgs(t2, ["-a","1:2:3","-a","4","5"]));

docs/code_snippets/types_array_comma.d

@@ -5,7 +5,7 @@ struct T
     int[] a;
 }
 
-enum Config cfg = { arraySep: ',' };
+enum Config cfg = { valueSep: ',' };
 
 T t;
 assert(CLI!(cfg, T).parseArgs(t, ["-a=1,2,3","-a","4,5"]));

docs/code_snippets/types_assoc_array_comma.d

@@ -5,7 +5,7 @@ struct T
     int[string] a;
 }
 
-enum Config cfg = { arraySep: ',' };
+enum Config cfg = { valueSep: ',' };
 
 T t;
 assert(CLI!(cfg, T).parseArgs(t, ["-a=foo=3,boo=7","-a","bar=4,baz=9"]));

docs/topics/Supported-types.md

@@ -46,7 +46,7 @@ The difference can be easily shown in the following example:
 
 <code-block src="code_snippets/types_array.d" lang="c++"/>
 
-Alternatively one can set [`Config.arraySep`](Config.md#arraySep) to allow multiple elements in one command line entry:
+Alternatively one can set [`Config.valueSep`](Config.md#valueSep) to allow multiple elements in one command line entry:
 
 <code-block src="code_snippets/types_array_comma.d" lang="c++"/>
 
@@ -57,7 +57,7 @@ format of the value is `key=value` (equal sign can be customized with [`Config.a
 
 <code-block src="code_snippets/types_assoc_array.d" lang="c++"/>
 
-Alternatively one can set [`Config.arraySep`](Config.md#arraySep) to allow multiple elements in one command line entry:
+Alternatively one can set [`Config.valueSep`](Config.md#valueSep) to allow multiple elements in one command line entry:
 
 <code-block src="code_snippets/types_assoc_array_comma.d" lang="c++"/>
 

docs/topics/reference/Config.md

@@ -13,10 +13,10 @@ Example:
 
 <code-block src="code_snippets/config_assignChar.d" lang="c++"/>
 
-## Array separator {id="arraySep"}
+## Value separator {id="valueSep"}
 
-When `Config.arraySep` is set to `char.init`, values to array and associative-array receivers are treated as an individual
-value. That is, only one argument is appended/inserted per appearance of the argument. If `arraySep` is set to something
+When `Config.valueSep` is set to `char.init`, values to array and associative-array receivers are treated as an individual
+value. That is, only one argument is appended/inserted per appearance of the argument. If `valueSep` is set to something
 else, then each value is first split by the separator, and the individual pieces are treated as values to the same
 argument.
 

source/argparse/config.d

@@ -14,13 +14,13 @@ struct Config
     /**
        When set to char.init, parameters to array and associative array receivers are
        treated as an individual argument. That is, only one argument is appended or
-       inserted per appearance of the option switch. If `arraySep` is set to
+       inserted per appearance of the option switch. If `valueSep` is set to
        something else, then each parameter is first split by the separator, and the
        individual pieces are treated as arguments to the same option.
 
        Defaults to char.init
      */
-    char arraySep = char.init;
+    char valueSep = char.init;
 
     /**
        The prefix for argument name.

source/argparse/internal/valueparser.d

@@ -490,21 +490,21 @@ unittest
 
 private void splitValues(ref RawParam param)
 {
-    if(param.config.arraySep == char.init)
+    if(param.config.valueSep == char.init)
         return;
 
     import std.array : array, split;
     import std.algorithm : map, joiner;
 
-    param.value = param.value.map!((string s) => s.split(param.config.arraySep)).joiner.array;
+    param.value = param.value.map!((string s) => s.split(param.config.valueSep)).joiner.array;
 }
 
 unittest
 {
-    alias test = (char arraySep, string[] values)
+    alias test = (char valueSep, string[] values)
     {
         Config config;
-        config.arraySep = arraySep;
+        config.valueSep = valueSep;
 
         auto param = RawParam(&config, "", values);
 

source/argparse/package.d

@@ -610,7 +610,7 @@ unittest
 
     enum cfg = {
         Config cfg;
-        cfg.arraySep = ',';
+        cfg.valueSep = ',';
         return cfg;
     }();
 
@@ -636,7 +636,7 @@ unittest
 
     enum cfg = {
         Config cfg;
-        cfg.arraySep = ',';
+        cfg.valueSep = ',';
         return cfg;
     }();
 
@@ -686,7 +686,7 @@ unittest
 
     enum cfg = {
         Config cfg;
-        cfg.arraySep = ',';
+        cfg.valueSep = ',';
         return cfg;
     }();