Skip to content

Conversation

@felangel
Copy link
Contributor

@felangel felangel commented Mar 30, 2025

Status

READY

Description

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

Summary by CodeRabbit

  • Bug Fixes
    • Improved behavior when no hosted dependencies are detected by logging an informational message and returning a success exit code.
  • Tests
    • Updated test expectations to reflect the adjusted logging, exit status, and command-line usage message order.
    • Enhanced usage string formatting for better readability in test outputs.

@felangel felangel requested a review from a team as a code owner March 30, 2025 03:26
@coderabbitai
Copy link

coderabbitai bot commented Mar 30, 2025

Walkthrough

The changes modify the license check command to treat the absence of hosted dependencies as a non-error condition. Logging behavior is adjusted from error logging to informational logging, and the exit code is updated from an error code to a success code. In addition, the corresponding tests are updated to reflect the new logging order and expected output, and minor formatting improvements in string concatenation are applied in another test file.

Changes

File(s) Change Summary
lib/.../licenses.dart
test/.../licenses_test.dart
Updated logging from _logger.err to _logger.info, and changed exit code from ExitCode.usage.code to ExitCode.success.code. Tests now expect updated dependency messages and reordered usage details.
test/.../flutter_plugin_test.dart Modified expectedUsage from a multiline string to a concatenated string with escaped newline characters for improved readability; added a lint ignore comment.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as PackagesCheckLicensesCommand
    participant L as Logger
    participant E as ExitCode

    U->>C: Run license check command
    C->>C: Check for hosted dependencies
    alt No hosted dependencies found
        C->>L: Log info message
        C->>E: Return success code
    else Dependencies detected
        C->>L: Log appropriate message
        C->>E: Return corresponding exit code
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
License check should pass when no direct dependencies are found (#1260)

Poem

I'm a rabbit, hopping through the code,
Smiling at logs on a lighter load.
No more errors, just info so clear,
A success exit brings a joyful cheer.
Carrots and patches, a bunny's delight,
Leaping in code from morning to night!
🥕🐰


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a2f3e9b and 5acb9d2.

📒 Files selected for processing (3)
  • lib/src/commands/packages/commands/check/commands/licenses.dart (1 hunks)
  • test/src/commands/create/commands/flutter_plugin_test.dart (1 hunks)
  • test/src/commands/packages/commands/check/commands/licenses_test.dart (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • test/src/commands/create/commands/flutter_plugin_test.dart
  • lib/src/commands/packages/commands/check/commands/licenses.dart
  • test/src/commands/packages/commands/check/commands/licenses_test.dart
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: e2e (3.x, test/commands/create/flutter_plugin/flutter_plugin_test.dart)
  • GitHub Check: e2e (3.x, test/commands/create/flutter_package/flutter_pkg_test.dart)
  • GitHub Check: e2e (3.x, test/commands/create/docs_site/docs_site_test.dart)
  • GitHub Check: e2e (3.x, test/commands/create/dart_package/dart_pkg_test.dart)
  • GitHub Check: e2e (3.x, test/commands/create/dart_cli/dart_cli_test.dart)
  • GitHub Check: e2e (3.x, test/commands/create/flutter_app/core_test.dart)
  • GitHub Check: e2e (3.x, test/commands/test/spaced_golden_file_name/spaced_golden_file_name_test.dart)
  • GitHub Check: e2e (3.x, test/commands/test/async_main/async_main_test.dart)
  • GitHub Check: e2e (3.24.0, test/commands/packages/check/licenses/licenses_allowed_test.dart)
  • GitHub Check: e2e (3.24.0, test/commands/create/flutter_plugin/flutter_plugin_test.dart)
  • GitHub Check: e2e (3.24.0, test/commands/create/flutter_package/flutter_pkg_test.dart)
  • GitHub Check: e2e (3.24.0, test/commands/create/docs_site/docs_site_test.dart)
  • GitHub Check: e2e (3.24.0, test/commands/create/flutter_app/core_test.dart)
  • GitHub Check: build
  • GitHub Check: pana

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@felangel felangel force-pushed the fix/license-check-empty-dependencies branch from f5f5d42 to 5acb9d2 Compare March 30, 2025 03:44
@felangel
Copy link
Contributor Author

FYI @wolfenrain @alestiago @erickzanardo

e2e tests are failing because the templates need to be updated to fix the synthetic generation deprecation warning for l10n (https://docs.flutter.dev/release/breaking-changes/flutter-generate-i10n-source)

@wolfenrain
Copy link
Contributor

FYI @wolfenrain @alestiago @erickzanardo

e2e tests are failing because the templates need to be updated to fix the synthetic generation deprecation warning for l10n (https://docs.flutter.dev/release/breaking-changes/flutter-generate-i10n-source)

Yea that was already on my radar 🫡

wolfenrain
wolfenrain previously approved these changes Apr 7, 2025
@alestiago
Copy link
Contributor

Since #1286 the CI should now be all green. There were a few merge conflicts in two test files, I gave a first attempt at quickly resolving them where I could, I'll keep an eye on the pipeline.

@alestiago alestiago changed the title fix: license check should exit 0 when no dependencies found fix!: license check should exit 0 when no dependencies found Jun 17, 2025
@alestiago alestiago enabled auto-merge (squash) June 17, 2025 09:41
@alestiago alestiago merged commit b66d390 into VeryGoodOpenSource:main Jun 17, 2025
30 checks passed
matiasleyba pushed a commit to a-wallen/very_good_cli that referenced this pull request Jul 17, 2025
…dOpenSource#1261)

* fix: license check should exit 0 when no dependencies found

* chore: remove ignore: no_adjacent_strings_in_list

---------

Co-authored-by: Alejandro Santiago <[email protected]>
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.

fix: license check should not treat lack of dependencies as an error

3 participants