Add flag to exit with error instead of asking for interaction (#712)

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.2.0
+
+* Adds support for skipping input requests by @Rexios80. Input requests are skipped when:
+  * The `--fvm-skip-input` flag is passed
+  * Running in CI
+* Exits with `ExitCode.unavailable` if the request to install a Flutter version is denied by @Rexios80
+
 ## 3.1.7
 
 * Display the configured version in the `fvm list` command by @digoreis

bin/main.dart

@@ -7,7 +7,16 @@ import 'package:fvm/src/utils/context.dart';
 import 'package:scope/scope.dart';
 
 Future<void> main(List<String> args) async {
-  final scope = Scope()..value(contextKey, FVMContext.create(args: args));
+  final editableArgs = List<String>.from(args);
+  final skipInput = editableArgs.remove('--fvm-skip-input');
+  final scope = Scope()
+    ..value(
+      contextKey,
+      FVMContext.create(
+        args: editableArgs,
+        skipInput: skipInput,
+      ),
+    );
 
   await _flushThenExit(
     await scope.run(() async => FvmCommandRunner().run((args))),

docs/pages/documentation/guides/basic-commands.mdx

@@ -40,6 +40,8 @@ Sets a specific Flutter SDK version for a project, ensuring environment consiste
 -  `-s, --skip-setup`: Omits Flutter setup post-installation for expedited process.
 -  `--skip-pub-get`: Skips resolving dependencies (`flutter pub get`) after switching Flutter SDK.
 
+- `--fvm-skip-input`: Skips requests for user input and uses default values.
+
 ### Examples
 
 **Setting a Specific Version**:  

lib/src/services/logger_service.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:io';
 
 import 'package:dart_console/dart_console.dart';
 import 'package:interact/interact.dart' as interact;
@@ -63,19 +64,39 @@ class LoggerService extends ContextService {
     return progress;
   }
 
-  bool confirm(String? message, {bool? defaultValue}) {
+  bool confirm(String? message, {bool? defaultValue, bool? ciDefaultValue}) {
     // When running tests, always return true.
     if (context.isTest) return true;
 
+    if (context.skipInput) {
+      if (ciDefaultValue != null) {
+        return ciDefaultValue;
+      } else if (defaultValue != null) {
+        return defaultValue;
+      }
+      exit(ExitCode.usage.code);
+    }
+
     return interact.Confirm(prompt: message ?? '', defaultValue: defaultValue)
         .interact();
   }
 
-  String select(String? message, {required List<String> options}) {
+  String select(
+    String? message, {
+    required List<String> options,
+    int? defaultSelection,
+  }) {
+    if (context.skipInput) {
+      if (defaultSelection != null) {
+        return options[defaultSelection];
+      }
+      exit(ExitCode.usage.code);
+    }
+
     final selection = interact.Select(
       prompt: message ?? '',
       options: options,
-      initialIndex: 0,
+      initialIndex: defaultSelection ?? 0,
     ).interact();
 
     return options[selection];

lib/src/utils/context.dart

@@ -56,6 +56,9 @@ class FVMContext with FVMContextMappable {
 
   final List<String> args;
 
+  /// True if the `--fvm-skip-input` flag was passed to the command
+  final bool _skipInput;
+
   /// Generated values
   final Map<Type, dynamic> _dependencies = {};
 
@@ -68,13 +71,15 @@ class FVMContext with FVMContextMappable {
     required this.config,
     required this.environment,
     required this.args,
+    required bool skipInput,
     required this.generators,
     this.isTest = false,
-  });
+  }) : _skipInput = skipInput;
 
   static FVMContext create({
     String? id,
     List<String>? args,
+    bool? skipInput,
     AppConfig? configOverrides,
     String? workingDirectory,
     Map<Type, dynamic>? generatorOverrides,
@@ -96,6 +101,7 @@ class FVMContext with FVMContextMappable {
       config: config,
       environment: environment,
       args: args ?? [],
+      skipInput: skipInput ?? false,
       generators: {
         LoggerService: (context) => LoggerService(
               level: level,
@@ -189,6 +195,9 @@ class FVMContext with FVMContextMappable {
     return kCiEnvironmentVariables.any(Platform.environment.containsKey);
   }
 
+  @MappableField()
+  bool get skipInput => isCI || _skipInput;
+
   T get<T>() {
     if (_dependencies.containsKey(T)) {
       return _dependencies[T] as T;

lib/src/utils/context.mapper.dart

@@ -35,6 +35,9 @@ class FVMContextMapper extends ClassMapperBase<FVMContext> {
       Field('environment', _$environment);
   static List<String> _$args(FVMContext v) => v.args;
   static const Field<FVMContext, List<String>> _f$args = Field('args', _$args);
+  static bool _$_skipInput(FVMContext v) => v._skipInput;
+  static const Field<FVMContext, bool> _f$_skipInput =
+      Field('_skipInput', _$_skipInput, key: 'skipInput');
   static Map<Type, ContextService Function(FVMContext)> _$generators(
           FVMContext v) =>
       v.generators;
@@ -83,6 +86,9 @@ class FVMContextMapper extends ClassMapperBase<FVMContext> {
       Field('configPath', _$configPath);
   static bool _$isCI(FVMContext v) => v.isCI;
   static const Field<FVMContext, bool> _f$isCI = Field('isCI', _$isCI);
+  static bool _$skipInput(FVMContext v) => v.skipInput;
+  static const Field<FVMContext, bool> _f$skipInput =
+      Field('skipInput', _$skipInput);
 
   @override
   final MappableFields<FVMContext> fields = const {
@@ -91,6 +97,7 @@ class FVMContextMapper extends ClassMapperBase<FVMContext> {
     #config: _f$config,
     #environment: _f$environment,
     #args: _f$args,
+    #_skipInput: _f$_skipInput,
     #generators: _f$generators,
     #isTest: _f$isTest,
     #fvmDir: _f$fvmDir,
@@ -107,6 +114,7 @@ class FVMContextMapper extends ClassMapperBase<FVMContext> {
     #versionsCachePath: _f$versionsCachePath,
     #configPath: _f$configPath,
     #isCI: _f$isCI,
+    #skipInput: _f$skipInput,
   };
 
   static FVMContext _instantiate(DecodingData data) {
@@ -116,6 +124,7 @@ class FVMContextMapper extends ClassMapperBase<FVMContext> {
         config: data.dec(_f$config),
         environment: data.dec(_f$environment),
         args: data.dec(_f$args),
+        skipInput: data.dec(_f$_skipInput),
         generators: data.dec(_f$generators),
         isTest: data.dec(_f$isTest));
   }
@@ -187,6 +196,7 @@ abstract class FVMContextCopyWith<$R, $In extends FVMContext, $Out>
       AppConfig? config,
       Map<String, String>? environment,
       List<String>? args,
+      bool? skipInput,
       Map<Type, ContextService Function(FVMContext)>? generators,
       bool? isTest});
   FVMContextCopyWith<$R2, $In, $Out2> $chain<$R2, $Out2>(Then<$Out2, $R2> t);
@@ -230,6 +240,7 @@ class _FVMContextCopyWithImpl<$R, $Out>
           AppConfig? config,
           Map<String, String>? environment,
           List<String>? args,
+          bool? skipInput,
           Map<Type, ContextService Function(FVMContext)>? generators,
           bool? isTest}) =>
       $apply(FieldCopyWithData({
@@ -238,6 +249,7 @@ class _FVMContextCopyWithImpl<$R, $Out>
         if (config != null) #config: config,
         if (environment != null) #environment: environment,
         if (args != null) #args: args,
+        if (skipInput != null) #skipInput: skipInput,
         if (generators != null) #generators: generators,
         if (isTest != null) #isTest: isTest
       }));
@@ -249,6 +261,7 @@ class _FVMContextCopyWithImpl<$R, $Out>
       config: data.get(#config, or: $value.config),
       environment: data.get(#environment, or: $value.environment),
       args: data.get(#args, or: $value.args),
+      skipInput: data.get(#skipInput, or: $value._skipInput),
       generators: data.get(#generators, or: $value.generators),
       isTest: data.get(#isTest, or: $value.isTest));
 

lib/src/workflows/ensure_cache.workflow.dart

@@ -75,10 +75,11 @@ Future<CacheFlutterVersion> ensureCacheWorkflow(
         final shouldInstallConfirmed = logger.confirm(
           'Would you like to install it now?',
           defaultValue: true,
+          ciDefaultValue: false,
         );
 
         if (!shouldInstallConfirmed) {
-          exit(ExitCode.success.code);
+          exit(ExitCode.unavailable.code);
         }
       }
     }

pubspec.yaml

@@ -1,7 +1,7 @@
 name: fvm
 description: A simple cli to manage Flutter SDK versions per project. Support
   channels, releases, and local cache for fast switching between versions.
-version: 3.1.7
+version: 3.2.0
 homepage: https://github.com/leoafarias/fvm
 
 environment: