added emptyLines.*.existingBetweenFields, fixes #455 (#484)

* added emptyLines.*.existingBetweenFields, fixes #455
HaxeCheckstyle · Jun 3, 2019 · 471de7c · 471de7c
1 parent c0be91d
commit 471de7c
Show file tree

Hide file tree

Showing 17 changed files with 242 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## dev branch / next version (1.x.x)
 
 - Added `sameLine.returnBodySingleLine`, fixes [#303](https://github.com/HaxeCheckstyle/haxe-formatter/issues/303) ([#483](https://github.com/HaxeCheckstyle/haxe-formatter/issues/483))
+- Added `emptyLines.*.existingBetweenFields`, fixes [#455](https://github.com/HaxeCheckstyle/haxe-formatter/issues/455) ([#484](https://github.com/HaxeCheckstyle/haxe-formatter/issues/484))
 - Fixed same line handling of if-else with try catch body, fixes [#360](https://github.com/HaxeCheckstyle/haxe-formatter/issues/360) ([#483](https://github.com/HaxeCheckstyle/haxe-formatter/issues/483))
 - Changed `sameLine.returnBody` to only apply to multiline or loop/switch/try/if expressions, fixes [#303](https://github.com/HaxeCheckstyle/haxe-formatter/issues/303) ([#483](https://github.com/HaxeCheckstyle/haxe-formatter/issues/483))
 

diff --git a/resources/default-hxformat.json b/resources/default-hxformat.json
@@ -12,7 +12,8 @@
 			"betweenStaticFunctions": 1,
 			"betweenStaticVars": 0,
 			"betweenVars": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"afterBlocks": "remove",
 		"afterFieldsWithDocComments": "one",
@@ -38,7 +39,8 @@
 			"betweenStaticFunctions": 1,
 			"betweenStaticVars": 0,
 			"betweenVars": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"conditionalsEmptyLines": {
 			"afterElse": 0,
@@ -53,19 +55,22 @@
 			"beginType": 0,
 			"betweenFunctions": 1,
 			"betweenVars": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"enumEmptyLines": {
 			"beginType": 0,
 			"betweenFields": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"externClassEmptyLines": {
 			"afterVars": 0,
 			"beginType": 0,
 			"betweenFunctions": 0,
 			"betweenVars": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"finalNewline": true,
 		"importAndUsing": {
@@ -79,7 +84,8 @@
 			"beginType": 0,
 			"betweenFunctions": 0,
 			"betweenVars": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"lineCommentsBetweenFunctions": "keep",
 		"lineCommentsBetweenTypes": "keep",
@@ -94,13 +100,15 @@
 			"betweenStaticFunctions": 1,
 			"betweenStaticVars": 0,
 			"betweenVars": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		},
 		"maxAnywhereInFile": 1,
 		"typedefEmptyLines": {
 			"beginType": 0,
 			"betweenFields": 0,
-			"endType": 0
+			"endType": 0,
+			"existingBetweenFields": "keep"
 		}
 	},
 	"excludes": [

diff --git a/resources/hxformat-schema.json b/resources/hxformat-schema.json
@@ -168,6 +168,10 @@
 					"type": "integer",
 					"default": 0
 				},
+				"existingBetweenFields": {
+					"$ref": "#/definitions/formatter.config.KeepEmptyLinesPolicy",
+					"default": "keep"
+				},
 				"endType": {
 					"description": "add empty lines before closing \"}\" of type",
 					"type": "integer",
@@ -437,6 +441,10 @@
 					"type": "integer",
 					"default": 1
 				},
+				"existingBetweenFields": {
+					"$ref": "#/definitions/formatter.config.KeepEmptyLinesPolicy",
+					"default": "keep"
+				},
 				"endType": {
 					"description": "add empty lines before closing \"}\" of type",
 					"type": "integer",
@@ -916,6 +924,10 @@
 					"type": "integer",
 					"default": 1
 				},
+				"existingBetweenFields": {
+					"$ref": "#/definitions/formatter.config.KeepEmptyLinesPolicy",
+					"default": "keep"
+				},
 				"endType": {
 					"description": "add empty lines before closing \"}\" of type",
 					"type": "integer",
@@ -1136,6 +1148,10 @@
 					"type": "integer",
 					"default": 0
 				},
+				"existingBetweenFields": {
+					"$ref": "#/definitions/formatter.config.KeepEmptyLinesPolicy",
+					"default": "keep"
+				},
 				"endType": {
 					"description": "add empty lines before closing \"}\" of type",
 					"type": "integer",

diff --git a/src/formatter/config/EmptyLinesConfig.hx b/src/formatter/config/EmptyLinesConfig.hx
@@ -127,6 +127,7 @@ typedef ClassFieldsEmptyLinesConfig = {
 	@:default(1) @:optional var betweenStaticFunctions:Int;
 	@:default(1) @:optional var afterPrivateFunctions:Int;
 	@:default(1) @:optional var betweenFunctions:Int;
+	@:default(Keep) @:optional var existingBetweenFields:KeepEmptyLinesPolicy;
 }
 
 typedef EnumAbstractFieldsEmptyLinesConfig = {
@@ -143,6 +144,7 @@ typedef EnumAbstractFieldsEmptyLinesConfig = {
 	@:default(0) @:optional var betweenVars:Int;
 	@:default(1) @:optional var afterVars:Int;
 	@:default(1) @:optional var betweenFunctions:Int;
+	@:default(Keep) @:optional var existingBetweenFields:KeepEmptyLinesPolicy;
 }
 
 typedef InterfaceFieldsEmptyLinesConfig = {
@@ -159,6 +161,7 @@ typedef InterfaceFieldsEmptyLinesConfig = {
 	@:default(0) @:optional var betweenVars:Int;
 	@:default(0) @:optional var afterVars:Int;
 	@:default(0) @:optional var betweenFunctions:Int;
+	@:default(Keep) @:optional var existingBetweenFields:KeepEmptyLinesPolicy;
 }
 
 typedef TypedefFieldsEmptyLinesConfig = {
@@ -173,6 +176,7 @@ typedef TypedefFieldsEmptyLinesConfig = {
 	@:default(0) @:optional var endType:Int;
 
 	@:default(0) @:optional var betweenFields:Int;
+	@:default(Keep) @:optional var existingBetweenFields:KeepEmptyLinesPolicy;
 }
 
 @:enum

diff --git a/src/formatter/marker/MarkEmptyLines.hx b/src/formatter/marker/MarkEmptyLines.hx
@@ -389,6 +389,12 @@ class MarkEmptyLines extends MarkerBase {
 		if (prevToken == null) {
 			return;
 		}
+		if (conf.existingBetweenFields == Keep) {
+			if (hasEmptyLinesBetweenFields(prevToken, currToken)) {
+				emptyLinesAfterSubTree(prevToken, 1);
+				return;
+			}
+		}
 		if (prevVar != currVar) {
 			// transition between vars and functions
 			emptyLinesAfterSubTree(prevToken, conf.afterVars);
@@ -429,6 +435,25 @@ class MarkEmptyLines extends MarkerBase {
 		}
 	}
 
+	function hasEmptyLinesBetweenFields(prevToken:TokenTree, currToken:TokenTree):Bool {
+		var lastToken:TokenTree = TokenTreeCheckUtils.getLastToken(prevToken);
+		if (lastToken == null) {
+			return false;
+		}
+		var prevLine:Int = parsedCode.getLinePos(lastToken.pos.max).line;
+		var currLine:Int = parsedCode.getLinePos(currToken.pos.min).line;
+		for (emptyLine in parsedCode.emptyLines) {
+			if (prevLine >= emptyLine) {
+				continue;
+			}
+			if (currLine > emptyLine) {
+				return true;
+			}
+			return false;
+		}
+		return false;
+	}
+
 	function markLineCommentsBefore(token:TokenTree, policy:LineCommentEmptyLinePolicy) {
 		if (policy == None) {
 			return;
@@ -539,6 +564,12 @@ class MarkEmptyLines extends MarkerBase {
 		if (prevToken == null) {
 			return;
 		}
+		if (conf.existingBetweenFields == Keep) {
+			if (hasEmptyLinesBetweenFields(prevToken, currToken)) {
+				emptyLinesAfterSubTree(prevToken, 1);
+				return;
+			}
+		}
 		if (prevVar != currVar) {
 			// transition between vars and functions
 			emptyLinesAfterSubTree(prevToken, conf.afterVars);
@@ -658,6 +689,12 @@ class MarkEmptyLines extends MarkerBase {
 				prevToken = child;
 				continue;
 			}
+			if (config.existingBetweenFields == Keep) {
+				if (hasEmptyLinesBetweenFields(prevToken, child)) {
+					emptyLinesAfterSubTree(prevToken, 1);
+					return;
+				}
+			}
 			emptyLinesAfterSubTree(prevToken, config.betweenFields);
 			prevToken = child;
 		}

diff --git a/test/testcases/emptylines/enum_before_fields.hxtest b/test/testcases/emptylines/enum_before_fields.hxtest
@@ -5,7 +5,8 @@
 		"enumEmptyLines": {
 			"beginType": 1,
 			"endType": 1,
-			"betweenFields": 1
+			"betweenFields": 1,
+			"existingBetweenFields": "remove"
 		}
 	}
 }

diff --git a/test/testcases/emptylines/issue_147_between_fields_with_comments.hxtest b/test/testcases/emptylines/issue_147_between_fields_with_comments.hxtest
@@ -1,6 +1,9 @@
 {
 	"emptyLines": {
-		"afterFieldsWithDocComments": "ignore"
+		"afterFieldsWithDocComments": "ignore",
+		"externClassEmptyLines": {
+			"existingBetweenFields": "remove"
+		}
 	}
 }
 

diff --git a/test/testcases/emptylines/issue_188_conditional_fields_doc_comment_ignore.hxtest b/test/testcases/emptylines/issue_188_conditional_fields_doc_comment_ignore.hxtest
@@ -1,7 +1,10 @@
 {
 	"emptyLines": {
 		"beforeDocCommentEmptyLines": "ignore",
-		"afterFieldsWithDocComments": "ignore"
+		"afterFieldsWithDocComments": "ignore",
+		"classEmptyLines": {
+			"existingBetweenFields": "remove"
+		}
 	}
 }
 

diff --git a/test/testcases/emptylines/issue_455_keep_empty_lines_between_fields.hxtest b/test/testcases/emptylines/issue_455_keep_empty_lines_between_fields.hxtest
@@ -0,0 +1,74 @@
+{
+	"emptyLines": {
+		"classEmptyLines": {
+			"betweenFunctions": 0
+		}
+	}
+}
+
+---
+
+class Main {
+	var foo:Int;
+	var foo:Int;
+
+	var foo:Int;
+	static var foo:Int;
+	static var foo:Int;
+
+	static var foo:Int;
+	function main (){}
+	function main (){}
+
+	function main (){}
+}
+
+
+interface Main {
+	var foo:Int;
+	var foo:Int;
+
+	var foo:Int;
+	static var foo:Int;
+	static var foo:Int;
+
+	static var foo:Int;
+	function main ();
+	function main ();
+
+	function main ();
+}
+
+---
+
+class Main {
+	var foo:Int;
+	var foo:Int;
+
+	var foo:Int;
+
+	static var foo:Int;
+	static var foo:Int;
+
+	static var foo:Int;
+
+	function main() {}
+	function main() {}
+
+	function main() {}
+}
+
+interface Main {
+	var foo:Int;
+	var foo:Int;
+
+	var foo:Int;
+	static var foo:Int;
+	static var foo:Int;
+
+	static var foo:Int;
+	function main();
+	function main();
+
+	function main();
+}