Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an example #855

Open
1 task
steamstreetjon opened this issue May 22, 2023 · 3 comments
Open
1 task

Create an example #855

steamstreetjon opened this issue May 22, 2023 · 3 comments
Labels
enhancement New feature or request no-auto-closure We do not want this issue to be automatically closed.

Comments

@steamstreetjon
Copy link

Smithy in general is hard to set up. There is almost no information on how to set up a basic project to generate code. Having a few examples would greatly improve the ability for developers to get up and running.

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue, please leave a comment

Describe the Feature

Create some examples of projects with Kotlin codegen enabled.

Is your Feature Request related to a problem?

Figuring out how to set up Kotlin Codegen (and Smithy in general) is really difficult. The concepts seems to be well documented, but the specifics about project setups, etc seem to be rarely described.

Proposed Solution

Just an examples folder with a few basic examples

Additional Context

It may not be obvious to those working on it, but Smithy is a mess to set up. The language is fairly well described, but it's really difficult to understand how to configure things like codegen. Some examples would go a LONG way.

  • I may be able to implement this feature request
@steamstreetjon steamstreetjon added the enhancement New feature or request label May 22, 2023
@ianbotsf
Copy link
Contributor

Hi @steamstreetjon, thanks for the feature request. The smithy-kotlin codegen project is currently only supported for generating the AWS SDK for Kotlin. While nothing explicitly prevents its use for other projects, there are several components missing which may make that difficult (such as standalone protocol support).

We fully plan to release it as a standalone code generator which can be used to build other (non-AWS) SDK, at which time we'll definitely have developer documentation and example projects. But in the short-term the project exists to support the AWS SDK for Kotlin and other efforts for standalone generation are not prioritized.

We'll leave this request open as a tracking mechanism.

aajtodd added a commit that referenced this issue Mar 11, 2024
Copy link

This is a very old issue that is probably not getting as much attention as it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to provide a comment or open a new issue.

@github-actions github-actions bot added the closing-soon This issue will automatically close in 2 days unless further comments are made. label May 31, 2024
@lauzadis lauzadis added no-auto-closure We do not want this issue to be automatically closed. and removed closing-soon This issue will automatically close in 2 days unless further comments are made. labels May 31, 2024
@RCHowell
Copy link

Are there any updates in regards to the statement below?

The smithy-kotlin codegen project is currently only supported for generating the AWS SDK for Kotlin.

Additionally, are there any examples for either Kotlin (or Java) codegen setup?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request no-auto-closure We do not want this issue to be automatically closed.
Projects
None yet
Development

No branches or pull requests

4 participants