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.
Description
Refactor codebase to add a
shorten
package. This allows other projects to use this library and closes #34.Some notes:
pkg
is preferred for things that should be public. I could easily move topkg/shorten
. I opted to keep the imports shorter, but let me know if you have a different preference!shorten
package could be moved to their own packages ininternal
. Again, I don't mind doing the refactoring if you'd prefer that.shorten.DefaultConfig()
which returns ashorten.Config
struct that matches the default flag values. I have also changedshorten.New()
so that config is an optional parameter. If not passed, the default config is used.shorten.New()
,shorten.DefaultConfig()
, andShortener.Shorten()
are exposed.Unfortunately, this PR required some major refactoring and will create merge conflicts with any other open PRs.
Let me know if you have any suggestions!
Example: Usage in another project
main.go
Todo