code-cleanup and reformat

Author: hohwille

.editorconfig

@@ -113,7 +113,7 @@ ij_java_for_statement_wrap = normal
 ij_java_generate_final_locals = false
 ij_java_generate_final_parameters = false
 ij_java_if_brace_force = always
-ij_java_imports_layout = *, |, java.**, javax.**, jakarta.**, |, org.**, |, net.**, |, com.**, |, $*
+ij_java_imports_layout = $*, |, java.**, javax.**, jakarta.**, javafx.**, |, org.**, |, net.**, |, com.**, |, *
 ij_java_indent_case_from_switch = true
 ij_java_insert_inner_class_imports = true
 ij_java_insert_override_annotation = true
@@ -178,7 +178,7 @@ ij_java_space_after_comma_in_type_arguments = true
 ij_java_space_after_for_semicolon = true
 ij_java_space_after_quest = true
 ij_java_space_after_type_cast = true
-ij_java_space_before_annotation_array_initializer_left_brace = true
+ij_java_space_before_annotation_array_initializer_left_brace = false
 ij_java_space_before_annotation_parameter_list = false
 ij_java_space_before_array_initializer_left_brace = true
 ij_java_space_before_catch_keyword = true

.github/stale.yml

@@ -8,7 +8,7 @@ daysUntilStale: 30
 daysUntilClose: 7
 
 # Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
-onlyLabels: []
+onlyLabels: [ ]
 
 # Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
 exemptLabels:

.github/workflows/build.yml

@@ -1,5 +1,5 @@
 name: CI build
-on: 
+on:
   push:
     paths-ignore:
       - 'documentation/**'

.github/workflows/nightly-build.yml

@@ -1,9 +1,9 @@
 name: Nightly Build
 on:
-   workflow_dispatch:
-   schedule:
-   - cron: '0 2 * * *'
-    
+  workflow_dispatch:
+  schedule:
+    - cron: '0 2 * * *'
+
 jobs:
   verify_commit:
     runs-on: ubuntu-latest
@@ -24,7 +24,7 @@ jobs:
     if: ${{ needs.verify_commit.outputs.RUN_BUILD == 'true' }}
     strategy:
       matrix:
-        os: [windows-latest, ubuntu-latest, macos-latest, macos-13]
+        os: [ windows-latest, ubuntu-latest, macos-latest, macos-13 ]
 
     steps:
       - uses: actions/checkout@v3
@@ -48,7 +48,7 @@ jobs:
 
   build:
     name: Build Project and Deploy
-    needs: [build-natives, verify_commit]
+    needs: [ build-natives, verify_commit ]
     if: ${{ needs.verify_commit.outputs.RUN_BUILD == 'true' }}
     runs-on: ubuntu-latest
     steps:
@@ -61,7 +61,7 @@ jobs:
         with:
           java-version: '17'
       - uses: actions/download-artifact@v3
-      - name: Make natives available and build project 
+      - name: Make natives available and build project
         run: |
           mvn -B -ntp -Dstyle.color=always install
           mv ./natives/* ./cli/target/
@@ -93,4 +93,4 @@ jobs:
             exit 1
           else
             echo "The last workflow succeeded. This workflow will succeed."
-          fi
+          fi

README.adoc

@@ -6,44 +6,52 @@ image::documentation/images/logo.png["Logo",align="center",width=60%]
 
 Tool to automate the setup and updates of a development environment for any project (Successor of https://github.com/devonfw/ide[devonfw-ide]).
 
-image:https://img.shields.io/github/license/devonfw/IDEasy.svg?label=License["Apache License, Version 2.0",link=https://github.com/devonfw/IDEasy/blob/master/LICENSE]
+image:https://img.shields.io/github/license/devonfw/IDEasy.svg?label=License["Apache License,Version 2.0",link=https://github.com/devonfw/IDEasy/blob/master/LICENSE]
 image:https://img.shields.io/maven-central/v/com.devonfw.tools.IDEasy/ide-cli.svg?label=Maven%20Central["Maven Central",link=https://search.maven.org/search?q=g:com.devonfw.tools.IDEasy+a:ide-cli]
 image:https://github.com/devonfw/IDEasy/actions/workflows/build.yml/badge.svg["Build Status",link="https://github.com/devonfw/IDEasy/actions/workflows/build.yml"]
 image:https://github.com/devonfw/IDEasy/actions/workflows/update-urls.yml/badge.svg["Update URLS Status",link="https://github.com/devonfw/IDEasy/actions/workflows/update-urls.yml"]
-image:https://github.com/devonfw/IDEasy/actions/workflows/nightly-build.yml/badge.svg["Nightly Release", link="https://github.com/devonfw/IDEasy/actions/workflows/nightly-build.yml"]
+image:https://github.com/devonfw/IDEasy/actions/workflows/nightly-build.yml/badge.svg["Nightly Release",link="https://github.com/devonfw/IDEasy/actions/workflows/nightly-build.yml"]
 image:https://coveralls.io/repos/github/devonfw/IDEasy/badge.svg?branch=main["Coverage Status",link="https://coveralls.io/github/devonfw/IDEasy?branch=main"]
 
 toc::[]
 
 == Pitch
+
 With IDEasy you can create a very small git repo with the configuration of the dev environment of your software project.
 Developers can then setup your project using IDEasy with a single CLI command on Windows, Mac, or Linux and get all the tools needed for your project in the configured version and tailored to the projects demands.
 
 No more manual steps to install and configure, no diff-wars, no more dev setup manuals, no more "its not working on my machine"!
 
 Among many link:documentation/alternatives.adoc[alternatives] we believe IDEasy is the best solution for project centric software development needs esp. with its link:documentation/sandbox.adoc[sandbox concept].
 
-Not yet convinced? See link:documentation/features.adoc[features].
+Not yet convinced?
+See link:documentation/features.adoc[features].
 
 == Setup
 
 === Prerequisites
+
 All you need before installing IDEasy is https://git-scm.com/download/[git].
 
 === Install
+
 Download the latest version of `IDEasy` from https://github.com/devonfw/IDEasy/releases[here] and install it.
 (You can find all Releases in https://repo.maven.apache.org/maven2/com/devonfw/tools/IDEasy/ide-cli/[Maven Central])
 
 === Create projects
+
 Once installed, you can setup a new project with the following command:
+
 ```
 ide create «project-name» [«settings-git-url»]
 ```
+
 If you do not have a `«settings-git-url»`, you can omit it to setup a standard Java project as demo.
 
 ==== Video Tutorial
+
 ifdef::env-github[]
-image:https://img.youtube.com/vi/NG6TAmksBGI/0.jpg[link=https://www.youtube.com/watch?v=NG6TAmksBGI, width=640, height =360]
+image:https://img.youtube.com/vi/NG6TAmksBGI/0.jpg[link=https://www.youtube.com/watch?v=NG6TAmksBGI, width=640,height =360]
 endif::[]
 
 ifndef::env-github[]
@@ -69,9 +77,11 @@ See also our latest video https://vimeo.com/808368450/88d4af9d18[devon ide updat
 * link:documentation/[Documentation]
 
 == Contribution Guidelines
+
 *If you want to contribute to `IDEasy` please read our https://github.com/devonfw/IDEasy/blob/main/documentation/IDEasy-contribution-getting-started.adoc[Contribution Guidelines].*
 
 *We use https://github.com/devonfw/IDEasy/issues[GitHub Issues] to track bugs and submit feature requests.*
 
 == License 
+
 * link:./LICENSE[License]

cli/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
     <groupId>com.devonfw.tools.IDEasy.dev</groupId>

cli/src/main/assembly/release.xml

@@ -7,7 +7,7 @@
   </formats>
   <includeBaseDirectory>false</includeBaseDirectory>
   <fileSets>
-     <fileSet>
+    <fileSet>
       <directory>${project.build.directory}</directory>
       <outputDirectory>./bin</outputDirectory>
       <includes>

cli/src/main/java/com/devonfw/tools/ide/cli/CliException.java

@@ -1,9 +1,8 @@
 package com.devonfw.tools.ide.cli;
 
 /**
- * {@link RuntimeException} for to abort CLI process in expected situations. It allows to abort with a defined message
- * for the end user and a defined exit code. Unlike other exceptions a {@link CliException} is not treated as technical
- * error. Therefore by default (unless in debug mode) no stacktrace is printed.
+ * {@link RuntimeException} for to abort CLI process in expected situations. It allows to abort with a defined message for the end user and a defined exit code.
+ * Unlike other exceptions a {@link CliException} is not treated as technical error. Therefore by default (unless in debug mode) no stacktrace is printed.
  */
 public class CliException extends RuntimeException {
 

cli/src/main/java/com/devonfw/tools/ide/cli/Ideasy.java

@@ -39,8 +39,7 @@ private IdeContext context() {
   }
 
   /**
-   * Non-static variant of {@link #main(String...) main method} without invoking {@link System#exit(int)} so it can be
-   * tested.
+   * Non-static variant of {@link #main(String...) main method} without invoking {@link System#exit(int)} so it can be tested.
    *
    * @param args the command-line arguments.
    * @return the exit code.
@@ -66,11 +65,11 @@ public int run(String... args) {
         title = error.getClass().getSimpleName() + ": " + title;
       }
       String message = "An unexpected error occurred!\n" //
-              + "We are sorry for the inconvenience.\n" //
-              + "Please check the error below, resolve it and try again.\n" //
-              + "If the error is not on your end (network connectivity, lack of permissions, etc.) please file a bug:\n" //
-              + "https://github.com/devonfw/ide/issues/new?assignees=&labels=bug&projects=&template=bug.md&title="
-              + URLEncoder.encode(title, StandardCharsets.UTF_8);
+          + "We are sorry for the inconvenience.\n" //
+          + "Please check the error below, resolve it and try again.\n" //
+          + "If the error is not on your end (network connectivity, lack of permissions, etc.) please file a bug:\n" //
+          + "https://github.com/devonfw/ide/issues/new?assignees=&labels=bug&projects=&template=bug.md&title="
+          + URLEncoder.encode(title, StandardCharsets.UTF_8);
       context().error(error, message);
     }
     return exitStatus;

cli/src/main/java/com/devonfw/tools/ide/commandlet/AbstractUpdateCommandlet.java

@@ -1,5 +1,11 @@
 package com.devonfw.tools.ide.commandlet;
 
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
 import com.devonfw.tools.ide.context.GitContext;
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.property.FlagProperty;
@@ -10,12 +16,6 @@
 import com.devonfw.tools.ide.tool.ToolCommandlet;
 import com.devonfw.tools.ide.variable.IdeVariables;
 
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
 /**
  * Abstract {@link Commandlet} base-class for both {@link UpdateCommandlet} and {@link CreateCommandlet}.
  */
@@ -46,7 +46,7 @@ public void run() {
     updateSettings();
     updateConf();
 
-    if (skipTools.isTrue()) {
+    if (this.skipTools.isTrue()) {
       this.context.info("Skipping installation/update of tools as specified by the user.");
     } else {
       updateSoftware();

cli/src/main/java/com/devonfw/tools/ide/commandlet/BuildCommandlet.java

@@ -1,5 +1,12 @@
 package com.devonfw.tools.ide.commandlet;
 
+import static com.devonfw.tools.ide.variable.IdeVariables.GRADLE_BUILD_OPTS;
+import static com.devonfw.tools.ide.variable.IdeVariables.MVN_BUILD_OPTS;
+import static com.devonfw.tools.ide.variable.IdeVariables.NPM_BUILD_OPTS;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
 import com.devonfw.tools.ide.cli.CliException;
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.property.StringProperty;
@@ -8,13 +15,6 @@
 import com.devonfw.tools.ide.tool.mvn.Mvn;
 import com.devonfw.tools.ide.tool.npm.Npm;
 
-import java.nio.file.Files;
-import java.nio.file.Path;
-
-import static com.devonfw.tools.ide.variable.IdeVariables.GRADLE_BUILD_OPTS;
-import static com.devonfw.tools.ide.variable.IdeVariables.MVN_BUILD_OPTS;
-import static com.devonfw.tools.ide.variable.IdeVariables.NPM_BUILD_OPTS;
-
 /**
  * Build tool {@link Commandlet} for automatically detecting build configuration files and running the respective tool.
  */

cli/src/main/java/com/devonfw/tools/ide/commandlet/Commandlet.java

@@ -1,19 +1,19 @@
 package com.devonfw.tools.ide.commandlet;
 
-import com.devonfw.tools.ide.context.IdeContext;
-import com.devonfw.tools.ide.nls.NlsBundle;
-import com.devonfw.tools.ide.property.KeywordProperty;
-import com.devonfw.tools.ide.property.Property;
-import com.devonfw.tools.ide.tool.ToolCommandlet;
-import com.devonfw.tools.ide.version.VersionIdentifier;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.nls.NlsBundle;
+import com.devonfw.tools.ide.property.KeywordProperty;
+import com.devonfw.tools.ide.property.Property;
+import com.devonfw.tools.ide.tool.ToolCommandlet;
+import com.devonfw.tools.ide.version.VersionIdentifier;
+
 /**
  * A {@link Commandlet} is a sub-command of the IDE CLI.
  */
@@ -79,8 +79,7 @@ public void clearProperties() {
   }
 
   /**
-   * @param nameOrAlias the potential {@link Property#getName() name} or {@link Property#getAlias() alias} of the
-   *                    requested {@link Property}.
+   * @param nameOrAlias the potential {@link Property#getName() name} or {@link Property#getAlias() alias} of the requested {@link Property}.
    * @return the requested {@link Property property} or {@code null} if not found.
    */
   public Property<?> getOption(String nameOrAlias) {
@@ -112,7 +111,7 @@ protected void addKeyword(Property<?> property) {
   }
 
   /**
-   * @param <P>      type of the {@link Property}.
+   * @param <P> type of the {@link Property}.
    * @param property the {@link Property} to register.
    * @return the given {@link Property}.
    */
@@ -165,7 +164,7 @@ public String getKeyword() {
   }
 
   /**
-   * @param <C>            type of the {@link Commandlet}.
+   * @param <C> type of the {@link Commandlet}.
    * @param commandletType the {@link Class} reflecting the requested {@link Commandlet}.
    * @return the requested {@link Commandlet}.
    * @see CommandletManager#getCommandlet(Class)
@@ -203,10 +202,10 @@ public boolean isSuppressStepSuccess() {
   }
 
   /**
-   * @return {@code true} if the output of this commandlet is (potentially) processed automatically from outside, {@code false} otherwise.
-   * For example {@link CompleteCommandlet} logs the suggestions for auto-completion to a bash script. Also the {@link EnvironmentCommandlet}
-   * logs the environment variables for the {@code ide} wrapper script. In such scenarios these logs shall not be spammed
-   * with warnings like "IDE_ROOT is not set" that would break the processing of the output.
+   * @return {@code true} if the output of this commandlet is (potentially) processed automatically from outside, {@code false} otherwise. For example
+   * {@link CompleteCommandlet} logs the suggestions for auto-completion to a bash script. Also the {@link EnvironmentCommandlet} logs the environment variables
+   * for the {@code ide} wrapper script. In such scenarios these logs shall not be spammed with warnings like "IDE_ROOT is not set" that would break the
+   * processing of the output.
    */
   public boolean isProcessableOutput() {
 

cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManager.java

@@ -26,9 +26,8 @@ public interface CommandletManager {
 
   /**
    * @param keyword the first keyword argument.
-   * @return a {@link Commandlet} having the first {@link Property} {@link Property#isRequired() required} and a
-   *         {@link KeywordProperty} with the given {@link Property#getName() name} or {@code null} if no such
-   *         {@link Commandlet} is registered.
+   * @return a {@link Commandlet} having the first {@link Property} {@link Property#isRequired() required} and a {@link KeywordProperty} with the given
+   * {@link Property#getName() name} or {@code null} if no such {@link Commandlet} is registered.
    */
   Commandlet getCommandletByFirstKeyword(String keyword);
 

cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManagerImpl.java

@@ -1,5 +1,11 @@
 package com.devonfw.tools.ide.commandlet;
 
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.property.KeywordProperty;
 import com.devonfw.tools.ide.property.Property;
@@ -33,12 +39,6 @@
 import com.devonfw.tools.ide.tool.tomcat.Tomcat;
 import com.devonfw.tools.ide.tool.vscode.Vscode;
 
-import java.util.Collection;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
 /**
  * Implementation of {@link CommandletManager}.
  */

cli/src/main/java/com/devonfw/tools/ide/commandlet/CompleteCommandlet.java

@@ -1,13 +1,13 @@
 package com.devonfw.tools.ide.commandlet;
 
+import java.util.List;
+
 import com.devonfw.tools.ide.cli.CliArguments;
 import com.devonfw.tools.ide.completion.CompletionCandidate;
 import com.devonfw.tools.ide.context.AbstractIdeContext;
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.property.StringProperty;
 
-import java.util.List;
-
 /**
  * {@link Commandlet} for auto-completion.
  */