feat(open-api-gateway): idomatic smithy project structure for better IDE support #280
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit ccddc4c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
JeremyJonas
suggested changes
Feb 3, 2023
There was a problem hiding this comment.
Is it possible to add auto-migration capabilities - thinking for the model folder move would be great. More curious from how we can handle migrations in general for packages that this particularly since quite minimal. Nothing have to do now, but could be a nice simple example to attempt 😄
cogwirrel
force-pushed
the
feat/idiomatic-smithy-structure
branch
from
113a2a9
to
a366643
Compare
This would be super cool, but is a little bit fiddly to do properly as we'd need to parse the old |
agdimech
reviewed
Feb 6, 2023
packages/open-api-gateway/src/project/smithy/components/sample-executable.ts
Outdated
Show resolved
Hide resolved
packages/open-api-gateway/src/project/smithy/components/sample-executable.ts
Outdated
Show resolved
Hide resolved
…ide support This change restructures the smithy-based projects to combine the `model` and `smithy-build` directories into a single `smithy` directory. This directory has a more similar structure to those found in the Smithy documentation, and in turn means that IDE tools can be more easily configured to help with the developer experience. Specifically with this change, the Smithy IntelliJ plugin can be used to enhance the development experience when authoring models. https://github.com/iancaffey/smithy-intellij-plugin We preserve the behaviour of abstracting away the gradle wrapper, whereby it is ignored from the generated project's source control by default, and copied from the PDK if it does not already exist. Similarly we allow users to bring their own `gradle wrapper` by choosing not to ignore it in source control, and placing it in the `smithy` directory. This replaces the `gradleWrapperPath` configuration option. While this is a breaking change, the migration steps are fairly straightforward: - Upgrade the open-api-gateway package - `npx projen` to regenerate code - notice the new `smithy` folder in your api project - Copy the contents of the old `model` directory into `smithy/src/main/smithy` - If any custom dependencies were added to the `smithy-build/build.gradle` file, add them to `smithy/build.gradle` - Delete the old `model` and `smithy-build` directories BREAKING CHANGE: Moved the location of the smithy model from 'model' to 'smithy/src/main/smithy'. Removed the gradleWrapperPath configuration option. fix #278
cogwirrel
force-pushed
the
feat/idiomatic-smithy-structure
branch
from
a366643
to
7049544
Compare
agdimech
approved these changes
Feb 6, 2023
JeremyJonas
approved these changes
Feb 6, 2023
mteichtahl
pushed a commit
to mteichtahl/aws-prototyping-sdk
that referenced
this pull request
Feb 8, 2023
…ide support (aws#280) This change restructures the smithy-based projects to combine the `model` and `smithy-build` directories into a single `smithy` directory. This directory has a more similar structure to those found in the Smithy documentation, and in turn means that IDE tools can be more easily configured to help with the developer experience. Specifically with this change, the Smithy IntelliJ plugin can be used to enhance the development experience when authoring models. https://github.com/iancaffey/smithy-intellij-plugin We preserve the behaviour of abstracting away the gradle wrapper, whereby it is ignored from the generated project's source control by default, and copied from the PDK if it does not already exist. Similarly we allow users to bring their own `gradle wrapper` by choosing not to ignore it in source control, and placing it in the `smithy` directory. This replaces the `gradleWrapperPath` configuration option. While this is a breaking change, the migration steps are fairly straightforward: - Upgrade the open-api-gateway package - `npx projen` to regenerate code - notice the new `smithy` folder in your api project - Copy the contents of the old `model` directory into `smithy/src/main/smithy` - If any custom dependencies were added to the `smithy-build/build.gradle` file, add them to `smithy/build.gradle` - Delete the old `model` and `smithy-build` directories BREAKING CHANGE: Moved the location of the smithy model from 'model' to 'smithy/src/main/smithy'. Removed the gradleWrapperPath configuration option. fix aws#278
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change restructures the smithy-based projects to combine the
modelandsmithy-builddirectories into a singlesmithydirectory. This directory has a more similar structure to those found in the Smithy documentation, and in turn means that IDE tools can be more easily configured to help with the developer experience.Specifically with this change, the Smithy IntelliJ plugin can be used to enhance the development experience when authoring models. https://github.com/iancaffey/smithy-intellij-plugin
We preserve the behaviour of abstracting away the gradle wrapper, whereby it is ignored from the generated project's source control by default, and copied from the PDK if it does not already exist. Similarly we allow users to bring their own
gradle wrapperby choosing not to ignore it in source control, and placing it in thesmithydirectory. This replaces thegradleWrapperPathconfiguration option.While this is a breaking change, the migration steps are fairly straightforward:
npx projento regenerate code - notice the newsmithyfolder in your api projectmodeldirectory intosmithy/src/main/smithysmithy-build/build.gradlefile, add them tosmithy/build.gradlemodelandsmithy-builddirectoriesBREAKING CHANGE: Moved the location of the smithy model from 'model' to 'smithy/src/main/smithy'. Removed the gradleWrapperPath configuration option.
fix #278