Skip to content
New issue

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

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

Already on GitHub? # to your account

Move packages around to use as library #142

Merged
merged 2 commits into from
Apr 6, 2021
Merged

Conversation

InTheCloudDan
Copy link
Contributor

@InTheCloudDan InTheCloudDan commented Mar 9, 2021

  • Move coderefs out of pkg directory which is legacy and remove pkg
  • alias and search moved from Internal
  • Make generateAliases a public function

There is additional work that could be done to decouple code references further but this is a first step.

For my use case search may not need to be moved but it already has public methods.

If the change proposed looks reasonable then the following is a TODO:

  • Add documentation around using as a library.

@InTheCloudDan InTheCloudDan marked this pull request as ready for review March 9, 2021 18:15
@InTheCloudDan InTheCloudDan requested a review from vlymar March 9, 2021 18:15
@vlymar
Copy link
Contributor

vlymar commented Mar 15, 2021

Hey @InTheCloudDan, thanks for the heavy lifting here!

Move coderefs out of pkg directory which is legacy and remove pkg

Can you share more about pkg being legacy? I believe we followed the patterns in https://github.com/golang-standards/project-layout for this project but could see that being outdated now.

@InTheCloudDan
Copy link
Contributor Author

@vlymar it looks like this issue is still open on it: golang-standards/project-layout#10

They do reference this tweet from Brad Fitzpatrick though about it being legacy: https://twitter.com/bradfitz/status/1039512487538970624

Copy link
Contributor

@vlymar vlymar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry this review took so long! Thanks for linking that github issues thread, interesting stuff.

add basic library usage doc
@InTheCloudDan InTheCloudDan requested a review from yusinto March 26, 2021 14:54
Copy link
Contributor

@yusinto yusinto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the slowness, I have no excuses. Looks good to me, thank you for doing this.

@InTheCloudDan InTheCloudDan merged commit ffe8c9f into master Apr 6, 2021
@InTheCloudDan InTheCloudDan deleted the dob/makeLibrary branch April 6, 2021 21:17
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants