CodeNarc and Intellij Formatting

compiler.groovy

@@ -1,4 +1,4 @@
 withConfig(configuration) {
-  ast(groovy.transform.CompileStatic)
-  ast(groovy.transform.TypeChecked)
-}
+	ast(groovy.transform.CompileStatic)
+	ast(groovy.transform.TypeChecked)
+}

docs/code-format/Project_Default.xml

@@ -0,0 +1,39 @@
+<component name="InspectionProjectProfileManager">
+    <profile version="1.0">
+        <option name="myName" value="Project Default"/>
+        <inspection_tool class="CodeNarc.BracesForTryCatchFinally" enabled="true" level="WARNING"
+                         enabled_by_default="true">
+            <option name="catchOnSameLineAsClosingBrace" value="true"/>
+            <option name="catchOnSameLineAsOpeningBrace" value="true"/>
+            <option name="finallyOnSameLineAsClosingBrace" value="true"/>
+            <option name="finallyOnSameLineAsOpeningBrace" value="true"/>
+        </inspection_tool>
+        <inspection_tool class="CodeNarc.BuilderMethodWithSideEffects" enabled="false" level="WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.CompileStatic" enabled="false" level="WARNING" enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.DuplicateStringLiteral" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false" editorAttributes="INFO_ATTRIBUTES"/>
+        <inspection_tool class="CodeNarc.FactoryMethodName" enabled="false" level="WARNING" enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.Indentation" enabled="false" level="WEAK WARNING" enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.LineLength" enabled="true" level="WARNING" enabled_by_default="true">
+            <option name="length" value="220"/>
+        </inspection_tool>
+        <inspection_tool class="CodeNarc.NoTabCharacter" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.ParameterCount" enabled="true" level="WARNING" enabled_by_default="true">
+            <option name="maxParameters" value="8"/>
+        </inspection_tool>
+        <inspection_tool class="CodeNarc.PublicMethodsBeforeNonPublicMethods" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.SpaceAfterCommentDelimiter" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.SpaceBeforeCommentDelimiter" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.StaticFieldsBeforeInstanceFields" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.StaticMethodsBeforeInstanceMethods" enabled="false" level="WEAK WARNING"
+                         enabled_by_default="false"/>
+        <inspection_tool class="CodeNarc.ThrowRuntimeException" enabled="false" level="WARNING"
+                         enabled_by_default="false"/>
+    </profile>
+</component>

docs/code-format/code-format.md

@@ -0,0 +1,28 @@
+# Code Formatting Guide
+
+When you open a `.editorconfig` file in IntelliJ IDEA for the first time, you'll see an "Enable EditorConfig support"
+button at the top of the editor. Simply click this button to activate EditorConfig support.
+
+Alternatively, you can enable it manually:
+
+1. Go to Settings/Preferences
+2. Search for "EditorConfig"
+3. Check "Enable EditorConfig support"
+
+Once enabled, the project's `.editorconfig` file will be automatically recognized and its rules will be applied to your
+code.
+
+## Auto-Format on Commit
+
+To ensure consistent code formatting across the project, you can configure IntelliJ to automatically format code before
+committing:
+
+![Format on Commit Configuration](format-commit.png)
+
+## CodeNarc Inspection Profile
+
+To use custom CodeNarc rules in IntelliJ:
+
+![Loading CodeNarc Profile](loadCodeNarcProfile.png)
+
+and load Project_Default.xml 

scripts/jenkins/pluginCheck.groovy

@@ -4,21 +4,19 @@ List expected = []
 
 String input = "${PLUGIN_LIST}"
 input.split(",").toList().stream()
-        .filter { it.split(":")[0] != "prometheus" } // prometheus does not support dynamic loading and will be installed when restarting.
-        .collect()
-        .each { it -> expected.add(it.substring(0, it.indexOf(":"))) }
+	.filter { it.split(":")[0] != "prometheus" } // prometheus does not support dynamic loading and will be installed when restarting.
+	.collect()
+	.each { it -> expected.add(it.substring(0, it.indexOf(":"))) }
 
 Jenkins.instance.pluginManager.failedPlugins.each {
-    available.add(it.name)
+	available.add(it.name)
 }
 
 Jenkins.instance.pluginManager.plugins.each {
-    available.add(it.shortName)
+	available.add(it.shortName)
 }
 
-available.each { p ->
-    if (expected.find { (it == p) })
-        plugins.add(p)
+available.each { p -> if (expected.find { (it == p) }) plugins.add(p)
 }
 
 def commons = plugins.intersect(expected)

src/main/groovy/com/cloudogu/gitops/Application.groovy

@@ -2,67 +2,66 @@ package com.cloudogu.gitops
 
 import com.cloudogu.gitops.config.Config
 import com.cloudogu.gitops.utils.TemplatingEngine
+
+import jakarta.inject.Singleton
+import groovy.util.logging.Slf4j
+
 import freemarker.template.Configuration
 import freemarker.template.DefaultObjectWrapperBuilder
-import groovy.util.logging.Slf4j
-import jakarta.inject.Singleton
 
 @Slf4j
 @Singleton
 class Application {
 
-    final List<Feature> features
-    final Config config
+	final List<Feature> features
+	final Config config
 
-    Application(Config config,
-                List<Feature> features
-    ) {
-        this.config = config
-        // Order is important. Enforced by @Order-Annotation on the Singletons
-        this.features = features
-    }
+	Application(Config config,
+		List<Feature> features) {
+		this.config = config
+		// Order is important. Enforced by @Order-Annotation on the Singletons
+		this.features = features
+	}
 
-    def start() {
-        log.debug("Starting Application")
+	def start() {
+		log.debug("Starting Application")
 
-        setNamespaceListToConfig(config)
+		setNamespaceListToConfig(config)
 
-        features.forEach(feature -> {
-            feature.validate()
-        })
-        features.forEach(feature -> {
-            feature.install()
-        })
-        log.debug("Application finished")
-    }
+		features.forEach(feature -> {
+			feature.validate()
+		})
+		features.forEach(feature -> {
+			feature.install()
+		})
+		log.debug("Application finished")
+	}
 
-    List<Feature> getFeatures() {
-        return features
-    }
+	List<Feature> getFeatures() {
+		return features
+	}
 
-    void setNamespaceListToConfig(Config config) {
-        LinkedHashSet<String> dedicatedNamespaces = new LinkedHashSet<>()
-        LinkedHashSet<String> tenantNamespaces = new LinkedHashSet<>()
-        def engine = new TemplatingEngine()
+	void setNamespaceListToConfig(Config config) {
+		LinkedHashSet<String> dedicatedNamespaces = new LinkedHashSet<>()
+		LinkedHashSet<String> tenantNamespaces = new LinkedHashSet<>()
+		def engine = new TemplatingEngine()
 
-        config.content.namespaces.each { String ns ->
-            tenantNamespaces.add(engine.template(ns, [
-                    config : config,
-                    // Allow for using static classes inside the templates
-                    statics: new DefaultObjectWrapperBuilder(Configuration.VERSION_2_3_32).build().getStaticModels()
-            ]))
-        }
-        config.content.namespaces = tenantNamespaces.toList()
+		config.content.namespaces.each { String ns ->
+			tenantNamespaces.add(engine.template(ns, [config : config,
+			                                          // Allow for using static classes inside the templates
+			                                          statics: new DefaultObjectWrapperBuilder(Configuration.VERSION_2_3_32).build().getStaticModels()]))
+		}
+		config.content.namespaces = tenantNamespaces.toList()
 
-        //iterates over all FeatureWithImages and gets their namespaces
-        dedicatedNamespaces.addAll(this.features
-                .collect { it.activeNamespaceFromFeature }
-                .findAll { it }
-                .unique()
-                .collect { "${it}".toString() })
+		//iterates over all FeatureWithImages and gets their namespaces
+		dedicatedNamespaces.addAll(this.features
+			.collect { it.activeNamespaceFromFeature }
+			.findAll { it }
+			.unique()
+			.collect { "${it}".toString() })
 
-        config.application.namespaces.dedicatedNamespaces = dedicatedNamespaces
-        config.application.namespaces.tenantNamespaces = tenantNamespaces
-        log.debug("Active namespaces retrieved: {}", config.application.namespaces.activeNamespaces)
-    }
+		config.application.namespaces.dedicatedNamespaces = dedicatedNamespaces
+		config.application.namespaces.tenantNamespaces = tenantNamespaces
+		log.debug("Active namespaces retrieved: {}", config.application.namespaces.activeNamespaces)
+	}
 }