#1695: Clone settings to temporary directory, analyse, and then move

CHANGELOG.adoc

@@ -6,6 +6,7 @@ This file documents all notable changes to https://github.com/devonfw/IDEasy[IDE
 
 Release with new features and bugfixes:
 
+* https://github.com/devonfw/IDEasy/issues/1695[#1695]: Project creation logic extended with health checks and removed `--code` flag.
 * https://github.com/devonfw/IDEasy/issues/2190[#2190]: IDEasy destroys my python installation
 * https://github.com/devonfw/IDEasy/issues/2178[#2178]: Make ReleaseCommandlet independent of specific build commandlet and fix `ide build` using npm instead of yarn
 * https://github.com/devonfw/IDEasy/issues/2142[#2142]: Move IDE-specific metadata (.idea, .vscode) out of workspace

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

@@ -64,4 +64,15 @@ public int getExitCode() {
     return this.exitCode;
   }
 
+  /**
+   * @return {@code true} if this exception has to be re-thrown from a {@link com.devonfw.tools.ide.step.Step Step} even if that {@code Step} was not asked to
+   *     re-throw errors, {@code false} otherwise (default). A regular error only makes the according {@code Step} fail while the overall process continues with
+   *     the next step. However, if a critical guardrail was violated (e.g. no valid settings could be established) continuing makes no sense and the entire
+   *     process has to be aborted.
+   */
+  public boolean isForceRethrowInStep() {
+
+    return false;
+  }
+
 }

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

@@ -0,0 +1,36 @@
+package com.devonfw.tools.ide.cli;
+
+/**
+ * {@link CliException} that aborts the entire CLI process when a critical guardrail fails (e.g. the settings repository could not be cloned or is not a valid
+ * settings repository). Unlike a regular error that only makes the current {@link com.devonfw.tools.ide.step.Step Step} fail while the overall process
+ * continues, this exception {@link #isForceRethrowInStep() is always re-thrown} so no further step is executed in an invalid state.
+ */
+public final class CliFatalException extends CliException {
+
+  /**
+   * The constructor.
+   *
+   * @param message the {@link #getMessage() message}.
+   */
+  public CliFatalException(String message) {
+
+    super(message);
+  }
+
+  /**
+   * The constructor.
+   *
+   * @param message the {@link #getMessage() message}.
+   * @param cause the {@link #getCause() cause}.
+   */
+  public CliFatalException(String message, Throwable cause) {
+
+    super(message, cause);
+  }
+
+  @Override
+  public boolean isForceRethrowInStep() {
+
+    return true;
+  }
+}

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

@@ -15,6 +15,7 @@
 import com.devonfw.tools.ide.cli.CliArgument;
 import com.devonfw.tools.ide.cli.CliArguments;
 import com.devonfw.tools.ide.commandlet.cleanup.CleanupCommandlet;
+import com.devonfw.tools.ide.commandlet.update.UpdateCommandlet;
 import com.devonfw.tools.ide.completion.CompletionCandidateCollector;
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;

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

@@ -7,10 +7,10 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.devonfw.tools.ide.commandlet.update.AbstractUpdateCommandlet;
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.io.FileAccess;
 import com.devonfw.tools.ide.log.IdeLogLevel;
-import com.devonfw.tools.ide.property.FlagProperty;
 import com.devonfw.tools.ide.property.StringProperty;
 import com.devonfw.tools.ide.version.IdeVersion;
 
@@ -24,9 +24,6 @@ public class CreateCommandlet extends AbstractUpdateCommandlet {
   /** {@link StringProperty} for the name of the new project */
   public final StringProperty newProject;
 
-  /** {@link FlagProperty} for creating a project with settings inside a code repository */
-  public final FlagProperty codeRepositoryFlag;
-
   /**
    * The constructor.
    *
@@ -36,7 +33,6 @@ public CreateCommandlet(IdeContext context) {
 
     super(context);
     this.newProject = add(new StringProperty("", true, "project"));
-    this.codeRepositoryFlag = add(new FlagProperty("--code"));
     add(this.settingsRepo);
   }
 
@@ -55,42 +51,51 @@ public boolean isIdeHomeRequired() {
   @Override
   protected void doRun() {
 
-    String newProjectName = this.newProject.getValue();
-    Path newProjectPath = this.context.getIdeRoot().resolve(newProjectName);
-
+    Path newProjectPath = getNewProjectPath();
     LOG.info("Creating new IDEasy project in {}", newProjectPath);
-    if (!this.context.getFileAccess().isEmptyDir(newProjectPath)) {
-      this.context.askToContinue("Directory {} already exists. Do you want to continue?", newProjectPath);
-    } else {
-      this.context.getFileAccess().mkdirs(newProjectPath);
+    FileAccess fileAccess = this.context.getFileAccess();
+    if (!fileAccess.isEmptyDir(newProjectPath)) {
+      this.context.askToContinue("Directory {} already exists. Do you want to move the project to the backup and create it from scratch?", newProjectPath);
+      fileAccess.backup(newProjectPath);
     }
 
-    initializeProject(newProjectPath);
-    this.context.setIdeHome(newProjectPath);
     super.doRun();
     this.context.getFileAccess().writeFileContent(IdeVersion.getVersionString(), newProjectPath.resolve(IdeContext.FILE_SOFTWARE_VERSION));
-    IdeLogLevel.SUCCESS.log(LOG, "Successfully created new project '{}'.", newProjectName);
-
+    IdeLogLevel.SUCCESS.log(LOG, "Successfully created new project '{}'.", this.newProject.getValue());
     logWelcomeMessage();
   }
 
-  private void initializeProject(Path newInstancePath) {
+  @Override
+  protected void onSettingHealthCheckFinished() {
 
+    // only called after the settings passed the health check
+    Path newProjectPath = getNewProjectPath();
+    this.context.setIdeHome(newProjectPath);
     FileAccess fileAccess = this.context.getFileAccess();
-    fileAccess.mkdirs(newInstancePath.resolve(IdeContext.FOLDER_SOFTWARE));
-    fileAccess.mkdirs(newInstancePath.resolve(IdeContext.FOLDER_PLUGINS));
-    fileAccess.mkdirs(newInstancePath.resolve(IdeContext.FOLDER_WORKSPACES).resolve(IdeContext.WORKSPACE_MAIN));
+    fileAccess.mkdirs(newProjectPath);
+    fileAccess.mkdirs(newProjectPath.resolve(IdeContext.FOLDER_SOFTWARE));
+    fileAccess.mkdirs(newProjectPath.resolve(IdeContext.FOLDER_PLUGINS));
+    fileAccess.mkdirs(newProjectPath.resolve(IdeContext.FOLDER_WORKSPACES).resolve(IdeContext.WORKSPACE_MAIN));
   }
 
+  /**
+   * @return The path to the settings folder in the new project.
+   */
   @Override
-  protected boolean isCodeRepository() {
-    return this.codeRepositoryFlag.isTrue();
+  protected Path getSettingsPathForSettingsUpdate() {
+
+    return getNewProjectPath().resolve(IdeContext.FOLDER_SETTINGS);
+  }
+
+  private Path getNewProjectPath() {
+
+    return this.context.getIdeRoot().resolve(this.newProject.getValue());
   }
 
   @Override
   protected String getStepMessage() {
 
-    return "Create (clone) " + (isCodeRepository() ? "code" : "settings") + " repository";
+    return "Create (clone) repository";
   }
 
   private void logWelcomeMessage() {

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

@@ -9,6 +9,7 @@
 import com.devonfw.tools.ide.context.IdeContext;
 import com.devonfw.tools.ide.environment.EnvironmentVariables;
 import com.devonfw.tools.ide.git.GitContext;
+import com.devonfw.tools.ide.git.repository.RepositoryType;
 import com.devonfw.tools.ide.log.IdeLogLevel;
 import com.devonfw.tools.ide.migration.IdeMigrator;
 import com.devonfw.tools.ide.os.SystemInfo;
@@ -91,7 +92,8 @@ private void logSettingsLegacyStatus() {
     }
     if (hasLegacyProperties) {
       LOG.warn(
-          "Your settings are outdated and contain legacy configurations. Please consider upgrading your settings:\nhttps://github.com/devonfw/IDEasy/blob/main/documentation/settings.adoc#upgrade");
+          "Your settings are outdated and contain legacy configurations. "
+              + "Please consider upgrading your settings:\nhttps://github.com/devonfw/IDEasy/blob/main/documentation/settings.adoc#upgrade");
     }
   }
 
@@ -104,7 +106,7 @@ private void logSettingsGitStatus() {
     } else {
       GitContext gitContext = this.context.getGitContext();
       if (gitContext.isRepositoryUpdateAvailable(settingsPath, this.context.getSettingsCommitIdPath())) {
-        if (!this.context.isSettingsCodeRepository()) {
+        if (RepositoryType.ofSettingsPath(this.context.getSettingsPath(), context) != RepositoryType.CODE_SETTINGS_COMBINED) {
           LOG.warn("Your settings are not up-to-date, please run 'ide update'.");
         }
       } else {