Skip to content

Commit de5c29a

Browse files
authored
Add service client doc generator only when typedoc is selected (#1253)
1 parent 2239905 commit de5c29a

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

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

+8
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,14 @@ static void writePackageJson(
7777
node = node.withMember("devDependencies", devDeps);
7878
}
7979

80+
// Add @smithy/service-client-documentation-generator to the "devDependencies" if not present
81+
if (devDeps.getMember(TypeScriptDependency.AWS_SDK_CLIENT_DOCGEN.packageName).isEmpty()) {
82+
devDeps = devDeps.withMember(
83+
TypeScriptDependency.AWS_SDK_CLIENT_DOCGEN.packageName,
84+
TypeScriptDependency.AWS_SDK_CLIENT_DOCGEN.version);
85+
node = node.withMember("devDependencies", devDeps);
86+
}
87+
8088
// Add build:docs script
8189
ObjectNode scripts = node.getObjectMember("scripts").orElse(Node.objectNode());
8290
scripts = scripts.withMember("build:docs", "typedoc");

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
public enum TypeScriptDependency implements Dependency {
4040

4141
SMITHY_CORE("dependencies", "@smithy/core", false),
42-
AWS_SDK_CLIENT_DOCGEN("devDependencies", "@smithy/service-client-documentation-generator", true),
42+
AWS_SDK_CLIENT_DOCGEN("devDependencies", "@smithy/service-client-documentation-generator", false),
4343
AWS_SDK_TYPES("dependencies", "@aws-sdk/types", true),
4444
SMITHY_TYPES("dependencies", "@smithy/types", true),
4545
AWS_SMITHY_CLIENT("dependencies", "@smithy/smithy-client", true),

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public void createsSymbols() {
2626
@Test
2727
public void getsUnconditionalDependencies() {
2828
assertThat(TypeScriptDependency.getUnconditionalDependencies(),
29-
hasItem(TypeScriptDependency.AWS_SDK_CLIENT_DOCGEN.dependency));
29+
hasItem(TypeScriptDependency.SMITHY_TYPES.dependency));
3030
}
3131

3232
@Test

0 commit comments

Comments
 (0)