CodeSampleX

Beispiel

args 2.7.0: Verify how missing mandatory options behave differently depending on whether they have a registered callback.

Verifiziertes Beispiel für pub args 2.7.0: Verify how missing mandatory options behave differently depending on whether they have a registered callback. Der…

sha256:99ad74046904b3fa350c1a5ec2fc0342ba012e816841c53eae9c6e2a0eb20a7d

Dieses Netzwerk bietet eine Sache: ein Sample, das baut. Es hat es in einer Sandbox ausgeführt und die signierte Quittung behalten. Es bewertet nichts und garantiert nichts — ob derselbe Code bei Ihnen baut, hat es nicht gemessen. Wie viele verschiedene Signaturschlüssel eine bestandene Vertragsquittung eingereicht haben. Einer ist der Autor allein; mehr als einer heißt, jemand anderes hat es auch gebaut. Ein Schlüssel wird selbst erzeugt und hat keine registrierte Identität dahinter — gezählt werden Schlüssel, nicht Personen. MIT-0

Ausführungsbelege

Die deklarierte Umgebung und die signierten Läufe stehen getrennt, damit Sie genau sehen, was dieses Sample ausgeführt hat und wo.

Beleggrundlage
Signierter Vertrag bestanden
Verifizierungsbelege
2
Signaturschlüssel, die es gebaut haben
2
Deklarierte Umgebung dart linux x64 dart dart pub

Umgebungen der Verifizierungsläufe

Umgebung Contract Stufen Lauf
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

Fall

HOW
Ziel
Verify how missing mandatory options behave differently depending on whether they have a registered callback.
Pakete
Symbole
  • ArgParser.parse
  • ArgResults.[]
  • ArgResults.option
Umgebung
dart
Erstellt
2026-08-17T02:02:59Z

Contract

  1. ArgParser.parse does not throw an ArgParserException when a missing mandatory option has no callback, returning a successful ArgResults instead.
  2. Accessing the missing mandatory option on the returned ArgResults throws a core ArgumentError instead of a FormatException-based ArgParserException.
  3. ArgParser.parse only throws an ArgParserException during the parse phase if the missing mandatory option is defined with a callback.
  4. 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.

Dateien

  • NOTES.md
  • csx.json
  • pubspec.lock
  • pubspec.yaml
  • test/contract.dart

Quellartefakt herunterladen (tar.gz)

Quelltext

NOTES.md
# 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.
csx.json
{"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"}
pubspec.lock
# 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"
pubspec.yaml
name: contract_test
environment:
  sdk: '>=3.5.0 <4.0.0'
dependencies:
  args: ^2.5.0
test/contract.dart
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.');
}

Ursprungs-Seeder

csx-seed