Support for flag parameters in comments of a flag

src/tink/cli/DocFormatter.hx

@@ -20,5 +20,5 @@ typedef DocCommand = {
 typedef DocFlag = {
 	aliases:Array<String>,
 	names:Array<String>,
-	doc:String,
+	doc:String
 }

src/tink/cli/Macro.hx

@@ -16,8 +16,6 @@ class Macro {
 	static var infoCache = new TypeMap<ClassInfo>();
 	static var routerCache = new TypeMap<ComplexType>();
 	static var docCache = new TypeMap<Expr>();
-	static var TYPE_STRING = Context.getType('String');
-	static var TYPE_STRINGLY = Context.getType('tink.Stringly');
 
 	public static function build() {
 		switch Context.getLocalType() {
@@ -371,10 +369,6 @@ class Macro {
 
 						// flag is marked as "required" (will be prompted when missing) if there is no default expr
 						var isRequired = field.expr() == null && !field.meta.has(':optional');
-						if(isRequired && !TYPE_STRINGLY.unifiesWith(field.type) && !TYPE_STRING.unifiesWith(field.type)) {
-							var type = field.type.toComplex().toString();
-							field.pos.error('$type is not supported. Please use a custom abstract to handle it. See https://github.com/haxetink/tink_cli#data-types');
-						}
 
 						addFlag(flags, aliases, isRequired);
 

src/tink/cli/doc/DefaultFormatter.hx

@@ -63,6 +63,20 @@ class DefaultFormatter implements DocFormatter<String> {
 		}
 
 		if(spec.flags.length > 0) {
+			function getParamDesc(flag:DocFlag) {
+				return if(flag.doc != null) {
+					var ido = flag.doc.indexOf('@param');
+					if(ido > -1) {
+						var iap = ido + 6;
+						StringTools.trim(flag.doc.substr(iap, flag.doc.indexOf('\n', iap) - iap));
+					} else {
+						"";
+					}
+				} else {
+					"";
+				}
+			}
+
 			function nameOf(flag:DocFlag) {
 				var variants = flag.names.join(', ');
 				if(flag.aliases.length > 0) variants += ', ' + flag.aliases.map(function(a) return '-$a').join(', ');
@@ -71,20 +85,27 @@ class DefaultFormatter implements DocFormatter<String> {
 
 			var maxFlagLength = spec.flags.fold(function(flag, max) {
 				var name = nameOf(flag);
+				name += ' ${getParamDesc(flag)}';
 				if(name.length > max) max = name.length;
 				return max;
 			}, 0);
 
-			function addFlag(name:String, doc:String) {
-				if(doc == null) doc = '';
-				addLine(indent(name.lpad(' ', maxFlagLength) + ' : ' + indent(doc, maxFlagLength + 3).trim(), 6));
+			var ep = ~/^@param.*$/gim;
+			function addFlag(name:String, doc:String, paramDescription:String) {
+				if(doc == null) {
+					doc = '';
+				} else {
+					//Filter out the lines with @param
+					doc = ep.map(doc, function(e : EReg) return "");
+				}
+				addLine(indent(('$name $paramDescription').rpad(' ', maxFlagLength) +  ' : ' + indent(doc, maxFlagLength + 3).trim(), 6));
 			}
 
 			addLine('');
 			addLine('  Flags:');
 
 			for(flag in spec.flags) {
-				addFlag(nameOf(flag), formatDoc(flag.doc));
+				addFlag(nameOf(flag), formatDoc(flag.doc), getParamDesc(flag));
 			}
 		}
 

tests/RunTests.hx

@@ -13,6 +13,7 @@ class RunTests {
 			new TestAliasDisabled(),
 			new TestPrompt(),
 			new TestOptional(),
+			new TestDoc(),
 		])).handle(Runner.exit);
 
 	}

tests/TestDoc.hx

@@ -0,0 +1,56 @@
+package;
+
+import tink.cli.*;
+import tink.Cli;
+import tink.unit.Assert.*;
+import haxe.ds.StringMap;
+
+using tink.CoreApi;
+
+@:asserts
+class TestDoc {
+	public function new() {}
+
+	public function doc() {
+		var command = new FlagDoc();
+
+		var result = 
+		'\n' + 
+		'  Usage: root\n\n' +
+		'  Flags:\n' +
+		'  --name, -n   : No parameter\n' +
+		'  --path, -p <directory>            : Do search in path\n' +
+		'  --unusedParameter, -u <parameter> : Do search in path\n';
+
+		result = StringTools.replace(result, " ", "");
+		asserts.assert(result == StringTools.replace(Cli.getDoc(command, new tink.cli.doc.DefaultFormatter("root")), " ", ""));	
+		return asserts.done();
+	}
+}
+
+class FlagDoc extends DebugCommand {
+
+	/**
+        No parameter
+    **/
+	@:flag('name')	
+	public var name:String = null;
+
+	/**
+        @param <directory>
+        Do search in path
+	**/
+	@:flag('path')	
+	public var path:String = null;
+
+	/**
+        @param <parameter>
+        Do search in path
+        @param unused parameter
+    **/
+	@:flag('unusedParameter')	
+	public var unusedParameter:String = null;
+
+	@:defaultCommand
+	public function run(args:Rest<String>) {}
+}