Skip to content
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

Fix/upgrade deps #23

Merged
merged 4 commits into from
Feb 18, 2025
Merged

Fix/upgrade deps #23

merged 4 commits into from
Feb 18, 2025

Conversation

yelmuratoff
Copy link
Collaborator

@yelmuratoff yelmuratoff commented Feb 18, 2025

This should be small

Small pull requests are great and easy for me to understand and accept
Please try prefix every commits in the pull request with Arlo's git notation

Prefix Meaning
e development enviroment only - not production
d documentation only
t tests only
R!! Refactoring
B!! Bug Fix
F!! New Feature

But it's not small!

Then you should setup a remote pairing session with Llewellyn ( llewellyn.falco@gmail.com )
Usually the sessions are between 45-90 minutes.

assuming you still feel it is small, please include

Description

A description of what the PR achieves.

The solution

Outline the implementation.
Any tests that are affected.

Notation

I prefer lots of very small commits prefixed with Arlo's git notation

Summary by Sourcery

This pull request updates the ApprovalTests package to version 1.1.6, upgrades dependencies, improves the README with a link to the new starter project, and enhances the documentation with snippets and examples for using verifyAsJson with data models.

Enhancements:

  • Updated the ApprovalTests package to version 1.1.6, including dependency upgrades.
  • Improved the README with a link to the new starter project and information about its features, such as a pre-configured .gitignore, linter, and GitHub Actions CI setup.
  • Enhanced the documentation with snippets and examples for using verifyAsJson with data models, including code and resulting file examples.

Build:

  • Removed the sizzle_lints dependency.
  • Removed the working-directory defaults from the GitHub Actions workflows.

Copy link

sourcery-ai bot commented Feb 18, 2025

Reviewer's Guide by Sourcery

This pull request updates dependencies, refactors the logger, removes Flutter-specific content and example projects, and adjusts workflow configurations. The primary goal is to upgrade the core approval_tests package and streamline the project structure.

Updated class diagram for Logger

classDiagram
  class Logger {
    +static void log(String message)
    +static void error(String message)
    +static void warning(String message)
  }
  note for Logger "Refactored logger class"
Loading

File-Level Changes

Change Details Files
Updated the approval_tests package version and adjusted the README to reflect the removal of Flutter-specific content and update the starter project link.
  • Updated the approval_tests dependency version in pubspec.yaml from 1.1.3 to 1.1.6.
  • Removed Flutter-specific content from the README.
  • Updated the starter project link in the README to Approvaltests.Dart.StarterProject.
README.md
pubspec.yaml
Refactored the logger in approval_tests to use keys for TalkerLogType and use logCustom for success messages.
  • Modified ApprovalLogger to use keys for TalkerLogType in the settings map.
  • Replaced logTyped with logCustom for logging success messages in ApprovalLogger.
lib/src/core/logger/logger.dart
Removed the sizzle_lints package and updated the analysis options.
  • Removed the sizzle_lints package from dev_dependencies.
  • Removed the include for package:sizzle_lints/sizzle_lints.yaml in analysis_options.yaml.
analysis_options.yaml
Removed example projects and related files.
  • Removed the LICENSE.md file.
  • Removed the examples/dart_example directory and all its contents.
  • Removed the examples/flutter_example directory and all its contents.
  • Removed the .gitignore file from the packages/approval_tests directory.
  • Removed the CHANGELOG.md file from the packages/approval_tests directory.
  • Removed the README.md file from the packages/approval_tests directory.
  • Removed the packages/approval_tests_flutter directory and all its contents.
LICENSE.md
examples/dart_example/.gitignore
examples/dart_example/CHANGELOG.md
examples/dart_example/README.md
examples/dart_example/analysis_options.yaml
examples/dart_example/bin/dart_example.dart
examples/dart_example/lib/dart_example.dart
examples/dart_example/pubspec.yaml
examples/dart_example/test/dart_example_test.dart
examples/dart_example/test/dart_example_test.verify_combinations.approved.txt
examples/flutter_example/.gitignore
examples/flutter_example/.metadata
examples/flutter_example/README.md
examples/flutter_example/analysis_options.yaml
examples/flutter_example/android/.gitignore
examples/flutter_example/android/app/build.gradle
examples/flutter_example/android/app/src/debug/AndroidManifest.xml
examples/flutter_example/android/app/src/main/AndroidManifest.xml
examples/flutter_example/android/app/src/main/kotlin/com/richardcoutts/approved/example/MainActivity.kt
examples/flutter_example/android/app/src/main/res/drawable-v21/launch_background.xml
examples/flutter_example/android/app/src/main/res/drawable/launch_background.xml
examples/flutter_example/android/app/src/main/res/values-night/styles.xml
examples/flutter_example/android/app/src/main/res/values/styles.xml
examples/flutter_example/android/app/src/profile/AndroidManifest.xml
examples/flutter_example/android/build.gradle
examples/flutter_example/android/gradle.properties
examples/flutter_example/android/gradle/wrapper/gradle-wrapper.properties
examples/flutter_example/android/settings.gradle
examples/flutter_example/ios/.gitignore
examples/flutter_example/ios/Flutter/AppFrameworkInfo.plist
examples/flutter_example/ios/Flutter/Debug.xcconfig
examples/flutter_example/ios/Flutter/Release.xcconfig
examples/flutter_example/ios/Runner.xcodeproj/project.pbxproj
examples/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata
examples/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
examples/flutter_example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
examples/flutter_example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
examples/flutter_example/ios/Runner.xcworkspace/contents.xcworkspacedata
examples/flutter_example/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
examples/flutter_example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
examples/flutter_example/ios/Runner/AppDelegate.swift
examples/flutter_example/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json
examples/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json
examples/flutter_example/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md
examples/flutter_example/ios/Runner/Base.lproj/LaunchScreen.storyboard
examples/flutter_example/ios/Runner/Base.lproj/Main.storyboard
examples/flutter_example/ios/Runner/Info.plist
examples/flutter_example/ios/Runner/Runner-Bridging-Header.h
examples/flutter_example/ios/RunnerTests/RunnerTests.swift
examples/flutter_example/lib/main.dart
examples/flutter_example/pubspec.yaml
examples/flutter_example/test/.approval_tests/class_names.txt
examples/flutter_example/test/.approval_tests/received_files.txt
examples/flutter_example/test/widget_test.dart
examples/flutter_example/test/widget_test.smoke_test.should_display_0.approved.txt
examples/flutter_example/test/widget_test.smoke_test.should_display_1.approved.txt
packages/approval_tests/.gitignore
packages/approval_tests/CHANGELOG.md
packages/approval_tests/README.md
packages/approval_tests_flutter/.gitignore
packages/approval_tests_flutter/.metadata
packages/approval_tests_flutter/LICENSE
packages/approval_tests_flutter/README.md
packages/approval_tests_flutter/analysis_options.yaml
packages/approval_tests_flutter/lib/approval_tests_flutter.dart
packages/approval_tests_flutter/lib/src/common.dart
packages/approval_tests_flutter/lib/src/get_widget_names.dart
packages/approval_tests_flutter/lib/src/src.dart
packages/approval_tests_flutter/lib/src/widget_meta/collect_widgets_meta_data.dart
packages/approval_tests_flutter/lib/src/widget_meta/expect_meta.dart
packages/approval_tests_flutter/lib/src/widget_meta/load_string_en.dart
packages/approval_tests_flutter/lib/src/widget_meta/matcher_types.dart
packages/approval_tests_flutter/lib/src/widget_meta/register_types.dart
packages/approval_tests_flutter/lib/src/widget_meta/widget_meta.dart
packages/approval_tests_flutter/lib/src/widget_meta/widget_tester_extension.dart
packages/approval_tests_flutter/pubspec.yaml
packages/approval_tests_flutter/test/approval_tests_flutter_test.dart
packages/approval_tests_flutter/test/approval_tests_flutter_test.smoke_test.approved.txt
packages/approval_tests_flutter/test/approved/class_names.txt
Updated dependencies in approval_tests and test_api.
  • Updated the talker dependency from ^4.3.2 to ^4.6.11.
  • Updated the test_api dependency from ^0.7.0 to ^0.7.3.
pubspec.yaml
Removed workflow defaults.
  • Removed defaults from build job in auto_deploy.yml.
  • Removed defaults from build job in build_and_test.yml.
  • Removed defaults from format_and_snippets job in mdsnippets.yml.
.github/workflows/auto_deploy.yml
.github/workflows/build_and_test.yml
.github/workflows/mdsnippets.yml
Removed working directory from publish workflow.
  • Removed working-directory from publish.yml.
.github/workflows/publish.yml
Updated the changelog for approval_tests_flutter.
  • Added a new version entry 1.1.6 to CHANGELOG.md.
CHANGELOG.md
Removed the example JSON file.
  • Removed the test/example/example_test.test_JSON_object.approved.txt file.
test/example/example_test.test_JSON_object.approved.txt

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link

@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.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link

codecov bot commented Feb 18, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@yelmuratoff yelmuratoff merged commit 849f8c1 into main Feb 18, 2025
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants