[MOB-9118] Change Package Layout (#224)

TheBuggedYRN · web-flow · commit e23f740321ad · 2022-07-17T20:26:34.000+02:00
* Use snake_case for files

* Use pub packages layout conventions

* Update README

* Update CHANGELOG
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 * Adds BugReporting.setFloatingButtonEdge API
 * Supports starting SDK from Dart only.
 * Fixes an issue with Android screenshots being black on release mode on SDK v10.13.0
+* Changes the package importing style
 
 ## v10.13.0 (2022-03-31)
 
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ flutter packages get
 To start using Instabug, import it into your Flutter app. 
 
 ```dart
-import 'package:instabug_flutter/Instabug.dart';
+import 'package:instabug_flutter/instabug_flutter.dart';
 ```
 * #### iOS
      Initialize the SDK in `initState()`. This line enables the SDK with the default behavior and sets it to be shown when the device is shaken.
@@ -93,7 +93,7 @@ Instabug automatically captures every crash of your app and sends relevant detai
 1. Import the following into your `main.dart`:
 
 ```dart
-import 'package:instabug_flutter/CrashReporting.dart';
+import 'package:instabug_flutter/instabug_flutter.dart';
 ```
 
 2. Replace `void main() => runApp(MyApp());` with the following snippet.
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -1,11 +1,7 @@
 import 'dart:async';
 
 import 'package:flutter/material.dart';
-import 'package:instabug_flutter/BugReporting.dart';
-import 'package:instabug_flutter/CrashReporting.dart';
-import 'package:instabug_flutter/FeatureRequests.dart';
-import 'package:instabug_flutter/Instabug.dart';
-import 'package:instabug_flutter/Surveys.dart';
+import 'package:instabug_flutter/instabug_flutter.dart';
 
 void main() {
   FlutterError.onError = (FlutterErrorDetails details) {
diff --git a/lib/instabug_flutter.dart b/lib/instabug_flutter.dart
@@ -0,0 +1,22 @@
+// Models
+export 'src/models/crash_data.dart';
+export 'src/models/exception_data.dart';
+export 'src/models/network_data.dart';
+export 'src/models/trace.dart';
+
+// Modules
+export 'src/modules/apm.dart';
+export 'src/modules/bug_reporting.dart';
+export 'src/modules/crash_reporting.dart';
+export 'src/modules/feature_requests.dart';
+export 'src/modules/instabug.dart';
+export 'src/modules/instabug_log.dart';
+export 'src/modules/network_logger.dart';
+export 'src/modules/replies.dart';
+export 'src/modules/surveys.dart';
+
+// Utils
+export 'src/utils/http_client_logger.dart';
+export 'src/utils/instabug_custom_http_client.dart';
+export 'src/utils/instabug_custom_http_client_request.dart';
+export 'src/utils/instabug_navigator_observer.dart';
diff --git a/lib/src/models/crash_data.dart b/lib/src/models/crash_data.dart
@@ -1,4 +1,4 @@
-import 'package:instabug_flutter/models/exception_data.dart';
+import 'package:instabug_flutter/src/models/exception_data.dart';
 
 class CrashData {
   CrashData(this.message, this.os, this.exception);
diff --git a/lib/src/models/exception_data.dart b/lib/src/models/exception_data.dart
diff --git a/lib/src/models/network_data.dart b/lib/src/models/network_data.dart
diff --git a/lib/src/models/trace.dart b/lib/src/models/trace.dart
@@ -1,4 +1,4 @@
-import 'package:instabug_flutter/APM.dart';
+import 'package:instabug_flutter/src/modules/apm.dart';
 
 class Trace {
   String id;
diff --git a/lib/src/modules/apm.dart b/lib/src/modules/apm.dart
@@ -3,10 +3,10 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/models/network_data.dart';
-import 'package:instabug_flutter/models/trace.dart';
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
-import 'package:instabug_flutter/utils/ibg_date_time.dart';
+import 'package:instabug_flutter/src/models/network_data.dart';
+import 'package:instabug_flutter/src/models/trace.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/utils/ibg_date_time.dart';
 
 enum LogLevel {
   none,
diff --git a/lib/src/modules/bug_reporting.dart b/lib/src/modules/bug_reporting.dart
@@ -3,8 +3,8 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/Instabug.dart';
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/modules/instabug.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
 
 enum InvocationOption {
   commentFieldRequired,
diff --git a/lib/src/modules/crash_reporting.dart b/lib/src/modules/crash_reporting.dart
@@ -5,9 +5,9 @@ import 'dart:convert';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/models/crash_data.dart';
-import 'package:instabug_flutter/models/exception_data.dart';
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/models/crash_data.dart';
+import 'package:instabug_flutter/src/models/exception_data.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
 import 'package:stack_trace/stack_trace.dart';
 
 class CrashReporting {
diff --git a/lib/src/modules/feature_requests.dart b/lib/src/modules/feature_requests.dart
diff --git a/lib/src/modules/instabug.dart b/lib/src/modules/instabug.dart
@@ -5,7 +5,7 @@ import 'dart:typed_data';
 import 'dart:ui';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
 
 enum InvocationEvent {
   shake,
diff --git a/lib/src/modules/instabug_log.dart b/lib/src/modules/instabug_log.dart
diff --git a/lib/src/modules/network_logger.dart b/lib/src/modules/network_logger.dart
@@ -3,8 +3,8 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/APM.dart';
-import 'package:instabug_flutter/models/network_data.dart';
+import 'package:instabug_flutter/src/models/network_data.dart';
+import 'package:instabug_flutter/src/modules/apm.dart';
 
 class NetworkLogger {
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
diff --git a/lib/src/modules/replies.dart b/lib/src/modules/replies.dart
@@ -3,7 +3,7 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
 
 class Replies {
   static Function? _hasChatsCallback;
diff --git a/lib/src/modules/surveys.dart b/lib/src/modules/surveys.dart
@@ -3,7 +3,7 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
 
 class Surveys {
   static Function? _onShowCallback;
diff --git a/lib/src/utils/http_client_logger.dart b/lib/src/utils/http_client_logger.dart
@@ -1,8 +1,8 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:instabug_flutter/NetworkLogger.dart';
-import 'package:instabug_flutter/models/network_data.dart';
+import 'package:instabug_flutter/src/models/network_data.dart';
+import 'package:instabug_flutter/src/modules/network_logger.dart';
 
 class HttpClientLogger {
   final requests = <int, NetworkData>{};
diff --git a/lib/src/utils/ibg_build_info.dart b/lib/src/utils/ibg_build_info.dart
diff --git a/lib/src/utils/ibg_date_time.dart b/lib/src/utils/ibg_date_time.dart
diff --git a/lib/src/utils/instabug_custom_http_client.dart b/lib/src/utils/instabug_custom_http_client.dart
@@ -1,7 +1,7 @@
 import 'dart:io';
 
-import 'package:instabug_flutter/instabug_custom_http_client_request.dart';
-import 'package:instabug_flutter/utils/http_client_logger.dart';
+import 'package:instabug_flutter/src/utils/http_client_logger.dart';
+import 'package:instabug_flutter/src/utils/instabug_custom_http_client_request.dart';
 import 'package:meta/meta.dart';
 
 class InstabugCustomHttpClient extends HttpClientLogger implements HttpClient {
diff --git a/lib/src/utils/instabug_custom_http_client_request.dart b/lib/src/utils/instabug_custom_http_client_request.dart
@@ -1,7 +1,7 @@
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:instabug_flutter/utils/http_client_logger.dart';
+import 'package:instabug_flutter/src/utils/http_client_logger.dart';
 
 class InstabugCustomHttpClientRequest implements HttpClientRequest {
   InstabugCustomHttpClientRequest(this._originalClientRequest, this.logger) {
diff --git a/lib/src/utils/instabug_navigator_observer.dart b/lib/src/utils/instabug_navigator_observer.dart
@@ -1,5 +1,5 @@
 import 'package:flutter/material.dart';
-import 'package:instabug_flutter/Instabug.dart';
+import 'package:instabug_flutter/src/modules/instabug.dart';
 
 class InstabugNavigatorObserver extends NavigatorObserver {
   final List<Route> _steps = <Route>[];
diff --git a/test/instabug_flutter_test.dart b/test/instabug_flutter_test.dart
@@ -4,24 +4,12 @@ import 'dart:typed_data';
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'package:instabug_flutter/APM.dart';
-import 'package:instabug_flutter/BugReporting.dart';
-import 'package:instabug_flutter/CrashReporting.dart';
-import 'package:instabug_flutter/FeatureRequests.dart';
-import 'package:instabug_flutter/Instabug.dart';
-import 'package:instabug_flutter/InstabugLog.dart';
-import 'package:instabug_flutter/NetworkLogger.dart';
-import 'package:instabug_flutter/Replies.dart';
-import 'package:instabug_flutter/Surveys.dart';
-import 'package:instabug_flutter/models/crash_data.dart';
-import 'package:instabug_flutter/models/exception_data.dart';
-import 'package:instabug_flutter/models/network_data.dart';
-import 'package:instabug_flutter/models/trace.dart' as execution_trace;
-import 'package:instabug_flutter/utils/ibg_build_info.dart';
-import 'package:instabug_flutter/utils/ibg_date_time.dart';
+import 'package:instabug_flutter/instabug_flutter.dart';
+import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
+import 'package:instabug_flutter/src/utils/ibg_date_time.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
-import 'package:stack_trace/stack_trace.dart';
+import 'package:stack_trace/stack_trace.dart' as stack_trace;
 
 import 'instabug_flutter_test.mocks.dart';
 
@@ -966,7 +954,7 @@ void main() {
       params[5] = 2;
     } catch (exception, stack) {
       const bool handled = true;
-      final Trace trace = Trace.from(stack);
+      final stack_trace.Trace trace = stack_trace.Trace.from(stack);
       final List<ExceptionData> frames = <ExceptionData>[];
       for (int i = 0; i < trace.frames.length; i++) {
         frames.add(ExceptionData(
@@ -1120,7 +1108,7 @@ void main() {
     const String key = 'key';
     const String value = 'value';
     final List<dynamic> args = <dynamic>[id, key, value];
-    final execution_trace.Trace trace = execution_trace.Trace(id, name);
+    final Trace trace = Trace(id, name);
     trace.setAttribute(key, value);
     expect(log, <Matcher>[
       isMethodCall(
diff --git a/test/network_logger_test.dart b/test/network_logger_test.dart
@@ -4,11 +4,7 @@ import 'dart:io';
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'package:instabug_flutter/NetworkLogger.dart';
-import 'package:instabug_flutter/instabug_custom_http_client.dart';
-import 'package:instabug_flutter/instabug_custom_http_client_request.dart';
-import 'package:instabug_flutter/models/network_data.dart';
-import 'package:instabug_flutter/utils/http_client_logger.dart';
+import 'package:instabug_flutter/instabug_flutter.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import 'package:instabug_flutter/models/exception_data.dart';`
	`1`	`+import 'package:instabug_flutter/src/models/exception_data.dart';`
`2`	`2`
`3`	`3`	`class CrashData {`
`4`	`4`	`CrashData(this.message, this.os, this.exception);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import 'package:instabug_flutter/APM.dart';`
	`1`	`+import 'package:instabug_flutter/src/modules/apm.dart';`
`2`	`2`
`3`	`3`	`class Trace {`
`4`	`4`	`String id;`