Enhance logging and documentation generation #893
Merged
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
**Added:** - JSONOutput type for structured logging - Support for multiple output types (Plain, Color, JSON) in PrettyHandler - Log level filtering in PrettyHandler **Changed:** - Improved color handling for different log levels in ColorOutput - Refactored ConfigureLogger to support multiple handlers - Updated LogAndReturnError to use errors.New instead of fmt.Errorf - Split logging functionality into separate files for better organization **Removed:** - Dependency on github.com/fatih/color package for colorization - Unused functions: outputToFile and colorizeBasedOnLevel in PrettyHandler **Fixed:** - Removed unused functions to improve code cleanliness and maintainability
**Added:** - Added the `golang.org/x/tools/go/packages` dependency to `go.mod` for improved package loading in docs generation. - Implemented `formatParams` and `formatResults` functions in `docGeneration.go` for better function signature formatting using `go/types`. **Changed:** - Refactored `docs/docGeneration.go` to use `packages.Load` instead of `parser.ParseDir`, eliminating the need for temporary directories. - Modified function signatures in `docGeneration.go` to include `go/types` information for more accurate documentation. - Updated error formatting in `dev/mage/mageutils.go` by removing colored error messages and using `%w` for error wrapping. **Removed:** - Removed temporary directory creation and file copying in documentation generation. - Eliminated dependency on `go/parser` and manual AST parsing in `docGeneration.go`. - Removed `outputToFile` and `colorizeBasedOnLevel` functions from `logging/prettyhandler.go`. - Dropped the `github.com/mattn/go-isatty` dependency from `go.mod` and `logging/prettyhandler.go`.
**Added:** - Enhance CreatePackageDocs with better file system handling - Add debug logging for file system operations - Introduce helper functions for common test setup tasks **Changed:** - Refactor TestCreatePackageDocs for improved readability - Update file system setup to use temporary directories - Modify test cases to use new helper functions **Removed:** - Remove unused code in docGeneration.go - Eliminate redundant type information extraction in createFunctionDoc
l50-renovate-bot
bot
added
area/dev
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.
Key Changes:
Added:
Changed:
Removed: