Merge pull request #198 from HaxeCheckstyle/DefaultComesLast

DefaultComesLast

resources/default-config.json

@@ -68,6 +68,12 @@
 			},
 			"type": "CyclomaticComplexity"
 		},
+		{
+			"props": {
+				"severity": "IGNORE"
+			},
+			"type": "DefaultComesLast"
+		},
 		{
 			"props": {
 				"severity": "IGNORE"

src/checkstyle/checks/coding/DefaultComesLastCheck.hx

@@ -0,0 +1,32 @@
+package checkstyle.checks.coding;
+
+import checkstyle.token.TokenTree;
+
+@name("DefaultComesLast")
+@desc("Check that the `default` is after all the cases in a `switch` statement. Haxe allows `default` anywhere within the `switch` statement. But it is more readable if it comes after the last `case`.")
+class DefaultComesLastCheck extends Check {
+
+	public function new() {
+		super(TOKEN);
+		categories = [Category.STYLE, Category.CLARITY];
+		points = 2;
+	}
+
+	override function actualRun() {
+		var root:TokenTree = checker.getTokenTree();
+		var acceptableTokens:Array<TokenTree> = root.filter([Kwd(KwdSwitch)], ALL);
+
+		for (token in acceptableTokens) {
+			var tokens:Array<TokenTree> = token.filter([Kwd(KwdCase), Kwd(KwdDefault)], ALL);
+			if (tokens[tokens.length - 1].is(Kwd(KwdDefault))) continue;
+
+			var defaultExists = false;
+			for (i in 0 ... tokens.length) {
+				if (tokens[i].is(Kwd(KwdDefault)) && i < tokens.length - 1) {
+					logPos("Default should be last label in the switch", token.pos);
+					continue;
+				}
+			}
+		}
+	}
+}

test/checks/coding/AvoidInlineConditionalsCheckTest.hx

@@ -5,7 +5,7 @@ import checkstyle.checks.coding.AvoidInlineConditionalsCheck;
 class AvoidInlineConditionalsCheckTest extends CheckTestCase<AvoidInlineConditionalsTests> {
 
 	public function testInlineCondition() {
-		assertMsg(new AvoidInlineConditionalsCheck(), TEST1, 'Avoid inline conditionals');
+		assertMsg(new AvoidInlineConditionalsCheck(), TEST1, "Avoid inline conditionals");
 	}
 }
 

test/checks/coding/DefaultComesLastCheckTest.hx

@@ -0,0 +1,62 @@
+package checks.coding;
+
+import checkstyle.checks.coding.DefaultComesLastCheck;
+
+class DefaultComesLastCheckTest extends CheckTestCase<DefaultComesLastCheckTests> {
+
+	static inline var MSG:String = "Default should be last label in the switch";
+
+	public function testFirstDefault() {
+		assertMsg(new DefaultComesLastCheck(), TEST1, MSG);
+	}
+
+	public function testMiddleDefault() {
+		assertMsg(new DefaultComesLastCheck(), TEST2, MSG);
+	}
+
+	public function testLastDefault() {
+		assertNoMsg(new DefaultComesLastCheck(), TEST3);
+	}
+}
+
+@:enum
+abstract DefaultComesLastCheckTests(String) to String {
+	var TEST1 = "
+	abstractAndClass Test {
+
+		function test() {
+			var a =1;
+        	switch(a) {
+        		default: trace('test');
+				case 1:
+                case 4:
+        	}
+		}
+	}";
+
+	var TEST2 = "
+	abstractAndClass Test {
+
+		function test() {
+			var a =1;
+        	switch(a) {
+				case 1:
+				default: trace('test');
+                case 4:
+        	}
+		}
+	}";
+
+	var TEST3 = "
+	abstractAndClass Test {
+
+		function test() {
+			var a =1;
+        	switch(a) {
+				case 1:
+                case 4:
+                default: trace('test');
+        	}
+		}
+	}";
+}