approval_tests 1.4.0

approval_tests: ^1.4.0 copied to clipboard

Testing #

• Ensured test/approval_test.dart invokes every suite under test/groups, so the aggregated run covers all group-level tests.
• Restored synchronous verification helpers and reporter interfaces to maintain backwards compatibility for 1.x consumers.

Improvements #

• Normalized JSON conversion to produce valid output for any map keys and optional class wrappers.
• Preserved whitespace during comparisons by updating ApprovalUtils.readFile and FileComparator.
• Ensured received files delete even when result logging is disabled.
• Reset ScrubDates counters per invocation and removed double separators from namer outputs.
• Hardened diff tooling by validating Git/diff arguments, improving reporting.
• Documented the deterministic query workflow and reporter argument handling in README.md.

Testing #

• Added regression coverage for whitespace comparisons, date scrubbing, converter encoding, and options copy semantics.
• Introduced deterministic stubs for network query tests and refreshed related approvals.
• Added reporter regression tests covering Git/Diff custom command execution and argument expansion.

Indexed Namer #

• Added the IndexedNamer. This class allows you to create a Namer that includes an index in the file name. It is useful when you need to multiple verify calls in a single test.
  • Please see the Indexed Namer Example

URL Updates #

• Updated URLs in LICENSE to use HTTPS.
• Updated the license badge URL in README.md to use HTTPS.

Code Refactoring #

• Removed the makeNamer factory method in lib/src/approvals.dart and replaced it with copyWith for creating Namer instances.
• Added a _normalizeContent method in lib/src/comparator/file_comparator.dart to standardize line endings and trim whitespace for file comparisons.

Documentation Adjustments #

• Removed the Pub popularity badge from README.md.

Other Changes #

• Added the --generate-notes option to the gh release create command in .github/workflows/publish.yml.
• Updated example/main.dart to use a Namer with a subfolder and a CommandLineReporter in verifyAll.

• Upgraded all dependencies to actuals.

• Updated README.md file: fix links.

• Added CLI additional options:
  Usage: dart run approval_tests:review [arguments]
  • Arguments:
    • --help Print this usage information.
    • --list Print a list of project .received.txt files.
    • <index> Review an .received.txt file indexed by --list.
    • <path/to/.received.txt> Review an .received.txt file.

• Updated README.md file.

• Breaking release:
  • Added new reporter: GitReporter. It allows you to use git to view the differences between the received and approved files.
  • Added support to approve files using CLI. Now you can approve files using the command line: dart run approval_tests:review
  • Added support to use ApprovalTests during widget tests.
  • Added header to generated files. For resolved issues you can add this to approved files:
    '# This file was generated by approval_tests. Please do not edit.\n'
  • Some minor changes and code improvements. Thanks to Richard Coutts

• Initial major release.

• Updated documentation.
• Updated dependencies.
• Updated README.md file.
• Updated TODO.md file.
• Rewrited comparators. Now it is only FileComparator.
• Rewrited Scrubbers: regex scrubber, date scrubber.
• Now, first run automatically create approved snapshot. You can approve another snapshot by setting approveResult to true and using Diff Tool.
• Completely rewritten CommandLineReporter. There were changes with the comparison method, as well as highlighting by color the places where there are differences. Green - approved. White text on red background - Differences in received file.
• Internal updates such as:
  • Adding android studio installation via github actions to test Diff Reporter on different devices.
  • Full code test coverage after significant changes.
  • Changes to getting file name and path depending on platform.

• Updated dependencies. Removed dcli package.
• Issue https://github.com/approvals/ApprovalTests.Dart/issues/3 was fixed.
• Minor changes: IDEComparator now gets the current StackTrace if an error occurs.

• Updated dependencies and actions versions.
• Updated Logger's output: now it is more informative.
• Updated CONTRIBUTING.md file: added Arlo's Commit Notation.

• Added setup visual studio code action to the build_and_test workflow for test IDEComparator.

• Completed coverage of the project with tests. Now the project has 100% coverage.

• Autopublish to pub.dev if the version in pubspec.yaml has been changed by auto adding a new tag to the repositories.
• Codecov added to github actions. Codecov badge, graph was added to README.md.
• Added mdsnippets to github actions. And example snippets added to README.md.
• Added ApprovalTests.Dart.StarterProject. You can find it in the README.md file.

• Fix with default file path if package from pub.dev.
• Gilded rose moved to starter project.
• Code formatted.

• Test publish action with new version: v0.3.8.

• Updated pubspec.yaml file: changed homepage.

• The repository has been moved to Approvals.
• Fixed bug with checking of strings received from txt file.
• Added Github Actions.
• Added dependabot.
• Updated README.md file.
• Updated TODO.md file.

• Updated README.md file.

• Default lints replaced by sizzle_lints.
• Updated analysis_options file.
• Updated README.md file.

• Updated README.md file.

• Approval was refactored.
• Added tests.
• Code formatted.
• deleteReceivedFile field was added to the ApprovalTests class. If it is set to true, the received file will be deleted after test. By default, it is set to false.
• logErrors field was added to the ApprovalTests class. If it is set to true, the errors will be logged. By default, it is set to true.
• logResults field was added to the ApprovalTests class. If it is set to true, the success results will be logged. By default, it is set to true.

• Fix: approval_dart changed to approval_tests.
• Code formatted.

• I rewrote the main functions of the class. Now you can use several comparison options.
• Added methods for comparing JSON strings.
• Added methods for array comparison.
• Improved documentation.
• Added more examples: each method has its own small example.

• Added verifyAll method to verify array of items (or use array as inputs).
• Added verifyAllCombinationsAsJson method to verify all combinations of items as JSON.
• Updated README.md file.

• Updated README.md file.

• Updated README.md file: added examples, more info.

• Comparator completed, some refactoring. Updated README.md file.

• Some updates with README.md file.

• First working version, need to expand functionality and add more flexibilty. Also need to add more tests.

• Initial version.