Update default package description based on artifact type #582
Conversation
AndrewFossAWS
changed the title
| @@ -110,6 +110,20 @@ public static TypeScriptSettings from(Model model, ObjectNode config, ArtifactTy | |||
| return settings; | |||
| } | |||
|
|
|||
| private String getDefaultDescription() { | |||
| String defaultDescription = getPackageName(); | |||
There was a problem hiding this comment.
This is no longer coming from settings or further up to config, are we sure it's correct? I don't see a test change to know for sure.
There was a problem hiding this comment.
Based on the current code, the package name is currently passed in via PluginContext.getSettings() in CodegenVisitor.
I also verified the change by generating the server code in the Smithy TS SSDK Demo repo and seeing server in the description in package.json
There was a problem hiding this comment.
line 93 sets the packageName on settings from config, and getDefaultDescription instance method is actually picking up that value, so @kstich I think it is what you expected. But to Kevin's point, you can add tests that assert the behavior for client and server cases.
...-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptSettingsTest.java
Outdated
Show resolved
Hide resolved
...-codegen/src/test/java/software/amazon/smithy/typescript/codegen/TypeScriptSettingsTest.java
Outdated
Show resolved
Hide resolved
...odegen/src/test/java/software/amazon/smithy/typescript/codegen/PackageJsonGeneratorTest.java
Outdated
Show resolved
Hide resolved
Description of changes:
Update default
package.jsondescription based on artifact typeFor example if the package name is
ExamplePackage, the following package description can be:ExamplePackage clientExamplePackage serverBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.