added support for final to MagicNumber, fixes #494 (#495)

* added support for final to MagicNumber, fixes #494

Author: AlexHaxe

.gitignore

@@ -8,7 +8,6 @@
 .DS_Store
 *.n
 *.zip
-.haxelib/
 out/
 node_modules
 .DS_Store

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## dev branch / next version (2.x.x)
 
+- Added support for final in `MagicNumber`, fixes [#494](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/494) ([#495](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/495))
+
 ## version 2.6.1 (2019-12-17)
 
 - Added `allowFinal` setting to `VariableInitialisation`, fixes [#491](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/491) ([#492](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/492))

build/Build.hx

@@ -4,6 +4,8 @@ import haxe.Timer;
 	helper class to build everything, avoids `--next`
 **/
 class Build {
+	private static var exitCode:Int = 0;
+
 	/**
 		run all build files
 	**/
@@ -13,6 +15,7 @@ class Build {
 		callLix("buildJS.hxml", "run.js");
 		callLix("buildSchema.hxml", "Json schema");
 		callLix("buildTest.hxml", "Unittests");
+		Sys.exit(exitCode);
 	}
 
 	/**
@@ -23,7 +26,10 @@ class Build {
 	**/
 	public static function callLix(buildFile:String, title:String) {
 		var startTime = Timer.stamp();
-		Sys.command("npx", ["haxe", buildFile]);
+		var result:Int = Sys.command("npx", ["haxe", buildFile]);
 		Sys.println('building $title (${Timer.stamp() - startTime})');
+		if (result != 0) {
+			exitCode = result;
+		}
 	}
 }

src/checkstyle/checks/coding/MagicNumberCheck.hx

@@ -45,7 +45,7 @@ class MagicNumberCheck extends Check {
 
 		for (numberToken in allNumbers) {
 			if (isPosSuppressed(numberToken.pos)) continue;
-			if (!filterNumber(numberToken)) continue;
+			if (filterNumber(numberToken)) continue;
 			switch (numberToken.tok) {
 				case Const(CInt(n)):
 					var number:Int = Std.parseInt(n);
@@ -61,10 +61,16 @@ class MagicNumberCheck extends Check {
 	}
 
 	function filterNumber(token:TokenTree):Bool {
-		if ((token == null) || (token.tok == null)) return true;
+		if ((token == null) || (token.tok == null)) return false;
 		return switch (token.tok) {
-			case At: false;
-			case Kwd(KwdVar): if (token.filter([Kwd(KwdStatic)], FIRST).length > 0) false; else true;
+			case At: true;
+			#if haxe4
+			case Kwd(KwdFinal): true;
+			#else
+			case Const(CIdent("final")): true;
+			#end
+			case BrOpen: false;
+			case Kwd(KwdVar): if (token.filter([Kwd(KwdStatic)], FIRST).length > 0) true; else false;
 			default: filterNumber(token.parent);
 		}
 	}

test/checkstyle/checks/coding/MagicNumberCheckTest.hx

@@ -6,6 +6,7 @@ class MagicNumberCheckTest extends CheckTestCase<MagicNumberCheckTests> {
 		var check = new MagicNumberCheck();
 		assertNoMsg(check, STANDARD_MAGIC_NUMBERS);
 		assertNoMsg(check, ALLOWED_MAGIC_NUMBER);
+		assertNoMsg(check, META_NUMBER);
 	}
 
 	@Test
@@ -43,6 +44,15 @@ class MagicNumberCheckTest extends CheckTestCase<MagicNumberCheckTests> {
 		assertNoMsg(check, ENUM_ABSTRACT_WITH_CLASS);
 		assertNoMsg(check, HAXE4_ENUM_ABSTRACT);
 	}
+
+	#if haxe4
+	@Test
+	public function testFinal() {
+		var check = new MagicNumberCheck();
+		assertNoMsg(check, HAXE4_FINAL_VAR);
+		assertMsg(check, HAXE4_FINAL_FUNCTION, '"7" is a magic number');
+	}
+	#end
 }
 
 @:enum
@@ -118,4 +128,22 @@ abstract MagicNumberCheckTests(String) to String {
 		var BLUE = 94;
 		var MAGENTA = 95;
 	}";
+	var HAXE4_FINAL_VAR = "
+	abstractAndClass Test {
+		static inline final VAL1 = 5;
+		static final VAL2 = 6;
+		final VAL3 = 7;
+	}";
+	var HAXE4_FINAL_FUNCTION = "
+	abstractAndClass Test {
+		final function test() {
+			val = 7;
+		}
+	}";
+	var META_NUMBER = "
+	abstractAndClass Test {
+		@meta(100)
+		function test() {
+		}
+	}";
 }