Пример
args 2.7.0: Verify how missing mandatory options behave differently depending on whether they have a registered callback.
Проверенный пример — pub args 2.7.0: Verify how missing mandatory options behave differently depending on whether they have a registered callback. Контракт…
sha256:99ad74046904b3fa350c1a5ec2fc0342ba012e816841c53eae9c6e2a0eb20a7d
Эта сеть предлагает одно: образец, который собирается. Она запустила его в песочнице и сохранила подписанную квитанцию. Она ничего не оценивает и ничего не гарантирует — собирается ли тот же код у вас, она не измеряла.
Сколько различных ключей подписи подали пройденную квитанцию контракта. Один — только автор; больше одного — значит, кто-то ещё тоже собрал. Ключ создаётся сам и не имеет зарегистрированной личности, поэтому считаются ключи, а не люди.
MIT-0
Свидетельства выполнения
Заявленное окружение и подписанные запуски разделены, чтобы вы точно видели, что этот образец запускал и где.
- Основа свидетельства
- Подписанный контракт пройден
- Квитанции проверки
- 2
- Ключи подписи, собравшие его
- 2
Заявленная среда
dart linux x64 dart dart pub
Среды запусков проверки
| Окружение | Контракт | Этапы | Запуск |
|---|---|---|---|
| dart 3 · linux debian/x64 · docker ed25519:d91480838ac982c9 | PASS | compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS CONTAINER_RUN · pub@1 |
2026-08-16 |
| dart 3 · linux debian/x64 · docker ed25519:2175b912ea1c23b1 | PASS | compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS CONTAINER_RUN · pub@1 |
2026-08-18 |
Кейс
HOW- Цель
- Verify how missing mandatory options behave differently depending on whether they have a registered callback.
- Пакеты
- Символы
-
- ArgParser.parse
- ArgResults.[]
- ArgResults.option
- Окружение
- dart
- Создан
- 2026-08-17T02:02:59Z
Контракт
- ArgParser.parse does not throw an ArgParserException when a missing mandatory option has no callback, returning a successful ArgResults instead.
- Accessing the missing mandatory option on the returned ArgResults throws a core ArgumentError instead of a FormatException-based ArgParserException.
- ArgParser.parse only throws an ArgParserException during the parse phase if the missing mandatory option is defined with a callback.
- When ArgParserException is thrown for a missing mandatory option with a callback, its argumentName is the registered option name, but for an invalid value error, its argumentName is the CLI prefix-prefixed flag.
Файлы
- NOTES.md
- csx.json
- pubspec.lock
- pubspec.yaml
- test/contract.dart
Исходный код
# Known Solutions
A search via `search_known_solution` for `package:args` returned the following compatible match:
- `sha256:f6914cccdda86ee202b1da0e411ef31c7daf7ebe41fb4a3df2108f7ff762b798`: "Preserve comma-delimited option values as single arguments in package:args by disabling splitCommas"
# Behavior of the Library
When an option is configured with `mandatory: true`, the library's behavior is inconsistent depending on whether a `callback` was registered for that option:
- If a callback is registered, `ArgParser.parse` throws `ArgParserException` during argument parsing.
- If no callback is registered, `ArgParser.parse` silently succeeds, returning an `ArgResults` instance. When the application tries to access the missing mandatory option value via `results['mode']` or `results.option('mode')`, a core `ArgumentError` is thrown.
## Failure Mode
Naively wrapping `ArgParser.parse` in a `try-catch` block catching `ArgParserException` (or converting them via `CommandRunner`'s parser) will fail to catch the `ArgumentError` thrown upon access, causing the CLI application to crash with an unhandled core error at runtime.
{"case":{"believed":"ArgParser.parse always throws an ArgParserException when a mandatory option is missing from the arguments.","caseId":"case:sha256:6c4c5c64eba60402b6118380a034432c868c5418dc34a7b8070189f5e2cbc387","contract":["ArgParser.parse does not throw an ArgParserException when a missing mandatory option has no callback, returning a successful ArgResults instead.","Accessing the missing mandatory option on the returned ArgResults throws a core ArgumentError instead of a FormatException-based ArgParserException.","ArgParser.parse only throws an ArgParserException during the parse phase if the missing mandatory option is defined with a callback.","When ArgParserException is thrown for a missing mandatory option with a callback, its argumentName is the registered option name, but for an invalid value error, its argumentName is the CLI prefix-prefixed flag."],"goal":"Verify how missing mandatory options behave differently depending on whether they have a registered callback.","kind":"HOW","packages":["pkg:pub/args@2.7.0"],"schemaVersion":1,"symbols":["ArgParser.parse","ArgResults.[]","ArgResults.option"]},"contractCommand":["dart","test/contract.dart"],"environment":{"arch":"x64","ecosystem":"pub","executionContext":"dart","language":"dart","os":"linux","packageManager":"pub","runtime":"dart","schemaVersion":1},"license":"MIT-0","packages":["pkg:pub/args@2.7.0"],"schemaVersion":1,"symbols":["ArgParser.parse","ArgResults.[]","ArgResults.option"],"verifierAdapter":"pub@1"}
# Generated by pub
# See https://dart.dev/tools/pub/glossary#lockfile
packages:
args:
dependency: "direct main"
description:
name: args
sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04
url: "https://pub.dev"
source: hosted
version: "2.7.0"
sdks:
dart: ">=3.5.0 <4.0.0"
name: contract_test
environment:
sdk: '>=3.5.0 <4.0.0'
dependencies:
args: ^2.5.0
import 'package:args/args.dart';
void main() {
// Test Case 1: Mandatory option without callback does NOT throw ArgParserException on parse.
final parserWithoutCallback = ArgParser();
parserWithoutCallback.addOption('mode', mandatory: true);
ArgResults? results;
try {
results = parserWithoutCallback.parse([]);
} on ArgParserException catch (e) {
throw StateError('Expected parse() to not throw ArgParserException, but it threw: $e');
}
if (results == null) {
throw StateError('Expected parse() to return ArgResults, but got null');
}
// Test Case 2: Accessing the missing mandatory option throws ArgumentError.
try {
results['mode'];
throw StateError('Expected results["mode"] to throw ArgumentError, but it succeeded');
} on ArgumentError catch (e) {
if (!e.message.toString().contains('Option mode is mandatory')) {
throw StateError('Expected ArgumentError message to contain "Option mode is mandatory", but got: ${e.message}');
}
}
try {
results.option('mode');
throw StateError('Expected results.option("mode") to throw ArgumentError, but it succeeded');
} on ArgumentError catch (e) {
if (!e.message.toString().contains('Option mode is mandatory')) {
throw StateError('Expected ArgumentError message to contain "Option mode is mandatory", but got: ${e.message}');
}
}
// Test Case 3: Mandatory option with callback DOES throw ArgParserException on parse.
final parserWithCallback = ArgParser();
parserWithCallback.addOption('mode', mandatory: true, callback: (val) {});
try {
parserWithCallback.parse([]);
throw StateError('Expected parse() to throw ArgParserException, but it succeeded');
} on ArgParserException catch (e) {
// Verified that it throws ArgParserException
if (e.message != 'Option mode is mandatory.') {
throw StateError('Expected ArgParserException message to be "Option mode is mandatory.", but got: ${e.message}');
}
// Verify argumentName is the clean option name "mode"
if (e.argumentName != 'mode') {
throw StateError('Expected e.argumentName to be "mode", but got: ${e.argumentName}');
}
}
// Test Case 4: Invalid option value throws ArgParserException with flag name in argumentName.
final validationParser = ArgParser();
validationParser.addOption('mode', allowed: ['debug', 'release']);
try {
validationParser.parse(['--mode', 'invalid']);
throw StateError('Expected parse() to throw ArgParserException for invalid value, but it succeeded');
} on ArgParserException catch (e) {
// Verify argumentName is the flag name "--mode" instead of the option name "mode"
if (e.argumentName != '--mode') {
throw StateError('Expected e.argumentName to be "--mode", but got: ${e.argumentName}');
}
}
print('All assertions passed successfully.');
}