-
Notifications
You must be signed in to change notification settings - Fork 51
refact: refactored the package into multiple specialized sub-packages #106
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
Conversation
6cfc090 to
e0e634f
Compare
f7fd902 to
939a046
Compare
939a046 to
472ab3c
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #106 +/- ##
==========================================
+ Coverage 90.08% 90.40% +0.32%
==========================================
Files 31 36 +5
Lines 1826 1835 +9
==========================================
+ Hits 1645 1659 +14
+ Misses 146 142 -4
+ Partials 35 34 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
472ab3c to
1ebdad1
Compare
1ebdad1 to
3488569
Compare
This clarifies the dependencies between the various utilities exposed by this package. Ultimately (not in this PR), we may convert some of the sub-packages into go modules, so as to isolate dependencies and allow users of some of the features not to be polluted by cross-dependencies. * refactored mangling to remove package state Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
3488569 to
e361832
Compare
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.
Pull Request Overview
This PR refactors the package into multiple specialized sub-packages to clarify dependencies and prepare for eventual modularization using Go modules. The changes involve updating deprecation messages, reorganizing packages (with several files moving from the “swag” package to their respective specialized packages), and updating corresponding documentation.
- Update deprecation messages in interface files.
- Split code into specialized sub-packages and adjust package declarations.
- Revise documentation across multiple packages to reflect the new structure.
Reviewed Changes
Copilot reviewed 41 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| jsonutils_iface.go | Updated deprecation comment for WriteJSON |
| jsonutils/doc.go | Added documentation for the jsonutils package |
| jsonname_iface_test.go | Updated test for deprecation on NameProvider |
| jsonname_iface.go | Added deprecation aliases for jsonname functions |
| jsonname/name_provider_test.go | Changed package from swag to jsonname for tests |
| jsonname/name_provider.go | Updated package name and documentation comments |
| jsonname/doc.go | Added documentation for the jsonname package |
| fileutils_iface_test.go | Added tests for deprecated fileutils functionality |
| fileutils_iface.go | Added deprecation aliases for fileutils functions |
| fileutils/path_test.go | Changed package from swag to fileutils |
| fileutils/path.go | Changed package from swag to fileutils and minor comment improvement |
| fileutils/file_test.go | Changed package from swag to fileutils |
| fileutils/file.go | Changed package from swag to fileutils |
| fileutils/doc.go | Added documentation for the fileutils package |
| doc.go | Updated package-level documentation to note deprecation of package-level members |
| conv/doc.go | Revised documentation for the conv package with updated formatting |
| cmdutils_iface_test.go | Added tests for the cmdutils interface |
| cmdutils_iface.go | Added deprecation alias for CommandLineOptionsGroup |
| cmdutils/doc.go | Added documentation for the cmdutils package |
| cmdutils/cmd_utils.go | Added new file detailing command line utility structures |
Comments suppressed due to low confidence (1)
fileutils/path.go:23
- Consider capitalizing 'gopath' to 'GOPATH' in the comment for consistency with the constant's value.
// GOPATHKey represents the env key for gopath
This clarifies the dependencies between the various utilities exposed by this package.
Ultimately (not in this PR), we may convert some of the sub-packages into go modules, so as to isolate dependencies and allow users of some of the features not to be polluted by cross-dependencies.