Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: update logger output type for improved clarity #368

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
Merged
merged 1 commit into from
May 16, 2025
Merged

chore: update logger output type for improved clarity #368

merged 1 commit into from
May 16, 2025

Conversation

@techouse
Copy link
Contributor

@techouse techouse commented May 7, 2025 •
edited by sourcery-ai bot
Loading

This pull request refactors the TalkerLogger class in packages/talker_logger/lib/src/logger.dart to improve type clarity and maintainability. The main changes include introducing a typedef for the logger output function and updating related method signatures, as well as minor cleanup of redundant blank lines.

Type improvements:

  • Introduced a new typedef LoggerOutput to represent the logger output function (typedef LoggerOutput = void Function(String message);) and replaced all instances of void Function(String message) with LoggerOutput in the TalkerLogger class. [1] [2] [3]

Code cleanup:

  • Removed redundant blank lines in the debug, verbose, info, and good logging methods for better readability. [1] [2] [3]

Summary by Sourcery

Improve type clarity and maintainability of the TalkerLogger class by introducing a typedef for logger output and cleaning up code structure

Enhancements:

  • Introduced a new typedef LoggerOutput to standardize logger output function type
  • Simplified the copyWith method using arrow syntax
  • Removed redundant blank lines to improve code readability

Chores:

  • Updated method signatures to use the new LoggerOutput type

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 7, 2025 •
edited
Loading

Reviewer's Guide

This pull request refactors TalkerLogger by introducing a LoggerOutput typedef to standardize the logger output function signature, applying this typedef across the class. Code readability was also improved by removing redundant blank lines and reformatting the copyWith method.

File-Level Changes

Change Details Files
Enhanced type clarity for logger output function.
  • Defined a new LoggerOutput typedef for void Function(String message).
  • Updated the constructor parameter output to use LoggerOutput.
  • Updated the internal _output field to use LoggerOutput.
  • Updated the copyWith method's output parameter to use LoggerOutput.
 packages/talker_logger/lib/src/logger.dart
Improved code readability and conciseness.
  • Removed redundant blank lines before debug, verbose, and info methods.
  • Refactored the copyWith method to use an arrow function and a more compact style.
 packages/talker_logger/lib/src/logger.dart
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.85%. Comparing base (477f045) to head (d5447a2).
Report is 28 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

❗ There is a different number of reports uploaded between BASE (477f045) and HEAD (d5447a2). Click for more details.

HEAD has 9 uploads less than BASE
Flag BASE (477f045) HEAD (d5447a2)
10 1
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #368      +/-   ##
==========================================
- Coverage   98.17%   92.85%   -5.32%     
==========================================
  Files          28        9      -19     
  Lines         603       84     -519     
==========================================
- Hits          592       78     -514     
+ Misses         11        6       -5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sourcery-ai[bot]
sourcery-ai bot reviewed May 7, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @techouse - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Frezyx
Copy link
Owner

Frezyx commented May 16, 2025

Hello @techouse !
Thank you for this contribution ❤️
This changes will be available in next release

@Frezyx Frezyx merged commit d002f02 into Frezyx:master May 16, 2025
1 check passed
@techouse techouse deleted the chore/talker-logger-output-typedef branch May 16, 2025 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@Frezyx Frezyx Frezyx approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@techouse @codecov-commenter @Frezyx