Merge pull request #24 from AlexHaxe/leftcurly

added LeftCurlyCheck and EmptyBlockCheck

Author: AlexHaxe

README.md

@@ -79,6 +79,13 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki
 				"severity": "INFO"
 			}
 		},
+		{
+			"type": "EmptyBlock",
+			"props": {
+				"severity": "ERROR",
+				"option": "empty"
+			}
+		},
 		{
 			"type": "EmptyLines",
 			"props": {
@@ -112,6 +119,29 @@ More information in [wiki page](https://github.com/adireddy/haxe-checkstyle/wiki
 				"character": "tab"
 			}
 		},
+		{
+			"type": "LeftCurly",
+			"props": {
+				"severity": "WARNING",
+				"option": "eol",
+				"tokens": [
+					"CLASS_DEF",
+					"ENUM_DEF",
+					"ABSTRACT_DEF",
+					"TYPEDEF_DEF",
+					"CLASS_DEF",
+					"INTERFACE_DEF",
+					"OBJECT_DECL",
+					"FUNCTION",
+					"FOR",
+					"IF",
+					"WHILE",
+					"SWITCH",
+					"TRY",
+					"CATCH"
+				]
+			}
+		},
 		{
 			"type": "LineLength",
 			"props": {

checkstyle/ComplexTypeUtils.hx

@@ -9,7 +9,7 @@ import haxeparser.Data.EnumConstructor;
 import haxe.macro.Expr;
 
 class ComplexTypeUtils {
-	
+
 	public static function walkFile(file:{ pack:Array<String>, decls:Array<TypeDecl> }, cb:ComplexTypeCallback) {
 		for (decl in file.decls) walkTypeDecl(decl, cb);
 	}
@@ -43,7 +43,7 @@ class ComplexTypeUtils {
 	public static function walkClass(d:Definition<ClassFlag, Array<Field>>, pos:Position, cb:ComplexTypeCallback) {
 		walkCommonDefinition(d, pos, cb);
 		for (f in d.flags) {
-			switch f {
+			switch(f) {
 				case HExtends(t) | HImplements(t): walkTypePath(t, d.name, pos, cb);
 				default:
 			}
@@ -64,7 +64,7 @@ class ComplexTypeUtils {
 	public static function walkAbstract(d:Definition<AbstractFlag, Array<Field>>, pos:Position, cb:ComplexTypeCallback) {
 		walkCommonDefinition(d, pos, cb);
 		for (f in d.flags) {
-			switch f {
+			switch(f) {
 				case AFromType(ct) | AToType(ct) | AIsType(ct): walkComplexType(ct, f.getName(), pos, cb);
 				default:
 			}
@@ -133,7 +133,7 @@ class ComplexTypeUtils {
 				if (e != null) walkExpr(e, cb);
 		}
 	}
-	
+
 	public static function walkComplexType(t:ComplexType, name:String, pos:Position, cb:ComplexTypeCallback) {
 		cb(t, name, pos);
 		switch(t){

checkstyle/ExprUtils.hx

@@ -9,7 +9,7 @@ import haxeparser.Data.EnumConstructor;
 import haxe.macro.Expr;
 
 class ExprUtils {
-	
+
 	public static function walkFile(file:{ pack: Array<String>, decls: Array<TypeDecl> }, cb:Expr -> Void) {
 		for (decl in file.decls) walkTypeDecl(decl, cb);
 	}
@@ -43,7 +43,7 @@ class ExprUtils {
 	public static function walkClass(d:Definition<ClassFlag, Array<Field>>, cb:Expr -> Void) {
 		walkCommonDefinition(d, cb);
 		for (f in d.flags) {
-			switch f {
+			switch(f) {
 				case HExtends(t) | HImplements(t): walkTypePath(t,cb);
 				default:
 			}
@@ -64,7 +64,7 @@ class ExprUtils {
 	public static function walkAbstract(d:Definition<AbstractFlag, Array<Field>>, cb:Expr -> Void) {
 		walkCommonDefinition(d, cb);
 		for (f in d.flags) {
-			switch f {
+			switch(f) {
 				case AFromType(ct) | AToType(ct) | AIsType(ct): walkComplexType(ct,cb);
 				default:
 			}
@@ -133,7 +133,7 @@ class ExprUtils {
 				if (e != null) walkExpr(e, cb);
 		}
 	}
-	
+
 	public static function walkComplexType(t:ComplexType, cb:Expr -> Void) {
 		switch(t){
 			case TPath(p): walkTypePath(p, cb);

checkstyle/Report.hx

@@ -23,7 +23,7 @@ class Report {
 		reportFile = File.write("CHECKS.md", false);
 		reportFile.writeString("###Report of default checks on CheckStyle library itself\n\n");
 		#end
-		
+
 		var errors = 0;
 		var warnings = 0;
 		var infos = 0;

checkstyle/checks/AnonymousCheck.hx

@@ -29,15 +29,15 @@ class AnonymousCheck extends Check {
 			}
 		}
 	}
-	
+
 	function checkField(f:Field) {
 		switch(f.kind) {
 			case FVar(TAnonymous(fields), val):
 				error(f.name, f.pos);
 			default:
 		}
 	}
-	
+
 	function checkLocalVars() {
 		ExprUtils.walkFile(checker.ast, function(e) {
 			switch(e.expr){

checkstyle/checks/ArrayInstantiationCheck.hx

@@ -7,7 +7,7 @@ import haxeparser.Data.Token;
 @name("ArrayInstantiation")
 @desc("Checks if the array is instantiated using [], not with new")
 class ArrayInstantiationCheck extends Check {
-	
+
 	override function actualRun() {
 		ExprUtils.walkFile(checker.ast, function(e:Expr) {
 			switch(e.expr){

checkstyle/checks/BlockFormatCheck.hx

@@ -5,7 +5,7 @@ import checkstyle.LintMessage.SeverityLevel;
 @name("BlockFormat")
 @desc("Checks empty blocks and first/last lines of a block")
 class BlockFormatCheck extends Check {
-	
+
 	public var emptyBlockCheck:Bool;
 
 	var firstLineRE:EReg;
@@ -20,6 +20,7 @@ class BlockFormatCheck extends Check {
 
 	override function actualRun() {
 		ExprUtils.walkFile(checker.ast, function(e) {
+			if (isPosSuppressed(e.pos)) return;
 			switch(e.expr){
 				case EBlock([]) | EObjectDecl([]):
 					if (emptyBlockCheck && e.pos.max - e.pos.min > "{}".length) {

checkstyle/checks/CyclomaticComplexityCheck.hx

@@ -22,7 +22,7 @@ class CyclomaticComplexityCheck extends Check {
 			{ severity : "ERROR", complexity : 25 }
 		];
 	}
-	
+
 	override function actualRun() {
 		checker.ast.decls.map(function(type:TypeDecl):Null<Definition<ClassFlag, Array<Field>>> {
 			return switch (type.decl) {
@@ -33,7 +33,7 @@ class CyclomaticComplexityCheck extends Check {
 			return definition != null;
 		}).iter(checkFields);
 	}
-	
+
 	function checkFields(definition:Definition<ClassFlag, Array<Field>>) {
 		definition.data.map(function(field:Field):Null<Target> {
 			return switch (field.kind) {
@@ -46,7 +46,7 @@ class CyclomaticComplexityCheck extends Check {
 			return f != null;
 		}).iter(calculateComplexity);
 	}
-	
+
 	function calculateComplexity(method:Target) {
 		var complexity:Int = 1 + evaluateExpr(method.expr);
 
@@ -61,7 +61,7 @@ class CyclomaticComplexityCheck extends Check {
 
 	// This would not pass the cyclomatic complexity test.
 
-	@SuppressWarnings('checkstyle:CyclomaticComplexity')
+	@SuppressWarnings(['checkstyle:CyclomaticComplexity', 'checkstyle:LeftCurly'])
 	function evaluateExpr(e:Expr):Int {
 		if (e == null || e.expr == null) return 0;
 		return switch(e.expr) {

checkstyle/checks/ERegInstantiationCheck.hx

@@ -13,6 +13,7 @@ class ERegInstantiationCheck extends Check {
 
 	override function actualRun() {
 		ExprUtils.walkFile(checker.ast, function(e) {
+			if (isPosSuppressed(e.pos)) return;
 			switch(e.expr){
 				case ENew(
 					{pack:[], name:"EReg"},

checkstyle/checks/EmptyBlockCheck.hx

@@ -0,0 +1,51 @@
+package checkstyle.checks;
+
+import checkstyle.LintMessage.SeverityLevel;
+import haxe.macro.Expr;
+
+@name("EmptyBlock")
+@desc("Checks empty blocks / object declarations")
+class EmptyBlockCheck extends Check {
+
+	// require comment in empty block / object decl
+	public static inline var TEXT:String = "text";
+	// empty block / object decl can be empty or have comments
+	// if block has no comments, enforces {} notation
+	public static inline var EMPTY:String = "empty";
+
+	public var option:String;
+
+	public function new() {
+		super();
+		option = EMPTY;
+	}
+
+	override function actualRun() {
+		ExprUtils.walkFile(checker.ast, function(e) {
+			if (isPosSuppressed(e.pos)) return;
+			switch(e.expr){
+				case EBlock([]) | EObjectDecl([]):
+					checkEmptyBlock(e);
+				default:
+			}
+		});
+	}
+
+	function checkEmptyBlock(e:Expr) {
+		if ((e == null) || (e.expr == null)) return;
+
+		var block:String = checker.file.content.substring(e.pos.min, e.pos.max);
+		var containsOnlyWS:Bool = (~/\{\s+\}/m.match(block));
+		var containsText:Bool = (~/\{\s*\S.*\S\s*\}/m.match(block));
+
+		if (option == TEXT) {
+			if (!containsText) {
+				logPos("Empty block should contain a comment", e.pos, Reflect.field(SeverityLevel, severity));
+			}
+			return;
+		}
+		if (containsOnlyWS) {
+			logPos("Empty block should be written as {}", e.pos, Reflect.field(SeverityLevel, severity));
+		}
+	}
+}