feat: allow FFCLI to be installed as a dev dependency (invertase#401)

Author: russellwheatley

README.md

@@ -37,12 +37,47 @@ on this path: `.dart_tool/pub/bin/flutterfire_cli_monorepo/*.snapshot`. This wil
 
 ## Install
 
+### Global Installation
+
 To install, run the following command:
 
 ```bash
 dart pub global activate flutterfire_cli
 ```
 
+### Dev Dependency (Beta)
+
+It is now possible to install as a dev dependency:
+
+```bash
+dart pub add --dev flutterfire_cli
+```
+**important** - remember to deactivate your current global installation of `flutterfire_cli`.
+
+To run flutterfire commands from your dev dependency:
+
+```bash
+dart run flutterfire_cli:flutterfire [COMMAND]
+```
+
+It might be worth creating an alias in your shell of choice, if you're using zsh shell, it might look like:
+
+```bash
+echo 'alias flutterfire="dart run flutterfire_cli:flutterfire"' >> ~/.zshrc
+```
+
+This will allow you to run commands like previously from within your Flutter app:
+
+```bash
+flutterfire configure
+```
+
+Remember to update or open a new terminal window so alias change is applied.
+
+This feature is in Beta, if you find any bugs, please file a new issue on the repo.
+
+#### Installation Requirements for Global and Dev Dependency
+
 - FlutterFire CLI requires the Firebase CLI (`firebase-tools`) to be installed on your local machine, [follow these instructions](https://firebase.google.com/docs/cli) for installation.
 - If you're running on a windows machine, we highly recommend you install via npm (i.e. `npm install -g firebase-tools`). The standalone
 `firebase-tools` version can cause problems which you can read about [here](https://github.com/invertase/flutterfire_cli/issues/55#issuecomment-1316201478).

packages/flutterfire_cli/lib/src/commands/base.dart

@@ -15,6 +15,8 @@
  *
  */
 
+import 'dart:io';
+
 import 'package:args/args.dart';
 import 'package:args/command_runner.dart';
 import 'package:cli_util/cli_logging.dart';
@@ -65,6 +67,20 @@ abstract class FlutterFireCommand extends Command<void> {
     if (flutterApp == null) {
       throw FlutterAppRequiredException();
     }
+    _warnUserIfRunningGlobally();
+  }
+
+  // Warns user if they have a dev dependency on flutterfire_cli and are running globally
+  void _warnUserIfRunningGlobally() {
+    final scriptPath = Platform.script.toFilePath();
+
+    // Check if we're in a .dart_tool directory (dev dependency)
+    if (!scriptPath.contains('.dart_tool') &&
+        flutterApp!.dependsOnPackage('flutterfire_cli')) {
+      logger.stdout(
+        "If you're trying to run FlutterFire CLI as a dev dependency, you need to run `dart run flutterfire_cli:flutterfire` instead of `flutterfire`",
+      );
+    }
   }
 
   /// Overridden to support line wrapping when printing usage.

packages/flutterfire_cli/lib/src/commands/config.dart

@@ -564,7 +564,7 @@ class ConfigCommand extends FlutterFireCommand {
   @override
   Future<void> run() async {
     // Has to set during `run()` otherwise `argResults` will be null
-    updateDebugMode(argResults!['debug']as bool);
+    updateDebugMode(argResults!['debug'] as bool);
     try {
       commandRequiresFlutterApp();
       final reconfigured = await checkIfUserRequiresReconfigure();
@@ -659,7 +659,7 @@ class ConfigCommand extends FlutterFireCommand {
             iosInputs != null) {
           final firebaseJsonWrite = await appleWrites(
             platformOptions: fetchedFirebaseOptions.iosOptions!,
-            flutterAppPath: flutterApp!.package.path,
+            flutterApp: flutterApp!,
             serviceFilePath: iosInputs!.serviceFilePath,
             logger: logger,
             buildConfiguration: iosInputs?.buildConfiguration,
@@ -676,7 +676,7 @@ class ConfigCommand extends FlutterFireCommand {
             macosInputs != null) {
           final firebaseJsonWrite = await appleWrites(
             platformOptions: fetchedFirebaseOptions.macosOptions!,
-            flutterAppPath: flutterApp!.package.path,
+            flutterApp: flutterApp!,
             serviceFilePath: macosInputs!.serviceFilePath,
             logger: logger,
             buildConfiguration: macosInputs?.buildConfiguration,

packages/flutterfire_cli/lib/src/commands/reconfigure.dart

@@ -156,6 +156,7 @@ class Reconfigure extends FlutterFireCommand {
         platform: platform,
         logger: logger,
         projectConfiguration: ProjectConfiguration.buildConfiguration,
+        isDevDependency: flutterApp!.dependsOnPackage('flutterfire_cli'),
       );
 
       final buildConfigurations = getNestedMap(
@@ -196,6 +197,7 @@ class Reconfigure extends FlutterFireCommand {
         platform: platform,
         logger: logger,
         projectConfiguration: ProjectConfiguration.defaultConfig,
+        isDevDependency: flutterApp!.dependsOnPackage('flutterfire_cli'),
       );
 
       await _writeFile(
@@ -230,6 +232,7 @@ class Reconfigure extends FlutterFireCommand {
           platform: platform,
           logger: logger,
           projectConfiguration: ProjectConfiguration.target,
+          isDevDependency: flutterApp!.dependsOnPackage('flutterfire_cli'),
         );
         // ignore: cast_nullable_to_non_nullable
         final configuration = targets[key] as Map<String, dynamic>;
@@ -374,6 +377,7 @@ class Reconfigure extends FlutterFireCommand {
   @override
   Future<void> run() async {
     try {
+      commandRequiresFlutterApp();
       final firebaseJson = File(
         path.join(
           flutterApp!.package.path,

packages/flutterfire_cli/lib/src/common/utils.dart

@@ -515,7 +515,7 @@ void validateAppBundleId(
   String platform,
 ) {
   final bundleIdRegex = RegExp(
-  r'^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?|([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)+))$',
+    r'^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?|([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)+))$',
   );
 
   if (!bundleIdRegex.hasMatch(bundleId)) {
@@ -541,6 +541,7 @@ void validateAndroidPackageName(String appId) {
 
 String firebaseCLIJsonParse(String output) {
   // Sometimes the response has an appended time out exception which breaks parsing
-  final regex = RegExp(r'\}\s*\{\s*"status":\s*"error",\s*"error":\s*"Timed out."\s*\}');
+  final regex =
+      RegExp(r'\}\s*\{\s*"status":\s*"error",\s*"error":\s*"Timed out."\s*\}');
   return output.replaceFirst(regex, '}');
 }

packages/flutterfire_cli/lib/src/firebase/firebase_apple_writes.dart

@@ -7,6 +7,7 @@ import 'package:yaml/yaml.dart';
 
 import '../common/utils.dart';
 import '../firebase/firebase_options.dart';
+import '../flutter_app.dart';
 
 const debugSymbolScriptName =
     'FlutterFire: "flutterfire upload-crashlytics-symbols"';
@@ -15,7 +16,7 @@ const bundleServiceScriptName =
 
 Future<FirebaseJsonWrites> appleWrites({
   required String platform,
-  required String flutterAppPath,
+  required FlutterApp flutterApp,
   required String serviceFilePath,
   required FirebaseOptions platformOptions,
   required Logger logger,
@@ -27,7 +28,7 @@ Future<FirebaseJsonWrites> appleWrites({
     case ProjectConfiguration.buildConfiguration:
       return FirebaseAppleBuildConfiguration(
         platformOptions: platformOptions,
-        flutterAppPath: flutterAppPath,
+        flutterApp: flutterApp,
         serviceFilePath: serviceFilePath,
         logger: logger,
         platform: platform,
@@ -38,7 +39,7 @@ Future<FirebaseJsonWrites> appleWrites({
     case ProjectConfiguration.defaultConfig:
       return FirebaseAppleTargetConfiguration(
         platformOptions: platformOptions,
-        flutterAppPath: flutterAppPath,
+        flutterApp: flutterApp,
         serviceFilePath: serviceFilePath,
         logger: logger,
         platform: platform,
@@ -53,15 +54,15 @@ Future<FirebaseJsonWrites> appleWrites({
 class FirebaseAppleTargetConfiguration extends FirebaseAppleConfiguration {
   FirebaseAppleTargetConfiguration({
     required FirebaseOptions platformOptions,
-    required String flutterAppPath,
+    required FlutterApp flutterApp,
     required String serviceFilePath,
     required Logger logger,
     required String platform,
     required ProjectConfiguration projectConfiguration,
     required this.target,
   }) : super(
           platformOptions: platformOptions,
-          flutterAppPath: flutterAppPath,
+          flutterApp: flutterApp,
           serviceFilePath: serviceFilePath,
           logger: logger,
           platform: platform,
@@ -123,10 +124,11 @@ end
 
     final debugSymbolScriptAdded = await addFlutterFireDebugSymbolsScript(
       target: target,
-      flutterAppPath: flutterAppPath,
+      flutterAppPath: flutterApp.package.path,
       logger: logger,
       platform: platform,
       projectConfiguration: projectConfiguration,
+      isDevDependency: flutterApp.dependsOnPackage('flutterfire_cli'),
     );
 
     return _firebaseJsonWrites(debugSymbolScriptAdded, target);
@@ -141,15 +143,15 @@ end
 class FirebaseAppleBuildConfiguration extends FirebaseAppleConfiguration {
   FirebaseAppleBuildConfiguration({
     required FirebaseOptions platformOptions,
-    required String flutterAppPath,
+    required FlutterApp flutterApp,
     required String serviceFilePath,
     required Logger logger,
     required String platform,
     required ProjectConfiguration projectConfiguration,
     required this.buildConfiguration,
   }) : super(
           platformOptions: platformOptions,
-          flutterAppPath: flutterAppPath,
+          flutterApp: flutterApp,
           serviceFilePath: serviceFilePath,
           logger: logger,
           platform: platform,
@@ -185,7 +187,7 @@ class FirebaseAppleBuildConfiguration extends FirebaseAppleConfiguration {
     } else {
       // iOS is bundled in the root of the app bundle
       command =
-          'flutterfire bundle-service-file --plist-destination="\${BUILT_PRODUCTS_DIR}/\${PRODUCT_NAME}.app" --build-configuration=\${CONFIGURATION} --platform=$platform --apple-project-path="\${SRCROOT}"';
+          '${flutterApp.dependsOnPackage('flutterfire_cli') ? 'dart run flutterfire_cli:flutterfire' : 'flutterfire'} bundle-service-file --plist-destination="\${BUILT_PRODUCTS_DIR}/\${PRODUCT_NAME}.app" --build-configuration=\${CONFIGURATION} --platform=$platform --apple-project-path="\${SRCROOT}"';
     }
 
     return '''
@@ -226,10 +228,11 @@ end
     await _writeGoogleServiceFileToPath();
     await _writeBundleServiceFileScriptToProject();
     final debugSymbolScriptAdded = await addFlutterFireDebugSymbolsScript(
-      flutterAppPath: flutterAppPath,
+      flutterAppPath: flutterApp.package.path,
       logger: logger,
       projectConfiguration: projectConfiguration,
       platform: platform,
+      isDevDependency: flutterApp.dependsOnPackage('flutterfire_cli'),
     );
 
     return _firebaseJsonWrites(
@@ -248,15 +251,15 @@ end
 abstract class FirebaseAppleConfiguration {
   FirebaseAppleConfiguration({
     required this.platformOptions,
-    required this.flutterAppPath,
+    required this.flutterApp,
     required this.serviceFilePath,
     required this.logger,
     required this.platform,
     required this.projectConfiguration,
   });
   // Either "ios" or "macos"
   final String platform;
-  final String flutterAppPath;
+  final FlutterApp flutterApp;
   final FirebaseOptions platformOptions;
   final String serviceFilePath;
   final Logger logger;
@@ -280,7 +283,7 @@ abstract class FirebaseAppleConfiguration {
       pathToMap: keysToMap,
       projectId: platformOptions.projectId,
       appId: platformOptions.appId,
-      fileOutput: path.relative(serviceFilePath, from: flutterAppPath),
+      fileOutput: path.relative(serviceFilePath, from: flutterApp.package.path),
       uploadDebugSymbols: uploadDebugSymbols,
     );
   }
@@ -306,6 +309,7 @@ Future<bool> addFlutterFireDebugSymbolsScript({
   required Logger logger,
   required String platform,
   required ProjectConfiguration projectConfiguration,
+  required bool isDevDependency,
 }) async {
   final packageConfigContents = File(
     path.join(
@@ -352,6 +356,7 @@ Future<bool> addFlutterFireDebugSymbolsScript({
         target,
         projectConfiguration,
         platform,
+        isDevDependency,
       ),
     ]);
 
@@ -372,6 +377,7 @@ String _debugSymbolsScript(
   String target,
   ProjectConfiguration projectConfiguration,
   String platform,
+  bool isDevDependency,
 ) {
   final projectType = switch (projectConfiguration) {
     ProjectConfiguration.buildConfiguration =>
@@ -401,7 +407,7 @@ else
 fi
 
 # Command to upload symbols script used to upload symbols to Firebase server
-flutterfire upload-crashlytics-symbols --upload-symbols-script-path="\$PATH_TO_CRASHLYTICS_UPLOAD_SCRIPT" --platform=$platform --apple-project-path="\${SRCROOT}" --env-platform-name="\${PLATFORM_NAME}" --env-configuration="\${CONFIGURATION}" --env-project-dir="\${PROJECT_DIR}" --env-built-products-dir="\${BUILT_PRODUCTS_DIR}" --env-dwarf-dsym-folder-path="\${DWARF_DSYM_FOLDER_PATH}" --env-dwarf-dsym-file-name="\${DWARF_DSYM_FILE_NAME}" --env-infoplist-path="\${INFOPLIST_PATH}" $projectType
+${isDevDependency ? 'dart run flutterfire_cli:flutterfire' : 'flutterfire'} upload-crashlytics-symbols --upload-symbols-script-path="\$PATH_TO_CRASHLYTICS_UPLOAD_SCRIPT" --platform=$platform --apple-project-path="\${SRCROOT}" --env-platform-name="\${PLATFORM_NAME}" --env-configuration="\${CONFIGURATION}" --env-project-dir="\${PROJECT_DIR}" --env-built-products-dir="\${BUILT_PRODUCTS_DIR}" --env-dwarf-dsym-folder-path="\${DWARF_DSYM_FOLDER_PATH}" --env-dwarf-dsym-file-name="\${DWARF_DSYM_FILE_NAME}" --env-infoplist-path="\${INFOPLIST_PATH}" $projectType
 )
 
 for target in project.targets

packages/flutterfire_cli/lib/src/firebase/firebase_pubspec_model.dart

@@ -7,7 +7,8 @@ class FirebasePubSpecModel {
 
   factory FirebasePubSpecModel.fromJson(Map<String, dynamic> json) {
     return FirebasePubSpecModel(
-      googleServicesGradlePluginVersion: json['google_services_gradle_plugin_version'],
+      googleServicesGradlePluginVersion:
+          json['google_services_gradle_plugin_version'],
       crashlyticsGradlePluginVersion: json['crashlytics_gradle_plugin_version'],
       performanceGradlePluginVersion: json['performance_gradle_plugin_version'],
     );
@@ -16,4 +17,4 @@ class FirebasePubSpecModel {
   final String googleServicesGradlePluginVersion;
   final String crashlyticsGradlePluginVersion;
   final String performanceGradlePluginVersion;
-}
+}

packages/flutterfire_cli/pubspec.yaml

@@ -16,7 +16,7 @@ dependencies:
   file: ^7.0.0
   http: ^1.4.0
   interact: ^2.2.0
-  meta: ^1.17.0
+  meta: ^1.6.0
   path: ^1.8.0
   platform: ^3.0.2
   pub_updater: ^0.5.0