Feature/1135 formatter naming conventions

.github/workflows/format-action.yml

@@ -3,7 +3,7 @@ name: 'Format'
 on: [push]
 jobs:
 
-  Frontend:
+  frontend:
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -15,33 +15,19 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 22.10.0
+          node-version: ${{vars.NODE_VERSION}}
 
       - name: Npm install
         run: npm ci
 
       - name: Format frontend
-        run: npm run format
+        run: npm run check-linting:all
 
-      - name: Commit and Push formated frontend
-        shell: bash
-        env:
-          COMMITPREFIX: '[FM]'
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "GitHub Actions"
-          git add . || {
-            echo "No files were changed, so we did not commit anything"
-            exit 1
-          }
-          git commit -m "$COMMITPREFIX Automated formating frontend" || {
-            echo "No changes to commit, skipping push"
-            exit 0
-          }
-          git push -f
-
-  Backend:
+  backend:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: backend
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -55,21 +41,4 @@ jobs:
           settings-path: ${{github.workspace}}
 
       - name: Format backend
-        run: mvn formatter:format -f backend/pom.xml
-
-      - name: Commit and Push formated backend
-        shell: bash
-        env:
-          COMMITPREFIX: '[FM]'
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "GitHub Actions"
-          git add . || {
-            echo "No files were changed, so we did not commit anything"
-            exit 1
-          }
-          git commit -m "$COMMITPREFIX Automated formating backend" || {
-            echo "No changes to commit, skipping push"
-            exit 0
-          }
-          git push -f
+        run: mvn spotless:check

backend/README.md

@@ -33,17 +33,23 @@ USING DOCKER
   - backend/target
 
 Formatting:
-- Check code formatting: `mvn formatter:validate`
-- Format the code: `mvn formatter:format`
+- Check code formatting: `mvn spotless:check`
+- Format the code: `mvn spotless:apply`
 
-The `compile` goal execute also a `formatter:format` goal.
+We also run the formatter with `spotless:apply` in the `compile` goal.
 
 Verify the Backend for coverage check:
 - `mvn clean verify`
 
 ## Formatting
-We use the **formatter-maven-plugin** Plugin for formatting the Java code:
-https://code.revelc.net/formatter-maven-plugin/
-
+We use the ***spotless*** Plugin for formatting the Java code:
+https://github.com/diffplug/spotless
+
+### How to update the spotless configuration using intelij:
+- Open `Go to Settings -> Editor -> Code styles -> Java` 
+- Select the default project config and export it to a file
+- Then make the changes you want to the code style config ***HIT APPLY*** and then export it to a file
+- Then run the following command `git --no-pager diff --no-index -U0 default.xml changed.xml | egrep '^\+' | diff-so-fancy` to see the changes
+- then copy all additions to the formatter file in the backend project
 ## Build
 _tbd_

backend/pom.xml

@@ -231,24 +231,29 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>3.5.2</version>
             </plugin>
-
             <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-                <version>2.24.1</version>
-                <configuration>
-                    <compilerSource>${maven.compiler.source}</compilerSource>
-                    <compilerCompliance>${maven.compiler.source}</compilerCompliance>
-                    <compilerTargetPlatform>${maven.compiler.source}</compilerTargetPlatform>
-                </configuration>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.43.0</version>
                 <executions>
                     <execution>
                         <id>code-format</id>
                         <goals>
-                            <goal>format</goal>
+                            <goal>apply</goal>
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <java>
+                        <eclipse>
+                            <version>4.26</version>
+                            <file>${project.basedir}/src/main/resources/formatting.xml</file>
+<!--                            <file>${project.basedir}/src/main/resources/formatters/default.xml</file>-->
+                        </eclipse>
+                        <removeUnusedImports />
+                        <importOrder />
+                    </java>
+                </configuration>
             </plugin>
         </plugins>
     </build>
@@ -305,9 +310,9 @@
             <build>
                 <plugins>
                     <plugin>
-                        <groupId>net.revelc.code.formatter</groupId>
-                        <artifactId>formatter-maven-plugin</artifactId>
-                        <version>2.24.1</version>
+                        <groupId>com.diffplug.spotless</groupId>
+                        <artifactId>spotless-maven-plugin</artifactId>
+                        <version>2.43.0</version>
                         <executions>
                             <execution>
                                 <id>code-format</id>

backend/src/main/resources/formatting.xml

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<profiles version="21">
+	<profile name="CustomFormatter" kind="CodeFormatterProfile">
+		<setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
+		<setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/>
+		<setting id="org.eclipse.jdt.core.formatter.lineSplit" value="120"/>
+		<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_annotation_on_method" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.align_annotation_array_initializer_expressions" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.align_parameters_in_columns" value="false"/>
+		<setting id="org.eclipse.jdt.core.formatter.align_arguments_in_columns" value="false"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation" value="48"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="16"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="2"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="2"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="2"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="2"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression" value="2"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiplicative_operator" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_additive_operator" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_string_concatenation" value="18"/>
+
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_shift_operator" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_relational_operator" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_bitwise_operator" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_logical_operator" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="16"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression_chain" value="48"/>
+		<setting id="org.eclipse.jdt.core.formatter.wrap_before_conditional_operator" value="true"/>
+
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="18"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="82"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="82"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="82"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression" value="82"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/>
+
+
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_type_annotation" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_label" value="insert"/>
+<!--		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter" value="insert"/>-->
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_enum_constant" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_annotation_declaration" value="insert"/>
+
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_field" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_type" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_enum_constant" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotation_on_method" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_package" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_annotations" value="49"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_local_variable" value="49"/>
+<!--scho mau fine-->
+
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_delcaration" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_invocation" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_enum_constant_declaration" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_record_declaration" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_annotation" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_lambda_declaration" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_if_while_statement" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_for_statment" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_switch_statement" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_try_clause" value="common_lines"/>
+		<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_catch_clause" value="common_lines"/>
+
+		<setting id="org.eclipse.jdt.core.formatter.keep_lambda_body_block_on_one_line" value="one_line_preserve"/>
+
+		<setting id="org.eclipse.jdt.core.formatter.keep_method_body_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_simple_getter_setter_on_one_line" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_type_declaration_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_anonymous_type_declaration_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_enum_declaration_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_enum_constant_declaration_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_record_declaration_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_record_constructor_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.keep_annotation_declaration_on_one_line" value="one_line_preserve"/>
+		<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_parameter" value="16"/>
+
+		<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="true"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert"/>
+		<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer" value="do not insert"/>
+
+	</profile>
+</profiles>

frontend/.prettierignore

@@ -1,3 +1,6 @@
 src/assets/
 dist/
 .angular/
+# The following files alredy getting formatting by eslint
+**/*.html
+**/*.ts

frontend/.prettierrc

@@ -0,0 +1,6 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 2,
+    "semi": false,
+    "singleQuote": true,
+}

frontend/README.md

@@ -30,9 +30,16 @@ Build:
 
 ## Formatting
 
-We use the **prettier** code formatter for the frontend code:
-https://www.npmjs.com/package/prettier
 
+We use **EsLint** and a variety of plugins to format html and ts files:
+https://eslint.org/
+
+We use **prettier** to format scss json and yaml files:
+https://prettier.io/
+
+If you get a does not match pattern error, it is likely because of the custom words for the OKR tool
+here is a regex101 project that showcases how the regex works:
+https://regex101.com/r/VUyAt6/1
 ## Test Coverage
 
 For generating the coverage of our frontend specs (jest), you can use following command:
@@ -44,16 +51,16 @@ Open the html file in browser and you get a beautiful overview
 ## Cypress Tests
 
 - local setup
-  - start local Docker `docker-compose up`
-  - start local Server: `OkrApplication-E2E`
-  - start local Client: `npm run start`
+    - start local Docker `docker-compose up`
+    - start local Server: `OkrApplication-E2E`
+    - start local Client: `npm run start`
 - run selected Tests
-  - npm run `npm run cypress:open`
-  - in Cypress App, select `E2E Testing` and `Chrome` as Browser
+    - npm run `npm run cypress:open`
+    - in Cypress App, select `E2E Testing` and `Chrome` as Browser
 - run all tests
-  - npm run `npm run cypress:run`
-  - in Cypress App, select `E2E Testing` and `Chrome` as Browser
+    - npm run `npm run cypress:run`
+    - in Cypress App, select `E2E Testing` and `Chrome` as Browser
 - in case of failing Tests:
-  - stop and restart local Server
-  - stop and restart local Client
-  - re-run Cypress Tests
+    - stop and restart local Server
+    - stop and restart local Client
+    - re-run Cypress Tests

frontend/angular.json

@@ -131,12 +131,18 @@
               "devServerTarget": "frontend:serve:production"
             }
           }
+        },
+        "lint": {
+          "builder": "@angular-eslint/builder:lint",
+          "options": {
+            "lintFilePatterns": ["src/**/*.ts", "src/**/*.html"]
+          }
         }
       }
     }
   },
   "cli": {
     "analytics": false,
-    "schematicCollections": ["@cypress/schematic", "@schematics/angular"]
+    "schematicCollections": ["angular-eslint", "@cypress/schematic", "@schematics/angular"]
   }
 }