added extendsConfigPath field to config files, fixes #401 (#407)

* added `extendsConfigPath` field to config files, fixes #401

Author: AlexHaxe

CHANGES.md

@@ -1,4 +1,5 @@
 ## dev branch / next version (2.x.x)
+- Added `extendsConfigPath` field to config files, to allow one level of extension, fixes [#401](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/401) ([#407](https://github.com/HaxeCheckstyle/haxe-checkstyle/issues/407))
 
 ## version 2.2.2
 

gruntfile.js

@@ -15,7 +15,11 @@ module.exports = function(grunt) {
         haxe: haxeOptions(),
 
         zip: {
-            "checkstyle.zip": ["src/**", "resources/sample-config.json", "resources/logo.png", "haxelib.json", "run.n", "README.md"]
+            "checkstyle.zip": [
+                "src/**",
+                "resources/sample-config.json", "resources/logo.png", "resources/codeclimate_pr.png",
+                "haxelib.json", "run.n", "README.md", "CHANGES.md"
+            ]
         }
     });
 

resources/default-config.json

@@ -1,4 +1,5 @@
 {
+	"extendsConfigPath": "",
 	"defineCombinations": [],
 	"defaultSeverity": "INFO",
 	"baseDefines": [],

src/checkstyle/Config.hx

@@ -3,6 +3,7 @@ package checkstyle;
 import checkstyle.CheckMessage.SeverityLevel;
 
 typedef Config = {
+	@:optional var extendsConfigPath:String;
 	@:optional var defaultSeverity:SeverityLevel;
 	// defines that are always added
 	@:optional var baseDefines:Array<String>;

src/checkstyle/Main.hx

@@ -115,22 +115,37 @@ class Main {
 			excludePath = DEFAULT_EXCLUDE_CONFIG;
 		}
 
-		if (configPath != null && FileSystem.exists(configPath) && !FileSystem.isDirectory(configPath)) loadConfig(configPath);
-		else addAllChecks();
+		loadConfig(configPath);
 
 		if (excludePath != null) loadExcludeConfig(excludePath);
-		else start();
+		start();
+	}
+
+	public function loadConfig(path:String) {
+		if (path != null && FileSystem.exists(path) && !FileSystem.isDirectory(path)) {
+			parseAndValidateConfig(Json.parse(File.getContent(path)));
+		}
+		else addAllChecks();
 	}
 
-	function loadConfig(path:String) {
-		var config:Config = Json.parse(File.getContent(path));
+	public function parseAndValidateConfig(config:Config, allowExtend:Bool = true) {
+
 		validateAllowedFields(config, Reflect.fields(getEmptyConfig()), "Config");
 
+		if (allowExtend && !config.extendsConfigPath.isEmpty()) {
+			if (FileSystem.exists(config.extendsConfigPath) && !FileSystem.isDirectory(config.extendsConfigPath)) {
+				parseAndValidateConfig(Json.parse(File.getContent(config.extendsConfigPath)), false);
+			}
+			else failWith('extendsConfig: Failed to load parent configuration file [${config.extendsConfigPath}]');
+		}
+
 		if (config.exclude != null) parseExcludes(config.exclude);
 
-		for (checkConf in config.checks) {
-			var check = createCheck(checkConf);
-			if (check != null) setCheckProperties(check, checkConf, config.defaultSeverity);
+		if (config.checks != null) {
+			for (checkConf in config.checks) {
+				var check = createCheck(checkConf);
+				if (check != null) setCheckProperties(check, checkConf, config.defaultSeverity);
+			}
 		}
 
 		if (config.baseDefines != null) {
@@ -144,10 +159,9 @@ class Main {
 		validateCheckerThreads(config.numberOfCheckerThreads);
 	}
 
-	function loadExcludeConfig(path:String) {
+	public function loadExcludeConfig(path:String) {
 		var config = Json.parse(File.getContent(path));
 		parseExcludes(config);
-		start();
 	}
 
 	function parseExcludes(config:ExcludeConfig) {
@@ -321,6 +335,7 @@ class Main {
 	function getEmptyConfig():Config {
 		return {
 			defaultSeverity: SeverityLevel.INFO,
+			extendsConfigPath: "",
 			numberOfCheckerThreads: 5,
 			baseDefines: [],
 			defineCombinations: [],

src/checkstyle/import.hx

@@ -12,4 +12,5 @@ import checkstyle.token.TokenTree;
 using checkstyle.utils.ArrayUtils;
 using checkstyle.utils.FieldUtils;
 using checkstyle.utils.ExprUtils;
+using checkstyle.utils.StringUtils;
 using StringTools;

src/checkstyle/utils/StringUtils.hx

@@ -13,4 +13,8 @@ class StringUtils {
 		var regex:EReg = ~/(^|[^$])\$(\{|[a-zA-Z0-9_]+)/;
 		return regex.match(s);
 	}
+
+	public static function isEmpty(s:String):Bool {
+		return (s == null) || (s.length <= 0);
+	}
 }

test/TestSuite.hx

@@ -1,20 +1,23 @@
 import checks.CheckTestCase;
 import misc.ThreadTest;
+import misc.ConfigTest;
 import token.TokenTreeBuilderTest;
 import token.TokenTreeBuilderParsingTest;
 import token.verify.VerifyTokenTreeTest;
 
 class TestSuite extends massive.munit.TestSuite {
+
 	public function new() {
 		super();
 
 		CompileTime.importPackage("checks");
 		CompileTime.importPackage("misc");
 
+		add(ConfigTest);
+		add(ThreadTest);
 		add(TokenTreeBuilderTest);
 		add(TokenTreeBuilderParsingTest);
 		add(VerifyTokenTreeTest);
-		add(ThreadTest);
 
 		var tests = CompileTime.getAllClasses(CheckTestCase);
 		for (testClass in tests) add(testClass);

test/misc/ConfigTest.hx

@@ -0,0 +1,24 @@
+package misc;
+
+import massive.munit.Assert;
+
+import checkstyle.Main;
+
+@:access(checkstyle)
+class ConfigTest {
+
+	@Test
+	public function testExtendsConfigPath() {
+		var main:Main = new Main();
+
+		Assert.isNotNull(main.checker.checks);
+		Assert.isTrue(main.checker.checks.length == 0);
+
+		main.parseAndValidateConfig({
+			extendsConfigPath: "checkstyle.json"
+		});
+
+		Assert.isNotNull(main.checker.checks);
+		Assert.isTrue(main.checker.checks.length > 0);
+	}
+}