[cli_config] Introduce sync method (#246)

Co-authored-by: Moritz <[email protected]>

pkgs/cli_config/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.0
+
+- **Breaking Change** Rename `Config.fromArgs` to `Config.fromArguments`.
+- Add `Config.fromArgumentsSync`.
+
 ## 0.1.2
 
 - Add usage docs to the readme.

pkgs/cli_config/README.md

@@ -60,11 +60,11 @@ In the API they are made available lower-cased and with underscores, and
 ## Example usage
 
 This example creates a configuration which first looks for command-line defines
-in the `args` list then looks in `Platform.environment`, then looks in any local
-configuration file.
+in the `arguments` list then looks in `Platform.environment`, then looks in any
+local configuration file.
 
 ```dart
-final config = await Config.fromArgs(args: args);
+final config = await Config.fromArguments(arguments: arguments);
 final pathValue =
     config.optionalPath('my_path', resolveUri: true, mustExist: false);
 print(pathValue?.toFilePath());

pkgs/cli_config/example/bin/cli_config_example.dart

@@ -5,7 +5,7 @@
 import 'package:cli_config/cli_config.dart';
 
 Future<void> main(List<String> args) async {
-  final config = await Config.fromArgs(args: args);
+  final config = await Config.fromArguments(arguments: args);
   final myPath =
       config.optionalPath('my_path', resolveUri: true, mustExist: false);
   print(myPath?.toFilePath());

pkgs/cli_config/lib/src/config.dart

@@ -165,7 +165,7 @@ class Config {
 
   /// Constructs a config by parsing CLI arguments and loading the config file.
   ///
-  /// The [args] must be commandline arguments.
+  /// The [arguments] must be commandline arguments.
   ///
   /// If provided, [environment] must be a map containing environment variables.
   /// If not provided, [environment] defaults to [Platform.environment].
@@ -175,12 +175,12 @@ class Config {
   /// If not provided, [workingDirectory] defaults to [Directory.current].
   ///
   /// This async constructor is intended to be used directly in CLI files.
-  static Future<Config> fromArgs({
-    required List<String> args,
+  static Future<Config> fromArguments({
+    required List<String> arguments,
     Map<String, String>? environment,
     Uri? workingDirectory,
   }) async {
-    final results = CliParser().parse(args);
+    final results = CliParser().parse(arguments);
 
     // Load config file.
     final configFile = results['config'] as String?;
@@ -200,6 +200,43 @@ class Config {
     );
   }
 
+  /// Constructs a config by parsing CLI arguments and loading the config file.
+  ///
+  /// The [arguments] must be commandline arguments.
+  ///
+  /// If provided, [environment] must be a map containing environment variables.
+  /// If not provided, [environment] defaults to [Platform.environment].
+  ///
+  /// If provided, [workingDirectory] is used to resolves paths inside
+  /// [environment].
+  /// If not provided, [workingDirectory] defaults to [Directory.current].
+  ///
+  /// This synchronous constructor is intended to be used directly in CLI files.
+  static Config fromArgumentsSync({
+    required List<String> arguments,
+    Map<String, String>? environment,
+    Uri? workingDirectory,
+  }) {
+    final results = CliParser().parse(arguments);
+
+    // Load config file.
+    final configFile = results['config'] as String?;
+    String? fileContents;
+    Uri? fileSourceUri;
+    if (configFile != null) {
+      fileContents = File(configFile).readAsStringSync();
+      fileSourceUri = Uri.file(configFile);
+    }
+
+    return Config.fromConfigFileContents(
+      commandLineDefines: results['define'] as List<String>,
+      workingDirectory: workingDirectory ?? Directory.current.uri,
+      environment: environment ?? Platform.environment,
+      fileContents: fileContents,
+      fileSourceUri: fileSourceUri,
+    );
+  }
+
   /// Lookup a string value in this config.
   ///
   /// First tries CLI argument defines, then environment variables, and

pkgs/cli_config/pubspec.yaml

@@ -2,7 +2,7 @@ name: cli_config
 description: >-
   A library to take config values from configuration files, CLI arguments, and
   environment variables.
-version: 0.1.2
+version: 0.2.0
 repository: https://github.com/dart-lang/tools/tree/main/pkgs/cli_config
 
 environment:

pkgs/cli_config/test/cli_config_test.dart

@@ -164,8 +164,8 @@ void main() {
         }
       },
     ));
-    final config = await Config.fromArgs(
-      args: [
+    final config = await Config.fromArguments(
+      arguments: [
         '--config',
         configFile.path,
         '-Dbuild.out_dir=path/in/cli_arguments/',
@@ -194,15 +194,24 @@ void main() {
         }
       },
     ));
-    final config = await Config.fromArgs(
-      args: [
+
+    final config = await Config.fromArguments(
+      arguments: [
         '--config',
         configFile.path,
       ],
     );
-
     final result = config.optionalPath('build.out_dir');
     expect(result!.path, resolvedPath.path);
+
+    final configSync = Config.fromArgumentsSync(
+      arguments: [
+        '--config',
+        configFile.path,
+      ],
+    );
+    final resultSync = configSync.optionalPath('build.out_dir');
+    expect(resultSync!.path, resolvedPath.path);
   });
 
   test('provide pre-parsed config', () {