refactor: make mono-repo

Author: ahmedAlaaInstabug

.circleci/config.yml

@@ -11,9 +11,15 @@ commands:
     steps:
       - flutter/install_sdk_and_pub:
           version: 3.10.5
+      - run:
+          name: Install melos
+          command: dart pub global activate melos
+      - run:
+          name: bootstrap
+          command: melos bootstrap
       - run:
           name: Generate Pigeons
-          command: sh ./scripts/pigeon.sh
+          command: melos pigeon
   setup_ios:
     steps:
       # Flutter doesn't support Apple Silicon yet, so we need to install Rosetta use Flutter on M1 machines.
@@ -26,7 +32,7 @@ commands:
           command: sudo gem install cocoapods
       - run:
           name: Install Pods
-          working_directory: example/ios
+          working_directory: apps/example/ios
           command: pod install --repo-update
   setup_captain:
     parameters:
@@ -77,8 +83,8 @@ commands:
           name: Configure Captain Platform
           command: echo 'export CAPTAIN_PLATFORM=<<parameters.platform>>' >> $BASH_ENV
   # This runs `flutter pub get` and `dart pub get` if we pass parameter `generate_pigeons` to the job it also runs the following:
-  #   - `sh ./scripts/pigeon.sh`
-  #   - `dart run build_runner build --delete-conflicting-outputs`
+  #   - `melos pigeon`
+  #   - `melos generate`
   install_flutter_and_dart_packages:
     parameters:
       generate_pigeons:
@@ -89,7 +95,7 @@ commands:
           command: flutter pub get
       - run:
           name: Install Dart Packages
-          command: dart pub get
+          command: melos dart_bootstrap
           description: Install Dart Packages (for dart explicit packages)
       - when:
           condition:
@@ -99,10 +105,10 @@ commands:
           steps:
             - run:
                 name: Generate Pigeons
-                command: sh ./scripts/pigeon.sh
+                command: melos pigeon
             - run:
                 name: Build Pigeons
-                command: dart run build_runner build --delete-conflicting-outputs
+                command: melos generate
 
 jobs:
   danger:
@@ -147,7 +153,7 @@ jobs:
       - advanced-checkout/shallow-checkout
       - setup_flutter
       - android/run-tests:
-          working-directory: example/android
+          working-directory: apps/example/android
           test-command: ./gradlew test
 
   e2e_android_captain:
@@ -164,7 +170,7 @@ jobs:
           run-tests-working-directory: e2e
           additional-avd-args: --device 3
           system-image: system-images;android-33;default;x86_64
-          post-emulator-launch-assemble-command: cd example && flutter build apk --debug
+          post-emulator-launch-assemble-command: cd apps/example && flutter build apk --debug
           test-command: dotnet test
 
   test_ios:
@@ -178,7 +184,7 @@ jobs:
       - setup_ios
       - run:
           name: Build and run tests
-          working_directory:  ~/project/example/ios
+          working_directory:  ~/project/apps/example/ios
           command: |
             xcodebuild -allowProvisioningUpdates \
                 -workspace Runner.xcworkspace \
@@ -199,7 +205,7 @@ jobs:
       - setup_ios
       - run:
           name: Build Example App
-          working_directory: example
+          working_directory: apps/example
           command: flutter build ios --simulator
       - run:
           name: Run E2E Tests
@@ -216,7 +222,7 @@ jobs:
           generate_pigeons: false
       - run:
           name: Check Format
-          command: dart format . --set-exit-if-changed
+          command: melos format
 
   lint_flutter:
     docker:
@@ -227,7 +233,7 @@ jobs:
           generate_pigeons: true
       - run:
           name: Perform Static Analysis
-          command: flutter analyze
+          command: melos analyze
 
   verify_pub:
     docker:
@@ -238,10 +244,10 @@ jobs:
           generate_pigeons: true
       - run:
           name: Check Package Score
-          command: dart run pana --no-warning --exit-code-threshold 0
-      - run: flutter pub publish --dry-run
+          command: melos score
+      - run: melos dryPublish
 
-  release:
+  release_instabug_flutter:
     macos:
       xcode: 15.2.0
     resource_class: macos.m1.medium.gen1
@@ -263,7 +269,7 @@ jobs:
       - run:
           name: Generate Pigeons
           working_directory: project
-          command: sh ./scripts/pigeon.sh
+          command: melos pigeon
       - run:
           name: Clone Escape
           command: git clone [email protected]:Instabug/Escape.git

.metadata

@@ -4,7 +4,7 @@
 # This file should be version controlled and should not be manually edited.
 
 version:
-  revision: 5391447fae6209bb21a89e6a5a6583cac1af9b4b
-  channel: stable
+  revision: "2663184aa79047d0a33a14a3b607954f8fdd8730"
+  channel: "stable"
 
-project_type: plugin
+project_type: package

README.md

@@ -1,116 +1,39 @@
-# Instabug for Flutter
+<!--
+This README describes the package. If you publish this package to pub.dev,
+this README's contents appear on the landing page for your package.
 
-[![pub package](https://img.shields.io/pub/v/instabug_flutter.svg)](https://pub.dev/packages/instabug_flutter)
+For information about how to write a good package README, see the guide for
+[writing package pages](https://dart.dev/tools/pub/writing-package-pages).
 
-A Flutter plugin for [Instabug](https://instabug.com/).
+For general information about developing packages, see the Dart guide for
+[creating packages](https://dart.dev/guides/libraries/create-packages)
+and the Flutter guide for
+[developing packages and plugins](https://flutter.dev/to/develop-packages).
+-->
 
-## Available Features
+TODO: Put a short description of the package here that helps potential users
+know whether this package might be useful for them.
 
-|      Feature                                              | Status  |
-|:---------------------------------------------------------:|:-------:|
-| [Bug Reporting](https://docs.instabug.com/docs/flutter-bug-reporting)               |    ✅   |
-| [Crash Reporting](https://docs.instabug.com/docs/flutter-crash-reporting)           |    ✅   |
-| [App Performance Monitoring](https://docs.instabug.com/docs/flutter-apm)            |    ✅   |
-| [In-App Replies](https://docs.instabug.com/docs/flutter-in-app-replies)             |    ✅   |
-| [In-App Surveys](https://docs.instabug.com/docs/flutter-in-app-surveys)             |    ✅   |
-| [Feature Requests](https://docs.instabug.com/docs/flutter-in-app-feature-requests)  |    ✅   |
+## Features
 
-* ✅ Stable
-* ⚙️ Under active development
+TODO: List what your package can do. Maybe include images, gifs, or videos.
 
-## Integration
+## Getting started
 
-### Installation
+TODO: List prerequisites and provide or point to information on how to
+start using the package.
 
-1. Add Instabug to your `pubspec.yaml` file.
+## Usage
 
-```yaml
-dependencies:
-      instabug_flutter:
-```
-
-2. Install the package by running the following command.
-
-```bash
-flutter packages get
-```
-
-### Initializing Instabug
-
-Initialize the SDK in your `main` function. This starts the SDK with the default behavior and sets it to be shown when the device is shaken.
+TODO: Include short and useful examples for package users. Add longer examples
+to `/example` folder.
 
 ```dart
-import 'package:instabug_flutter/instabug_flutter.dart';
-
-void main() {
-  WidgetsFlutterBinding.ensureInitialized();
-
-  Instabug.init(
-    token: 'APP_TOKEN',
-    invocationEvents: [InvocationEvent.shake],
-  );
-
-  runApp(MyApp());
-}
+const like = 'sample';
 ```
 
-> :warning:  If you're updating the SDK from versions prior to v11, please check our [migration guide](https://docs.instabug.com/docs/flutter-migration-guide).
-
-## Crash reporting
-
-Instabug automatically captures every crash of your app and sends relevant details to the crashes page of your dashboard. 
-
-⚠️ **Crashes will only be reported in release mode and not in debug mode.**
-
-```dart
-void main() {
-  runZonedGuarded(
-    () {
-      WidgetsFlutterBinding.ensureInitialized();
-
-      Instabug.init(
-        token: 'APP_TOKEN',
-        invocationEvents: [InvocationEvent.shake],
-      );
-
-      FlutterError.onError = (FlutterErrorDetails details) {
-        Zone.current.handleUncaughtError(details.exception, details.stack!);
-      };
-
-      runApp(MyApp());
-    },
-    CrashReporting.reportCrash,
-  );
-}
-```
-
-## Repro Steps
-Repro Steps list all of the actions an app user took before reporting a bug or crash, grouped by the screens they visited in your app.
- 
- To enable this feature, you need to add `InstabugNavigatorObserver` to the `navigatorObservers` :
- ```
-  runApp(MaterialApp(
-    navigatorObservers: [InstabugNavigatorObserver()],
-  ));
-  ```
-
-## Network Logging
-You can choose to attach all your network requests to the reports being sent to the dashboard. To enable the feature when using the `dart:io` package `HttpClient`, please refer to the [Instabug Dart IO Http Client](https://github.com/Instabug/instabug-dart-io-http-client) repository.
-
-We also support the packages `http` and `dio`. For details on how to enable network logging for these external packages, refer to the [Instabug Dart Http Adapter](https://github.com/Instabug/Instabug-Dart-http-Adapter) and the [Instabug Dio Interceptor](https://github.com/Instabug/Instabug-Dio-Interceptor) repositories.
-
-## Microphone and Photo Library Usage Description (iOS Only)
-
-Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
-
-For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:
-
-* `NSMicrophoneUsageDescription`
-* `NSPhotoLibraryUsageDescription`
-
-If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:
-
-* "`<app name>` needs access to the microphone to be able to attach voice notes."
-* "`<app name>` needs access to your photo library for you to be able to attach images."
+## Additional information
 
-**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
+TODO: Tell users more about the package: where to find more information, how to
+contribute to the package, how to file issues, what response they can expect
+from the package authors, and more.

analysis_options.yaml

@@ -2,7 +2,7 @@ include: package:lint/analysis_options_package.yaml
 
 analyzer:
   exclude:
-    - "example/**"
+    - "apps/example/**"
     - "**/*.g.dart"
 
 linter: