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.

Sign up for GitHub

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

Jump to bottom

Reduce public API scope #399

Open
ryanslade opened this issue Oct 15, 2024 · 1 comment
Open

Reduce public API scope #399

ryanslade opened this issue Oct 15, 2024 · 1 comment
Assignees
@ryanslade
Labels
enhancement New feature or request
Milestone
v1

Comments

@ryanslade
Copy link
Collaborator

At the moment all of our packages are available in the pkg package. Since pgroll is designed to be used as a library, we may want to move some of these packages into an internal package so that we reduce the scope of what can be imported externally.

This will clean up our API and make it easier to support in the long term.
@ryanslade ryanslade added the enhancement New feature or request label Oct 15, 2024
@ryanslade ryanslade added this to the v1 milestone Oct 15, 2024
@ryanslade
Copy link
Collaborator Author

ryanslade commented Oct 15, 2024 •
edited
Loading

TODO: @ryanslade to provide a more concrete proposal here.

WIP

  • Create top-level internal package (same level as pkg)
  • Move pkg/testutils into internal
  • Move pkg/jsonschema into internal

@ryanslade ryanslade self-assigned this Oct 15, 2024
@ryanslade ryanslade mentioned this issue Oct 21, 2024
Merged
ryanslade added a commit that referenced this issue Oct 21, 2024
@ryanslade
Move pkg/testutils and pkg/jsonschema into internal (#418)
01ff6ac 
I think moving these two packages should be pretty uncontroversial since
they're used for testing and validation and we don't expect them to be
imported others.

Part of #399
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ryanslade ryanslade

Labels
enhancement New feature or request
Projects
None yet
Milestone
v1
Development

No branches or pull requests
1 participant
@ryanslade