#31: Implement tool commandlet for node package manager (#244)

Author: ndemirca

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

@@ -24,6 +24,7 @@
 import com.devonfw.tools.ide.tool.kotlinc.KotlincNative;
 import com.devonfw.tools.ide.tool.mvn.Mvn;
 import com.devonfw.tools.ide.tool.node.Node;
+import com.devonfw.tools.ide.tool.npm.Npm;
 import com.devonfw.tools.ide.tool.oc.Oc;
 import com.devonfw.tools.ide.tool.quarkus.Quarkus;
 import com.devonfw.tools.ide.tool.sonar.Sonar;
@@ -72,6 +73,7 @@ public CommandletManagerImpl(IdeContext context) {
     add(new Helm(context));
     add(new Java(context));
     add(new Node(context));
+    add(new Npm(context));
     add(new Mvn(context));
     add(new GcViewer(context));
     add(new Gradle(context));

cli/src/main/java/com/devonfw/tools/ide/io/FileAccess.java

@@ -15,29 +15,29 @@ public interface FileAccess {
    *
    * @param url the location of the binary file to download. May also be a local or remote path to copy from.
    * @param targetFile the {@link Path} to the target file to download to. Should not already exists. Missing parent
-   * directories will be created automatically.
+   *        directories will be created automatically.
    */
   void download(String url, Path targetFile);
 
   /**
    * Creates the entire {@link Path} as directories if not already existing.
    *
    * @param directory the {@link Path} to
-   * {@link java.nio.file.Files#createDirectories(Path, java.nio.file.attribute.FileAttribute...) create}.
+   *        {@link java.nio.file.Files#createDirectories(Path, java.nio.file.attribute.FileAttribute...) create}.
    */
   void mkdirs(Path directory);
 
   /**
    * @param file the {@link Path} to check.
    * @return {@code true} if the given {@code file} points to an existing file, {@code false} otherwise (the given
-   * {@link Path} does not exist or is a directory).
+   *         {@link Path} does not exist or is a directory).
    */
   boolean isFile(Path file);
 
   /**
    * @param folder the {@link Path} to check.
    * @return {@code true} if the given {@code folder} points to an existing directory, {@code false} otherwise (a
-   * warning is logged in this case).
+   *         warning is logged in this case).
    */
   boolean isExpectedFolder(Path folder);
 
@@ -87,7 +87,7 @@ default void symlink(Path source, Path targetLink) {
   /**
    * @param source the source {@link Path file or folder} to copy.
    * @param target the {@link Path} to copy {@code source} to. See {@link #copy(Path, Path, FileCopyMode)} for details.
-   * will always ensure that in the end you will find the same content of {@code source} in {@code target}.
+   *        will always ensure that in the end you will find the same content of {@code source} in {@code target}.
    */
   default void copy(Path source, Path target) {
 
@@ -97,13 +97,13 @@ default void copy(Path source, Path target) {
   /**
    * @param source the source {@link Path file or folder} to copy.
    * @param target the {@link Path} to copy {@code source} to. Unlike the Linux {@code cp} command this method will not
-   * take the filename of {@code source} and copy that to {@code target} in case that is an existing folder. Instead it
-   * will always be simple and stupid and just copy from {@code source} to {@code target}. Therefore the result is
-   * always clear and easy to predict and understand. Also you can easily rename a file to copy. While
-   * {@code cp my-file target} may lead to a different result than {@code cp my-file target/} this method will always
-   * ensure that in the end you will find the same content of {@code source} in {@code target}.
+   *        take the filename of {@code source} and copy that to {@code target} in case that is an existing folder.
+   *        Instead it will always be simple and stupid and just copy from {@code source} to {@code target}. Therefore
+   *        the result is always clear and easy to predict and understand. Also you can easily rename a file to copy.
+   *        While {@code cp my-file target} may lead to a different result than {@code cp my-file target/} this method
+   *        will always ensure that in the end you will find the same content of {@code source} in {@code target}.
    * @param fileOnly - {@code true} if {@code fileOrFolder} is expected to be a file and an exception shall be thrown if
-   * it is a directory, {@code false} otherwise (copy recursively).
+   *        it is a directory, {@code false} otherwise (copy recursively).
    */
   void copy(Path source, Path target, FileCopyMode fileOnly);
 
@@ -120,7 +120,7 @@ default void extract(Path archiveFile, Path targetDir) {
    * @param archiveFile the {@link Path} to the archive file to extract.
    * @param targetDir the {@link Path} to the directory where to extract the {@code archiveFile}.
    * @param postExtractHook the {@link Consumer} to be called after the extraction on the final folder before it is
-   * moved to {@code targetDir}.
+   *        moved to {@code targetDir}.
    */
   default void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtractHook) {
 
@@ -131,7 +131,7 @@ default void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtrac
    * @param archiveFile the {@link Path} to the archive file to extract.
    * @param targetDir the {@link Path} to the directory where to extract the {@code archiveFile}.
    * @param postExtractHook the {@link Consumer} to be called after the extraction on the final folder before it is
-   * moved to {@code targetDir}.
+   *        moved to {@code targetDir}.
    * @param extract {@code true} if the {@code archiveFile} should be extracted (default), {@code false} otherwise.
    */
   void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtractHook, boolean extract);
@@ -201,7 +201,7 @@ default void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtrac
    * {@link #delete(Path) delete} it after the work is done.
    *
    * @param name the default name of the temporary directory to create. A prefix or suffix may be added to ensure
-   * uniqueness.
+   *        uniqueness.
    * @return the {@link Path} to the newly created and unique temporary directory.
    */
   Path createTempDir(String name);
@@ -217,9 +217,9 @@ default void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtrac
   /**
    * @param dir the {@link Path} to the directory where to list the children.
    * @param filter the {@link Predicate} used to {@link Predicate#test(Object) decide} which children to include (if
-   * {@code true} is returned).
+   *        {@code true} is returned).
    * @return all children of the given {@link Path} that match the given {@link Predicate}. Will be the empty list of
-   * the given {@link Path} is not an existing directory.
+   *         the given {@link Path} is not an existing directory.
    */
   List<Path> listChildren(Path dir, Predicate<Path> filter);
 

cli/src/main/java/com/devonfw/tools/ide/io/FileAccessImpl.java

@@ -1,20 +1,5 @@
 package com.devonfw.tools.ide.io;
 
-import com.devonfw.tools.ide.cli.CliException;
-import com.devonfw.tools.ide.context.IdeContext;
-import com.devonfw.tools.ide.os.SystemInfoImpl;
-import com.devonfw.tools.ide.process.ProcessContext;
-import com.devonfw.tools.ide.url.model.file.UrlChecksum;
-import com.devonfw.tools.ide.util.DateTimeUtil;
-import com.devonfw.tools.ide.util.FilenameUtil;
-import com.devonfw.tools.ide.util.HexUtil;
-
-import org.apache.commons.compress.archivers.ArchiveEntry;
-import org.apache.commons.compress.archivers.ArchiveInputStream;
-import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
-import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
-import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
-
 import java.io.BufferedOutputStream;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
@@ -47,6 +32,21 @@
 import java.util.function.Predicate;
 import java.util.stream.Stream;
 
+import org.apache.commons.compress.archivers.ArchiveEntry;
+import org.apache.commons.compress.archivers.ArchiveInputStream;
+import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
+import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
+import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
+
+import com.devonfw.tools.ide.cli.CliException;
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.os.SystemInfoImpl;
+import com.devonfw.tools.ide.process.ProcessContext;
+import com.devonfw.tools.ide.url.model.file.UrlChecksum;
+import com.devonfw.tools.ide.util.DateTimeUtil;
+import com.devonfw.tools.ide.util.FilenameUtil;
+import com.devonfw.tools.ide.util.HexUtil;
+
 /**
  * Implementation of {@link FileAccess}.
  */
@@ -280,10 +280,12 @@ public void copy(Path source, Path target, FileCopyMode mode) {
     if (fileOnly) {
       this.context.debug("Copying file {} to {}", source, target);
       if (Files.isDirectory(target)) {
-        // if we want to copy "file.txt" to the existing folder "path/to/folder/" in a shell this will copy "file.txt" into that folder
+        // if we want to copy "file.txt" to the existing folder "path/to/folder/" in a shell this will copy "file.txt"
+        // into that folder
         // with Java NIO the raw copy method will fail as we cannot copy the file to the path of the target folder
         // even worse if FileCopyMode is override the target folder ("path/to/folder/") would be deleted and the result
-        // of our "file.txt" would later appear in "path/to/folder". To prevent such bugs we append the filename to target
+        // of our "file.txt" would later appear in "path/to/folder". To prevent such bugs we append the filename to
+        // target
         target = target.resolve(source.getFileName());
       }
     } else {
@@ -355,7 +357,7 @@ private void deleteLinkIfExists(Path path) throws IOException {
    *
    * @param source the {@link Path} to adapt.
    * @param targetLink the {@link Path} used to calculate the relative path to the {@code source} if {@code relative} is
-   * set to {@code true}.
+   *        set to {@code true}.
    * @param relative the {@code relative} flag.
    * @return the adapted {@link Path}.
    * @see FileAccessImpl#symlink(Path, Path, boolean)
@@ -413,7 +415,8 @@ private void createWindowsJunction(Path source, Path targetLink) {
       } catch (IOException e) {
         throw new IllegalStateException(
             "Since Windows junctions are used, the source must be an absolute path. The transformation of the passed "
-                + "source (" + source + ") to an absolute path failed.", e);
+                + "source (" + source + ") to an absolute path failed.",
+            e);
       }
 
     } else {
@@ -435,9 +438,8 @@ public void symlink(Path source, Path targetLink, boolean relative) {
     try {
       adaptedSource = adaptPath(source, targetLink, relative);
     } catch (IOException e) {
-      throw new IllegalStateException(
-          "Failed to adapt source for source (" + source + ") target (" + targetLink + ") and relative (" + relative
-              + ")", e);
+      throw new IllegalStateException("Failed to adapt source for source (" + source + ") target (" + targetLink
+          + ") and relative (" + relative + ")", e);
     }
     this.context.trace("Creating {} symbolic link {} pointing to {}", adaptedSource.isAbsolute() ? "" : "relative",
         targetLink, adaptedSource);
@@ -451,7 +453,7 @@ public void symlink(Path source, Path targetLink, boolean relative) {
     try {
       Files.createSymbolicLink(targetLink, adaptedSource);
     } catch (FileSystemException e) {
-      if (this.context.getSystemInfo().isWindows()) {
+      if (SystemInfoImpl.INSTANCE.isWindows()) {
         this.context.info("Due to lack of permissions, Microsoft's mklink with junction had to be used to create "
             + "a Symlink. See https://github.com/devonfw/IDEasy/blob/main/documentation/symlinks.asciidoc for "
             + "further details. Error was: " + e.getMessage());
@@ -460,9 +462,8 @@ public void symlink(Path source, Path targetLink, boolean relative) {
         throw new RuntimeException(e);
       }
     } catch (IOException e) {
-      throw new IllegalStateException(
-          "Failed to create a " + (adaptedSource.isAbsolute() ? "" : "relative") + "symbolic link " + targetLink
-              + " pointing to " + source, e);
+      throw new IllegalStateException("Failed to create a " + (adaptedSource.isAbsolute() ? "" : "relative")
+          + "symbolic link " + targetLink + " pointing to " + source, e);
     }
   }
 
@@ -505,13 +506,14 @@ public Path createTempDir(String name) {
   public void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtractHook, boolean extract) {
 
     if (Files.isDirectory(archiveFile)) {
-      Path properInstallDir = archiveFile; //getProperInstallationSubDirOf(archiveFile, archiveFile);
+      Path properInstallDir = archiveFile; // getProperInstallationSubDirOf(archiveFile, archiveFile);
       if (extract) {
         this.context.warning("Found directory for download at {} hence copying without extraction!", archiveFile);
         copy(properInstallDir, targetDir, FileCopyMode.COPY_TREE_OVERRIDE_TREE);
       } else {
         move(properInstallDir, targetDir);
       }
+      postExtractHook(postExtractHook, properInstallDir);
       return;
     } else if (!extract) {
       mkdirs(targetDir);
@@ -551,26 +553,31 @@ public void extract(Path archiveFile, Path targetDir, Consumer<Path> postExtract
       }
     }
     Path properInstallDir = getProperInstallationSubDirOf(tmpDir, archiveFile);
+    postExtractHook(postExtractHook, properInstallDir);
+    move(properInstallDir, targetDir);
+    delete(tmpDir);
+  }
+
+  private void postExtractHook(Consumer<Path> postExtractHook, Path properInstallDir) {
+
     if (postExtractHook != null) {
       postExtractHook.accept(properInstallDir);
     }
-    move(properInstallDir, targetDir);
-    delete(tmpDir);
   }
 
   /**
    * @param path the {@link Path} to start the recursive search from.
    * @return the deepest subdir {@code s} of the passed path such that all directories between {@code s} and the passed
-   * path (including {@code s}) are the sole item in their respective directory and {@code s} is not named "bin".
+   *         path (including {@code s}) are the sole item in their respective directory and {@code s} is not named
+   *         "bin".
    */
   private Path getProperInstallationSubDirOf(Path path, Path archiveFile) {
 
     try (Stream<Path> stream = Files.list(path)) {
       Path[] subFiles = stream.toArray(Path[]::new);
       if (subFiles.length == 0) {
-        throw new CliException(
-            "The downloaded package " + archiveFile + " seems to be empty as you can check in the extracted folder "
-                + path);
+        throw new CliException("The downloaded package " + archiveFile
+            + " seems to be empty as you can check in the extracted folder " + path);
       } else if (subFiles.length == 1) {
         String filename = subFiles[0].getFileName().toString();
         if (!filename.equals(IdeContext.FOLDER_BIN) && !filename.equals(IdeContext.FOLDER_CONTENTS)
@@ -598,7 +605,7 @@ public void extractTar(Path file, Path targetDir, TarCompression compression) {
 
   /**
    * @param permissions The integer as returned by {@link TarArchiveEntry#getMode()} that represents the file
-   * permissions of a file on a Unix file system.
+   *        permissions of a file on a Unix file system.
    * @return A String representing the file permissions. E.g. "rwxrwxr-x" or "rw-rw-r--"
    */
   public static String generatePermissionString(int permissions) {

cli/src/main/java/com/devonfw/tools/ide/tool/npm/Npm.java

@@ -0,0 +1,56 @@
+package com.devonfw.tools.ide.tool.npm;
+
+import java.nio.file.Path;
+import java.util.Set;
+
+import com.devonfw.tools.ide.common.Tag;
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.io.FileAccess;
+import com.devonfw.tools.ide.tool.LocalToolCommandlet;
+import com.devonfw.tools.ide.tool.ToolCommandlet;
+import com.devonfw.tools.ide.tool.node.Node;
+
+/**
+ * {@link ToolCommandlet} for <a href="https://www.npmjs.com/">npm</a>.
+ */
+public class Npm extends LocalToolCommandlet {
+
+  /**
+   * The constructor.
+   *
+   * @param context the {@link IdeContext}.
+   */
+  public Npm(IdeContext context) {
+
+    super(context, "npm", Set.of(Tag.JAVA_SCRIPT, Tag.BUILD));
+  }
+
+  @Override
+  public boolean install(boolean silent) {
+
+    getCommandlet(Node.class).install();
+    return super.doInstall(silent);
+  }
+
+  protected void postExtract(Path extractedDir) {
+
+    FileAccess fileAccess = context.getFileAccess();
+    if (context.getSystemInfo().isWindows()) {
+      Path nodeHomePath = this.context.getSoftwarePath().resolve("node/");
+      Path npmBinBath = nodeHomePath.resolve("node_modules/npm/bin/");
+      String npm = "npm";
+      String npx = "npx";
+      String cmd = ".cmd";
+
+      fileAccess.delete(nodeHomePath.resolve(npm));
+      fileAccess.delete(nodeHomePath.resolve(npm + cmd));
+      fileAccess.delete(nodeHomePath.resolve(npx));
+      fileAccess.delete(nodeHomePath.resolve(npx + cmd));
+
+      fileAccess.copy(npmBinBath.resolve(npm), nodeHomePath.resolve(npm));
+      fileAccess.copy(npmBinBath.resolve(npm + cmd), nodeHomePath.resolve(npm + cmd));
+      fileAccess.copy(npmBinBath.resolve(npx), nodeHomePath.resolve(npx));
+      fileAccess.copy(npmBinBath.resolve(npx + cmd), nodeHomePath.resolve(npx + cmd));
+    }
+  }
+}

cli/src/main/resources/nls/Ide.properties

@@ -25,6 +25,7 @@ cmd-list-editions=List the available editions of the selected tool.
 cmd-list-versions=List the available versions of the selected tool.
 cmd-mvn=Tool commandlet for Maven (Build-Tool)
 cmd-node=Tool commandlet for Node.js (JavaScript runtime)
+cmd-npm=Tool commandlet for Npm
 cmd-oc=Tool commandlet for Openshift CLI (Kubernetes Management Tool)
 cmd-quarkus=Tool commandlet for Quarkus (Framework for cloud-native apps)
 cmd-set-edition=Set the edition of the selected tool.

cli/src/main/resources/nls/Ide_de.properties

@@ -23,6 +23,7 @@ cmd-list-editions=Listet die verfügbaren Editionen des selektierten Werkzeugs a
 cmd-list-versions=Listet die verfügbaren Versionen des selektierten Werkzeugs auf.
 cmd-mvn=Werkzeug Kommando für Maven (Build-Werkzeug)
 cmd-node=Werkzeug Kommando für Node.js (JavaScript Laufzeitumgebung)
+cmd-npm=Werkzeug Kommando für Npm
 cmd-oc=Werkzeug Kommando für Openshift CLI (Kubernetes Management Tool)
 cmd-quarkus=Werkzeug Kommando für Quarkus (Framework für Cloud-native Anwendungen)
 cmd-set-edition=Setzt die Edition des selektierten Werkzeugs.

cli/src/test/java/com/devonfw/tools/ide/tool/jmc/JmcTest.java

@@ -82,5 +82,4 @@ private void checkInstallation(IdeTestContext context) {
     assertThat(context.getSoftwarePath().resolve("jmc/.ide.software.version")).exists().hasContent("8.3.0");
     assertLogMessage(context, IdeLogLevel.SUCCESS, "Successfully installed jmc in version 8.3.0");
   }
-
 }