You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
refactor(config,cli_tools)!: Improved initialization params and docs - #151
No actionable comments were generated in the recent review.
Walkthrough
Commands now control whether unmatched positional arguments are accepted. Command usage definitions accept invocation and summary values. Runner and completion code use command-level settings, and the better runner skips log-level updates during completion.
Changes: Command configuration
Layer / File(s)
Summary
Command settings and usage metadata packages/config/lib/src/config/arg_parser/command_definition.dart, packages/config/lib/src/command/abstract_command.dart, packages/config/lib/src/command/command.dart, packages/config/test/command/*, packages/config/test/config/arg_parser/*
Commands expose ignoreUnexpectedPositionalArgs, defaulting to false, and command constructors accept invocation and summary. Tests verify the values are forwarded and retained in usage definitions.
Runner configuration and completion packages/config/lib/src/command/command_runner.dart, packages/config/lib/src/command/completion/completion_engine.dart, packages/config/test/command/command_line_run_test.dart, packages/config/test/command/completion/*, packages/cli_tools/test/analytics/command_line_properties_test.dart
The runner-level positional-argument setting is removed. Configuration resolution and positional completion now use the command’s setting. Tests and fixtures set the setting on leaf commands.
serverpod/cli_tools#142: Updates the command framework and related command runner and command parameters.
serverpod/cli_tools#145: Changes CommandRunner parameters and passes parser settings through to parsing.
serverpod/cli_tools#149: Changes command runner usage settings and completion-related behavior.
Suggested reviewers:nielsenko
Merge Risk: Minimal · up to a3da3
This refactor moves the handling of unexpected positional arguments from the runner to individual commands and adds invocation and summary options to commands. No concrete defects were found. The runner-parameter removal is an intentional breaking change that downstream users must adapt to.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title uses a conventional commit prefix and names the scope (config, cli_tools) and the breaking-change marker. The changeset moves ignoreUnexpectedPositionalArgs from CommandRunner to individual …
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title uses a conventional commit prefix and names the scope (config, cli_tools) and the breaking-change marker. The changeset moves ignoreUnexpectedPositionalArgs from CommandRunner to individual leaf commands, adds invocation and summary parameters to command constructors, and removes related documentation. The title 'Improved initialization params and docs' refers to real parts of the change, including the constructor parameter refactor and documentation updates. It does not name the main behavioral shift, so it is partially related rather than fully specific.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info
Run configuration
Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Repository UI
Review profile: CHILL
Plan: Essentials
Run ID: b7e1ec39-3bfc-402e-a79e-30960f2280fa
Commits
Reviewing files that changed from the base of the PR and between 5628537 and a3da36a.
Included review availability: This review used your included allowance. 2 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 3 reviews per hour.
This file contains hidden or 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
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.
Summary by CodeRabbit