refactor: extract base npm options to a mixin

Author: simschla

README.md

@@ -280,7 +280,8 @@ output =
 -->
 
 ```
-Usage: spotless prettier [-hV] [-C=<cacheDir>] [-n=<explicitNpmExecutable>]
+Usage: spotless prettier [-hV] [-C=<npmInstallCacheDir>]
+                         [-n=<explicitNpmExecutable>]
                          [-N=<explicitNodeExecutable>]
                          [-P=<prettierConfigPath>] [-R=<explicitNpmrcFile>]
                          [-A=<additionalNpmrcLocations>]...
@@ -292,8 +293,9 @@ Runs prettier, the opinionated code formatter.
                   A prettier configuration options.
                     The format is 'OPTION=VALUE'.
                     example: 'printWidth=80'
-  -C, --cache-dir=<cacheDir>
-                  The directory to use for caching prettier.
+  -C, --npm-install-cache-dir=<npmInstallCacheDir>
+                  The directory to use for caching libraries retrieved by 'npm
+                    install'.
   -D, --dev-dependency='PACKAGE=VERSION'
                   An entry to add to the package.json for running prettier.
                     The format is 'PACKAGE=VERSION'.

app/src/main/java/com/diffplug/spotless/cli/steps/NpmOptions.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2024 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.cli.steps;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import picocli.CommandLine;
+
+public class NpmOptions {
+    @CommandLine.Option(
+            names = {"--npm-install-cache-dir", "-C"},
+            description = "The directory to use for caching libraries retrieved by @|YELLOW 'npm install'|@.")
+    Path npmInstallCacheDir;
+
+    @CommandLine.Option(
+            names = {"--npm-exec", "-n"},
+            description = "The explicit path to the npm executable.")
+    Path explicitNpmExecutable;
+
+    @CommandLine.Option(
+            names = {"--node-exec", "-N"},
+            description = "The explicit path to the node executable.")
+    Path explicitNodeExecutable;
+
+    @CommandLine.Option(
+            names = {"--npmrc-file", "-R"},
+            description = "The explicit path to the .npmrc file.")
+    Path explicitNpmrcFile;
+
+    @CommandLine.Option(
+            names = {"--additional-npmrc-location", "-A"},
+            description = "Additional locations to search for .npmrc files.")
+    List<Path> additionalNpmrcLocations;
+}

app/src/main/java/com/diffplug/spotless/cli/steps/Prettier.java

@@ -50,30 +50,8 @@ public class Prettier extends SpotlessFormatterStep {
             paramLabel = "'PACKAGE=VERSION'")
     Map<String, String> devDependencies;
 
-    @CommandLine.Option(
-            names = {"--cache-dir", "-C"},
-            description = "The directory to use for caching prettier.")
-    Path cacheDir;
-
-    @CommandLine.Option(
-            names = {"--npm-exec", "-n"},
-            description = "The explicit path to the npm executable.")
-    Path explicitNpmExecutable;
-
-    @CommandLine.Option(
-            names = {"--node-exec", "-N"},
-            description = "The explicit path to the node executable.")
-    Path explicitNodeExecutable;
-
-    @CommandLine.Option(
-            names = {"--npmrc-file", "-R"},
-            description = "The explicit path to the .npmrc file.")
-    Path explicitNpmrcFile;
-
-    @CommandLine.Option(
-            names = {"--additional-npmrc-location", "-A"},
-            description = "Additional locations to search for .npmrc files.")
-    List<Path> additionalNpmrcLocations;
+    @CommandLine.Mixin
+    NpmOptions npmOptions;
 
     @CommandLine.Option(
             names = {"--prettier-config-path", "-P"},
@@ -91,10 +69,10 @@ public class Prettier extends SpotlessFormatterStep {
     public List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
         FormatterStep prettierFormatterStep = builder(context)
                 .withDevDependencies(devDependencies())
-                .withCacheDir(cacheDir)
-                .withExplicitNpmExecutable(explicitNpmExecutable)
-                .withExplicitNodeExecutable(explicitNodeExecutable)
-                .withExplicitNpmrcFile(explicitNpmrcFile)
+                .withCacheDir(npmOptions.npmInstallCacheDir)
+                .withExplicitNpmExecutable(npmOptions.explicitNpmExecutable)
+                .withExplicitNodeExecutable(npmOptions.explicitNodeExecutable)
+                .withExplicitNpmrcFile(npmOptions.explicitNpmrcFile)
                 .withAdditionalNpmrcLocations(additionalNpmrcLocations())
                 .withPrettierConfigOptions(prettierConfigOptions())
                 .withPrettierConfigPath(prettierConfigPath)
@@ -134,7 +112,7 @@ private Map<String, String> devDependencies() {
     }
 
     private List<Path> additionalNpmrcLocations() {
-        return use(additionalNpmrcLocations).orIfNullGet(Collections::emptyList);
+        return use(npmOptions.additionalNpmrcLocations).orIfNullGet(Collections::emptyList);
     }
 
     private PrettierFormatterStepBuilder builder(@NotNull SpotlessActionContext context) {