-
Notifications
You must be signed in to change notification settings - Fork 42
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
Remove the api package #1055
Merged
Merged
Remove the api package #1055
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
inancgumus
force-pushed
the
refactor/api-package
branch
from
September 29, 2023 12:59
9079775
to
26a796a
Compare
inancgumus
changed the title
Rename api pkg types by suffixing with API
Remove the api package
Oct 2, 2023
inancgumus
force-pushed
the
refactor/api-package
branch
2 times, most recently
from
October 2, 2023 12:23
72b7463
to
f80a2a6
Compare
This is a temporary move until we finish refactoring. We'll make other packages depend on these types until we turn them into concrete types. Then, we'll remove these types from here, and move them into the mapping layer as unexported types for testing.
Packages no longer depends on the api pkg. All API declarations are now inside the common pkg. We'll turn them into concrete types next.
inancgumus
force-pushed
the
refactor/api-package
branch
from
October 2, 2023 12:24
f80a2a6
to
9634828
Compare
ankur22
approved these changes
Oct 5, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for starting on this. I think in the long run this will make things more maintainable and easier to navigate around the project.
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.
What?
api
pkg types withAPI
and fixes the linter errors (commits that start with "Rename".)API
types into thecommon
pkg (commits that start with "Move" and "Use".)api
pkg for good (commits that start with "Remove".)Why?
api
types withAPI
to distinguish them from thecommon
types. So, we can move them into thecommon
pkg.common
pkg is necessary because there are many dependencies to these types throughout the module, and we can only sanely refactor these into concrete types within thecommon
pkg.api
pkg dependency.See the other reasonings in #898.
Checklist
Related PR(s)/Issue(s)
Updates: #898 (Actually, it finishes the work, but it's better to move the interfaces to concrete types to realize the issue's goal fully).