feat(codegen): configurable package manager

Generated packages all use yarn in their package.json, which is not always
available. This adds a configuration to the code generator called
packageManager, which can be set to yarn or npm, or omitted for the default,
which remains yarn for backwards compatibility.

Author: adamthom-amzn

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/PackageJsonGenerator.java

@@ -73,6 +73,7 @@ static void writePackageJson(
         template = template.replace("${package}", settings.getPackageName());
         template = template.replace("${packageDescription}", settings.getPackageDescription());
         template = template.replace("${packageVersion}", settings.getPackageVersion());
+        template = template.replace("${packageManager}", settings.getPackageManager().getCommand());
         manifest.writeFile("package.json", template);
     }
 }

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java

@@ -53,6 +53,7 @@ public final class TypeScriptSettings {
     private static final String SERVICE = "service";
     private static final String PROTOCOL = "protocol";
     private static final String PRIVATE = "private";
+    private static final String PACKAGE_MANAGER = "packageManager";
 
     private String packageName;
     private String packageDescription = "";
@@ -64,6 +65,7 @@ public final class TypeScriptSettings {
     private boolean isPrivate;
     private ArtifactType artifactType = ArtifactType.CLIENT;
     private boolean disableDefaultValidation = false;
+    private PackageManager packageManager = PackageManager.YARN;
 
     @Deprecated
     public static TypeScriptSettings from(Model model, ObjectNode config) {
@@ -95,6 +97,10 @@ public static TypeScriptSettings from(Model model, ObjectNode config, ArtifactTy
         settings.packageJson = config.getObjectMember(PACKAGE_JSON).orElse(Node.objectNode());
         config.getStringMember(PROTOCOL).map(StringNode::getValue).map(ShapeId::from).ifPresent(settings::setProtocol);
         settings.setPrivate(config.getBooleanMember(PRIVATE).map(BooleanNode::getValue).orElse(false));
+        settings.setPackageManager(
+                config.getStringMember(PACKAGE_MANAGER)
+                    .map(s -> PackageManager.fromString(s.getValue()))
+                    .orElse(PackageManager.YARN));
 
         if (artifactType == ArtifactType.SSDK) {
             settings.setDisableDefaultValidation(config.getBooleanMemberOrDefault(DISABLE_DEFAULT_VALIDATION));
@@ -275,6 +281,19 @@ public void setDisableDefaultValidation(boolean disableDefaultValidation) {
         this.disableDefaultValidation = disableDefaultValidation;
     }
 
+    /**
+     * Returns the package manager used by the generated package.
+     *
+     * @return the configured package manager. Defaults to {@link PackageManager#YARN}
+     */
+    public PackageManager getPackageManager() {
+        return packageManager;
+    }
+
+    public void setPackageManager(PackageManager packageManager) {
+        this.packageManager = packageManager;
+    }
+
     /**
      * Gets the corresponding {@link ServiceShape} from a model.
      *
@@ -347,10 +366,10 @@ public void setProtocol(ShapeId protocol) {
      */
     public enum ArtifactType {
         CLIENT(SymbolVisitor::new,
-                Arrays.asList(PACKAGE, PACKAGE_DESCRIPTION, PACKAGE_JSON, PACKAGE_VERSION,
+                Arrays.asList(PACKAGE, PACKAGE_DESCRIPTION, PACKAGE_JSON, PACKAGE_VERSION, PACKAGE_MANAGER,
                               SERVICE, PROTOCOL, TARGET_NAMESPACE, PRIVATE)),
         SSDK((m, s) -> new ServerSymbolVisitor(m, new SymbolVisitor(m, s)),
-                Arrays.asList(PACKAGE, PACKAGE_DESCRIPTION, PACKAGE_JSON, PACKAGE_VERSION,
+                Arrays.asList(PACKAGE, PACKAGE_DESCRIPTION, PACKAGE_JSON, PACKAGE_VERSION, PACKAGE_MANAGER,
                               SERVICE, PROTOCOL, TARGET_NAMESPACE, PRIVATE, DISABLE_DEFAULT_VALIDATION));
 
         private final BiFunction<Model, TypeScriptSettings, SymbolProvider> symbolProviderFactory;
@@ -373,4 +392,29 @@ public SymbolProvider createSymbolProvider(Model model, TypeScriptSettings setti
             return symbolProviderFactory.apply(model, settings);
         }
     }
+
+    public enum PackageManager {
+        YARN("yarn"),
+        NPM("npm run-script");
+
+        private final String command;
+
+        PackageManager(String command) {
+            this.command = command;
+        }
+
+        public String getCommand() {
+            return command;
+        }
+
+        public static PackageManager fromString(String s) {
+            if ("yarn".equals(s)) {
+                return YARN;
+            }
+            if ("npm".equals(s)) {
+                return NPM;
+            }
+            throw new CodegenException(String.format("Unsupported package manager: %s", s));
+        }
+    }
 }

smithy-typescript-codegen/src/main/resources/software/amazon/smithy/typescript/codegen/base-package.json

@@ -3,12 +3,12 @@
   "description": "${packageDescription}",
   "version": "${packageVersion}",
   "scripts": {
-    "build": "yarn build:cjs && yarn build:es && yarn build:types",
+    "build": "${packageManager} build:cjs && ${packageManager} build:es && ${packageManager} build:types",
     "build:cjs": "tsc -p tsconfig.json",
-    "build:docs": "yarn clean:docs && typedoc ./",
+    "build:docs": "${packageManager} clean:docs && typedoc ./",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
-    "clean": "yarn clean:dist && yarn clean:docs",
+    "clean": "${packageManager} clean:dist && ${packageManager} clean:docs",
     "clean:dist": "rimraf ./dist-*",
     "clean:docs": "rimraf ./docs",
     "downlevel-dts": "downlevel-dts dist-types dist-types/ts3.4",

smithy-typescript-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptSettingsTest.java

@@ -2,6 +2,7 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.model.Model;
@@ -24,6 +25,35 @@ public void resolvesDefaultService() {
         assertThat(settings.getService(), equalTo(ShapeId.from("smithy.example#Example")));
     }
 
+    @Test
+    public void defaultsToYarn() {
+        Model model = Model.assembler()
+                .addImport(getClass().getResource("simple-service.smithy"))
+                .assemble()
+                .unwrap();
+        TypeScriptSettings settings = TypeScriptSettings.from(model, Node.objectNodeBuilder()
+                .withMember("package", Node.from("example"))
+                .withMember("packageVersion", Node.from("1.0.0"))
+                .build());
+
+        assertEquals(TypeScriptSettings.PackageManager.YARN, settings.getPackageManager());
+    }
+
+    @Test
+    public void canBeConfiguredToNpm() {
+        Model model = Model.assembler()
+                .addImport(getClass().getResource("simple-service.smithy"))
+                .assemble()
+                .unwrap();
+        TypeScriptSettings settings = TypeScriptSettings.from(model, Node.objectNodeBuilder()
+                .withMember("package", Node.from("example"))
+                .withMember("packageVersion", Node.from("1.0.0"))
+                .withMember("packageManager", Node.from("npm"))
+                .build());
+
+        assertEquals(TypeScriptSettings.PackageManager.NPM, settings.getPackageManager());
+    }
+
     @Test
     public void resolvesSupportProtocols() {
         // TODO