Merge pull request #3 from adireddy/dev

Dev

Author: Adi

checkstyle/checks/ReturnCheck.hx

@@ -9,6 +9,7 @@ import haxe.macro.Expr;
 class ReturnCheck extends Check {
 
 	public var severity:String = "INFO";
+	public var allowEmptyReturn:Bool = true;
 
 	override function _actualRun() {
 		for (td in _checker.ast.decls) {
@@ -30,6 +31,7 @@ class ReturnCheck extends Check {
 		if (Std.string(f.kind).indexOf("ret => TPath({ name => Void") > -1) {
 			_warnVoid(f.name, f.pos);
 		}
+		if (allowEmptyReturn && Std.string(f.kind).indexOf("EReturn(null)") > -1) return;
 		if (Std.string(f.kind).indexOf("expr => EReturn") > -1 && Std.string(f.kind).indexOf("ret => null") > -1) {
 			_warnNoReturnType(f.name, f.pos);
 		}

haxelib.json

@@ -10,8 +10,8 @@
 	],
 	"description": "Automated code analysis ideal for projects that want to enforce a coding standard.",
 	"contributors": ["adireddy"],
-	"releasenote": "added ignoreRangeOperator config for SpacingCheck",
-	"version": "1.0.5",
+	"releasenote": "added allowEmptyReturn config for ReturnCheck",
+	"version": "1.0.6",
 	"url": "https://github.com/adireddy/haxe-checkstyle",
 	"dependencies": {
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "checkstyle",
-	"version": "1.0.5",
+	"version": "1.0.6",
 	"description": "Automated code analysis ideal for projects that want to enforce a coding standard.",
 	"repository": {
 		"type": "git",

resources/config.json

@@ -55,7 +55,12 @@
 			"type": "ListenerName",
 			"props": {
 				"severity": "ERROR",
-				"listeners": ["addEventListener", "addListener", "on", "once"]
+				"listeners": [
+					"addEventListener",
+					"addListener",
+					"on",
+					"once"
+				]
 			}
 		},
 		{
@@ -87,7 +92,8 @@
 		{
 			"type": "Return",
 			"props": {
-				"severity": "INFO"
+				"severity": "INFO",
+				"allowEmptyReturn": true
 			}
 		},
 		{

run.n

@@ -11,7 +11,12 @@ class ReturnCheckTest extends CheckTestCase {
 
 	public function testNoReturnType() {
 		var msg = checkMessage(ReturnTests.TEST2, new ReturnCheck());
-		assertEquals(msg, 'Return type not specified when returning a value for function: test');
+		assertEquals(msg, 'Return type not specified when returning a value for function: test1');
+	}
+
+	public function testEmptyReturnType() {
+		var msg = checkMessage(ReturnTests.TEST3, new ReturnCheck());
+		assertEquals(msg, '');
 	}
 }
 
@@ -23,8 +28,15 @@ class ReturnTests {
 
 	public static inline var TEST2:String =
 	"class Test {
-		public function test() {
+		public function test1() {
 			return 0;
 		}
 	}";
+
+	public static inline var TEST3:String =
+	"class Test {
+		public function test2() {
+			return;
+		}
+	}";
 }