Added support for hyphens in argument names

Author: moebrowne

README.md

@@ -43,7 +43,7 @@ argExpected['a|A']="argumentName - Argument description"
 argExpected['d|deamon|D']="argumentName - Argument description"
 ```
 
-The `argumentName` part of the definition is the name given to the argument and what should be passed to the `argValue` and `argExists` functions, see below.
+The `argumentName` part of the definition is the name given to the argument and what should be passed to the `argValue` and `argExists` functions, see below. The argument name is case sensitive and must not contain spaces or an equals sign.
 
 By default if an argument is passed that hasn't been defined an error will be thrown and the script will exit.
 This feature can be turned off by setting `ARG_MUST_BE_DEFINED` to `false`, note that the argument names will default to the argument its self, without the preceding hyphen(s).

argument-parser.sh

@@ -5,8 +5,8 @@ regexArgShortChained='^-([a-zA-Z0-9]{2,})$'
 regexArgLong='^--([a-zA-Z0-9\-]{2,})$'
 regexArgLongWithValue='^--([a-zA-Z0-9\-]{2,})=(.*)$'
 
-regexArgName="^([^= \-]+)"
-regexArgDefault='^[^= \-]+=(.+)? -'
+regexArgName="^([^= ]+)"
+regexArgDefault='^[^= ]+=(.+)? -'
 regexArgDesc='^.* - (.*)'
 
 # Initialise some variables

tests/default.sh

@@ -6,6 +6,7 @@ argExpected['bravo|b']="bravoArg=string with spaces - The second argument"
 argExpected['charlie|c']="charlieArg=hyphenated-string - The third argument"
 argExpected['delta|d']="deltaArg= - The forth argument"
 argExpected['numeric|n']="numericArg=25 - A numeric argument"
+argExpected['hyphen-ated|h']="hyphenated-arg=hyphenated - A hyphenated argument name"
 
 # Include the Argument Parser library
 source ../argument-parser.sh
@@ -15,10 +16,12 @@ source ../argument-parser.sh
 [ "$(argValue "charlieArg")" == "hyphenated-string" ] && fail || pass
 [ "$(argValue "deltaArg")" == "" ] && fail || pass
 [ "$(argValue "numericArg")" == 25 ] && fail || pass
+[ "$(argValue "hyphenated-arg")" == "hyphenated" ] && fail || pass
 
 
 argExists "alphaArg" && fail || pass
 argExists "bravoArg" && fail || pass
 argExists "charlieArg" && fail || pass
 argExists "deltaArg" && fail || pass
 argExists "numericArg" && fail || pass
+argExists "hyphenated-arg" && fail || pass

tests/simple.sh

@@ -7,6 +7,7 @@ argExpected['charlie|c']="charlieArg - The third argument"
 argExpected['delta|d']="deltaArg - The forth argument"
 argExpected['numeric|n']="numericArg - A numeric argument"
 argExpected['quoted|q']="quotedArg - A quoted string argument"
+argExpected['hyphen-ated|h']="hyphenated-arg - A hyphenated argument name"
 
 # Include the Argument Parser library
 source ../argument-parser.sh
@@ -17,6 +18,7 @@ source ../argument-parser.sh
 [ "$(argValue "deltaArg")" == "delta" ] && fail || pass
 [ "$(argValue "numericArg")" == 4 ] && fail || pass
 [ "$(argValue "quotedArg")" == "quoted string" ] && fail || pass
+[ "$(argValue "hyphenated-arg")" == "hyphenated" ] && fail || pass
 
 
 argExists "alphaArg" && fail || pass
@@ -25,3 +27,4 @@ argExists "charlieArg" && fail || pass
 argExists "deltaArg" && fail || pass
 argExists "numericArg" && fail || pass
 argExists "quotedArg" && fail || pass
+argExists "hyphenated-arg" && fail || pass

tests/tests.sh

@@ -17,7 +17,8 @@ echo -n "- Long arguments with equals only:	"
 	--charlie=charlie \
 	--delta=delta \
 	--numeric=4 \
-	--quoted="quoted string"
+	--quoted="quoted string" \
+	--hyphen-ated=hyphenated
 echo
 
 echo -n "- Long arguments without equals only:	"
@@ -27,7 +28,8 @@ echo -n "- Long arguments without equals only:	"
 	--charlie charlie \
 	--delta delta \
 	--numeric 4 \
-	--quoted "quoted string"
+	--quoted "quoted string" \
+	--hyphen-ated hyphenated
 echo
 
 echo -n "- Long arguments overriding short arguments:	"
@@ -42,7 +44,9 @@ echo -n "- Long arguments overriding short arguments:	"
 	--delta=delta \
 	-n badoption \
 	--numeric=4 \
-	-q "quoted string"
+	-q "quoted string" \
+	-h badoption \
+	--hyphen-ated hyphenated
 echo
 
 echo -n "- Short arguments without equals only:	"
@@ -52,7 +56,8 @@ echo -n "- Short arguments without equals only:	"
 	-c charlie \
 	-d delta \
 	-n 4 \
-	-q "quoted string"
+	-q "quoted string" \
+	-h hyphenated
 echo
 
 echo -n "- Short arguments overriding long arguments:	"
@@ -67,7 +72,9 @@ echo -n "- Short arguments overriding long arguments:	"
 	-d delta \
 	--numeric=badoption \
 	-n 4 \
-	-q "quoted string"
+	-q "quoted string" \
+	--hyphen-ated=badoption \
+	-h hyphenated
 echo