changed line comment empty line options (#389)

* changed line comment empty line options
* prepare version 1.5.0

CHANGELOG.md

@@ -2,10 +2,12 @@
 
 ## dev branch / next version (1.x.x)
 
+## version 1.5.0 (2019-03-04)
+
 - Added `wrapping.opAddSubChain` ([#370](https://github.com/HaxeCheckstyle/haxe-formatter/issues/370))
 - Added `wrapping.metadataCallParameter` ([#370](https://github.com/HaxeCheckstyle/haxe-formatter/issues/370))
 - Added `emptyLines.macroClassEmptyLines`, fixes [#377](https://github.com/HaxeCheckstyle/haxe-formatter/issues/377) ([#383](https://github.com/HaxeCheckstyle/haxe-formatter/issues/383))
-- Added `emptyLines.lineCommentsBetweenTypes` and `emptyLines.lineCommentsBetweenTypes` to separate line comments from types and functions ([#387](https://github.com/HaxeCheckstyle/haxe-formatter/issues/387))
+- Added `emptyLines.lineCommentsBetweenTypes` and `emptyLines.lineCommentsBetweenTypes` to separate line comments from types and functions ([#387](https://github.com/HaxeCheckstyle/haxe-formatter/issues/387) + [#389](https://github.com/HaxeCheckstyle/haxe-formatter/issues/389))
 - Added `whitespace.addLineCommentSpace` to ensure a space after `//` ([#388](https://github.com/HaxeCheckstyle/haxe-formatter/issues/388))
 - Fixed type parameter constraint with structure type, fixes [#337](https://github.com/HaxeCheckstyle/haxe-formatter/issues/337) ([#349](https://github.com/HaxeCheckstyle/haxe-formatter/issues/349))
 - Fixed wrapping of OpBool chains with null ([#349](https://github.com/HaxeCheckstyle/haxe-formatter/issues/349))

gruntfile.js

@@ -40,7 +40,7 @@ function haxeOptions() {
             hxml: "buildAll.hxml"
 		},
 		test: {
-			hxml: "buildTest.hxml"
+			hxml: "test.hxml"
 		}
     };
 }

haxelib.json

@@ -8,8 +8,8 @@
 		"style"
 	],
 	"description": "A code formatter for Haxe",
-	"version": "1.4.0",
-	"releasenote": "Added wrapping options and support for file header comments - see CHANGELOG for details.",
+	"version": "1.5.0",
+	"releasenote": "Added wrapping for +/- chains and metadata parameter, added empty line options for macro classes, etc. - see CHANGELOG for details.",
 	"contributors": [
 		"AlexHaxe",
 		"Gama11"

package.json

@@ -1,6 +1,6 @@
 {
     "name": "haxe-formatter",
-    "version": "1.4.0",
+    "version": "1.5.0",
     "description": "A code formatter for Haxe",
     "repository": {
         "type": "git",

resources/default-hxformat.json

@@ -80,8 +80,8 @@
 			"betweenVars": 0,
 			"endType": 0
 		},
-		"lineCommentsBetweenFunctions": 1,
-		"lineCommentsBetweenTypes": 1,
+		"lineCommentsBetweenFunctions": "keep",
+		"lineCommentsBetweenTypes": "keep",
 		"macroClassEmptyLines": {
 			"afterPrivateFunctions": 1,
 			"afterPrivateVars": 1,

resources/formatter-schema.json

@@ -555,7 +555,12 @@
 				},
 				"lineCommentsBetweenTypes": {
 					"description": "empty lines for line comments between types",
-					"type": "integer",
+					"type": "string",
+					"enum": [
+						"keep",
+						"one",
+						"none"
+					],
 					"propertyOrder": 6
 				},
 				"abstractEmptyLines": {
@@ -592,7 +597,12 @@
 				},
 				"lineCommentsBetweenFunctions": {
 					"description": "empty lines for line comments between functions",
-					"type": "integer",
+					"type": "string",
+					"enum": [
+						"keep",
+						"one",
+						"none"
+					],
 					"propertyOrder": 7
 				}
 			},

src/formatter/config/EmptyLinesConfig.hx

@@ -34,12 +34,12 @@ typedef EmptyLinesConfig = {
 	/**
 		empty lines for line comments between types
 	**/
-	@:default(1) @:optional var lineCommentsBetweenTypes:Int;
+	@:default(Keep) @:optional var lineCommentsBetweenTypes:LineCommentEmptyLinePolicy;
 
 	/**
 		empty lines for line comments between functions
 	**/
-	@:default(1) @:optional var lineCommentsBetweenFunctions:Int;
+	@:default(Keep) @:optional var lineCommentsBetweenFunctions:LineCommentEmptyLinePolicy;
 
 	/**
 		empty lines between two single line types
@@ -210,3 +210,9 @@ typedef ImportsEmptyLinesConfig = {
 	var FifthLevelPackage = "fifthLevelPackage";
 	var FullPackage = "fullPackage";
 }
+
+@:enum abstract LineCommentEmptyLinePolicy(String) {
+	var Keep = "keep";
+	var One = "one";
+	var None = "none";
+}

src/formatter/marker/MarkEmptyLines.hx

@@ -383,7 +383,7 @@ class MarkEmptyLines extends MarkerBase {
 
 		if (!currVar) {
 			markLineCommentsBefore(currToken, config.emptyLines.lineCommentsBetweenFunctions);
-			markLineCommentsAfter(currToken, config.emptyLines.lineCommentsBetweenFunctions);
+			markLineCommentsAfter(currToken, 1);
 		}
 		prevToken = skipSharpFields(prevToken);
 		if (prevToken == null) {
@@ -429,8 +429,8 @@ class MarkEmptyLines extends MarkerBase {
 		}
 	}
 
-	function markLineCommentsBefore(token:TokenTree, count:Int) {
-		if (count <= 0) {
+	function markLineCommentsBefore(token:TokenTree, policy:LineCommentEmptyLinePolicy) {
+		if (policy == None) {
 			return;
 		}
 		if (token.previousSibling == null) {
@@ -443,7 +443,15 @@ class MarkEmptyLines extends MarkerBase {
 				case CommentLine(_):
 					var prevInfo:Null<TokenInfo> = getPreviousToken(prev);
 					if ((prevInfo == null) || (prevInfo.whitespaceAfter == Newline)) {
-						emptyLinesAfter(prev, count);
+						switch (policy) {
+							case Keep:
+								if (parsedCode.linesBetweenOriginal(prev, token) > 1) {
+									emptyLinesAfter(prev, 1);
+								}
+							case One:
+								emptyLinesAfter(prev, 1);
+							case None:
+						}
 					}
 					return;
 				default:
@@ -712,7 +720,7 @@ class MarkEmptyLines extends MarkerBase {
 		for (type in types) {
 			var newTypeInfo:TypeEmptyLinesInfo = getTypeInfo(type);
 			markLineCommentsBefore(type, config.emptyLines.lineCommentsBetweenTypes);
-			markLineCommentsAfter(type, config.emptyLines.lineCommentsBetweenTypes);
+			markLineCommentsAfter(type, 1);
 			if (prevTypeInfo == null) {
 				prevTypeInfo = newTypeInfo;
 				continue;
@@ -731,7 +739,7 @@ class MarkEmptyLines extends MarkerBase {
 				emptyLines = config.emptyLines.betweenSingleLineTypes;
 			}
 			emptyLinesAfterSubTree(prevTypeInfo.lastToken, emptyLines);
-			markLineCommentsAfter(prevTypeInfo.typeToken, config.emptyLines.lineCommentsBetweenTypes);
+			markLineCommentsAfter(prevTypeInfo.typeToken, 1);
 			prevTypeInfo = newTypeInfo;
 		}
 	}

test/testcases/emptylines/line_comments_between_function.hxtest

@@ -20,8 +20,46 @@ class Main {
 	// }
 }
 
+class Main {
+	var foo;
+	// static function main() {
+	// }
+
+	static function main() {
+	}
+	// static function main() {
+	// }
+	/**
+
+	**/
+	static function main() {
+	}
+
+	// static function main() {
+	// }
+}
+
 ---
 
+class Main {
+	var foo;
+
+	// static function main() {
+	// }
+	static function main() {}
+
+	// static function main() {
+	// }
+
+	/**
+
+	**/
+	static function main() {}
+
+	// static function main() {
+	// }
+}
+
 class Main {
 	var foo;
 

test/testcases/emptylines/line_comments_between_function_no_emptyline.hxtest

@@ -1,6 +1,6 @@
 {
 	"emptyLines" : {
-		"lineCommentsBetweenFunctions" : 0
+		"lineCommentsBetweenFunctions" : "none"
 	}
 }
 
@@ -39,6 +39,7 @@ class Main {
 
 	**/
 	static function main() {}
+
 	// static function main() {
 	// }
 }

test/testcases/emptylines/line_comments_between_types.hxtest

@@ -21,11 +21,9 @@ typedef Main = String;
 ---
 
 // class Main {
-
 class Main {}
 
 // class Main {
-
 typedef Main = String;
 
 // class Main {
@@ -34,7 +32,6 @@ class Main {}
 
 // class Main {
 // }
-
 typedef Main = String;
 
 // class Main {

test/testcases/emptylines/line_comments_between_types_no_emptyline.hxtest

@@ -1,6 +1,6 @@
 {
 	"emptyLines" : {
-		"lineCommentsBetweenTypes" : 0
+		"lineCommentsBetweenTypes" : "none"
 	}
 }
 
@@ -21,8 +21,10 @@ typedef Main = String;
 // class Main {
 // }
 class Main {}
+
 // class Main {
 // }
 typedef Main = String;
+
 // class Main {
 // }

test/testcases/emptylines/line_comments_between_types_no_space.hxtest

@@ -24,11 +24,9 @@ typedef Main = String;
 ---
 
 //class Main {
-
 class Main {}
 
 //class Main {
-
 typedef Main = String;
 
 //class Main {
@@ -37,7 +35,6 @@ class Main {}
 
 //class Main {
 //}
-
 typedef Main = String;
 
 //class Main {

test/testcases/other/mixed_samples_2.hxtest

@@ -51,6 +51,11 @@ class UInt {
     // space in { }
     public function new() { }
 
+    // keep empty lines above
+    // space in { }
+
+    public function new() { }
+
     // leading/trailing space in anon type
     public function peer():{ host:Host, port:Int } {
         var info = socket.peer();
@@ -68,8 +73,19 @@ class UInt {
             sock.close()
         catch(e:Dynamic) { };
     }
+
+
+    // space in catch { }
+
+    public function request() {
+        try
+            sock.close()
+        catch(e:Dynamic) { };
+    }
 }
 
+
+
 ---
 
 class UInt {
@@ -90,13 +106,16 @@ class UInt {
     var children:Array<Xml>;
     var attributeMap:Map<String, String>;
 
+    // keep empty lines above
+    // space in { }
+    public function new() { }
+
     // keep empty lines above
     // space in { }
 
     public function new() { }
 
     // leading/trailing space in anon type
-
     public function peer():{ host:Host, port:Int } {
         var info = socket.peer();
         var host:Host = Type.createEmptyInstance(Host);
@@ -107,6 +126,13 @@ class UInt {
         return { host: host, port: info.port };
     }
 
+    // space in catch { }
+    public function request() {
+        try
+            sock.close()
+        catch (e:Dynamic) { };
+    }
+
     // space in catch { }
 
     public function request() {