Precommit hooks, readme updates

README.md

@@ -47,7 +47,7 @@ Here are some things you need to prepare before this Boilerplate setup:
 3. Visual Studio Code (Optional) [Install](https://code.visualstudio.com/)
 4. **Dart** and **Flutter** extensions:
     - **Intellij Platform** users ([Dart](https://plugins.jetbrains.com/plugin/6351-dart), [Flutter](https://plugins.jetbrains.com/plugin/9212-flutter) )
-    - **Visual Studio Code** users ([Dart](https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code), [Flutter](https://marketplace.visualstudio.com /items?itemName=Dart-Code.flutter) )
+    - **Visual Studio Code** users ([Dart](https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code), [Flutter](https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter) )
 
 #### Setup
 
@@ -87,17 +87,23 @@ Sensitive information like api keys, credentials, etc should not be checked into
 
 #### Get Dependencies
 
-```
+```bash
 flutter pub get
 ```
 
 #### Run Code Generation
 
+```bash
+bash app/scripts/generate-all.sh
 ```
-bash scripts/generate-all.sh
+
+#### Setup Hooks
+
+```bash
+bash app/scripts/setup-hooks.sh
 ```
 
-Read the [scripts documentation](app/scripts/README.md) to learn about all the scrips used in the project.
+Read the [scripts documentation](app/scripts/README.md) to learn about all the scripts used in the project.
 
 
 
@@ -144,7 +150,7 @@ You can setup any environment specific values in the respective `main.dart` file
 
 To run a specific flavor you need to specify the flavor and target file.
 
-```sh
+```bash
  flutter run --flavor qa -t lib/entrypoints/main_qa.dart
 ```
 
@@ -197,6 +203,11 @@ In Visual Studio Code, navigate to `Preferences` -> `Settings` and search for `F
 - [Localisation](./localisation/)
 - Routing/Navigations
 - [Responsive Framework](./wiki/responsive-framework/RESPONSIVE_FRAMEWORK.md)
+- Pre-commit Checks
+  - Dart Analysis
+  - [Dart Fix](https://github.com/dart-lang/sdk/blob/main/pkg/dartdev/doc/dart-fix.md)
+  - Flutter Format
+
 
 
 
@@ -267,7 +278,7 @@ For the android CD workflow to run, we need to perform the following setup steps
 - Follow these instructions to [generate an upload keystore](https://developer.android.com/studio/publish/app-signing#generate-key). Note down the `store password`, `key alias` and `key password`. You will need these in later steps.
 - Use `openssl` to convert the `jks` file to `Base64`.
 
-```
+```bash
 openssl base64 < app_key.jks | tr -d '\n' | tee app_key_encoded.txt
 ```
 
@@ -305,7 +316,8 @@ We will divide the guide into steps so that it is easier to understand
   - Replace `PROVISIONING PROFILE NAME` with your Provisioning Profile Name (You already created one in Step 2, use that)
   - Replace `TEAM_ID` with your team id. Look at [this](https://stackoverflow.com/a/18727947) answer on "How to find your Team ID"
 
-  <summary><i>Click to View Template</i></summary>
+<details>
+<summary><i>Click to View Template</i></summary>
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
@@ -338,6 +350,7 @@ We will divide the guide into steps so that it is easier to understand
 </dict>
 </plist>
 ```
+
 </details>
 
   Create a new file called `options.plist` and save the above contents in that file
@@ -364,7 +377,7 @@ We will divide the guide into steps so that it is easier to understand
 
 - To generate a base64 string, use the following command, replacing `FILENAME` with your filename
 
-```
+```bash
 openssl base64 < FILENAME | tr -d '\n' | tee ENCODED_FILENAME.txt
 ```
 

app/lib/di/states/viewmodels.dart

@@ -3,7 +3,6 @@ import 'package:flutter_riverpod/flutter_riverpod.dart';
 
 import '../../dependencies.dart';
 
-
 final splashViewModelProvider =
     ChangeNotifierProvider.autoDispose<SplashViewModel>(
   (ref) => SplashViewModel(getIt.get<String>(instanceName: "BaseUrl")),

app/lib/entrypoints/main_prod.dart

@@ -13,4 +13,4 @@ void main() {
     ),
   );
   startApp();
-}
+}

app/lib/feature/splash/splash_page.dart

@@ -14,6 +14,7 @@ class SplashPage extends BasePage<SplashViewModel> {
 }
 
 class SplashPageState extends BaseStatefulPage<SplashViewModel, SplashPage> {
+  @override
   ProviderBase provideBase() {
     return splashViewModelProvider;
   }

app/lib/feature/splash/splash_page_model.dart

@@ -3,12 +3,9 @@ import 'package:injectable/injectable.dart';
 
 @injectable
 class SplashViewModel extends BasePageViewModel {
-
   final String myBaseUrl;
 
-  SplashViewModel(@factoryParam this.myBaseUrl){
-    print("My First log in Splash ${this.myBaseUrl}");
+  SplashViewModel(@factoryParam this.myBaseUrl) {
+    print("My First log in Splash $myBaseUrl");
   }
-
-
 }

app/lib/feature/splash/splash_page_view.dart

@@ -1,5 +1,4 @@
 import 'package:flutter/material.dart';
-import 'package:flutter/widgets.dart';
 import 'package:flutter_riverpod/flutter_riverpod.dart';
 import 'package:statemanagement_riverpod/statemanagement_riverpod.dart';
 

app/lib/flavors/flavor.dart

@@ -2,4 +2,4 @@ enum Flavor {
   dev,
   qa,
   prod,
-}
+}

app/lib/flavors/flavor_values.dart

@@ -18,4 +18,3 @@ class FlavorValues {
 
   bool get logSqlStatements => _logSqlStatements;
 }
-

app/lib/main.dart

@@ -11,4 +11,4 @@ import 'package:app/entrypoints/main_dev.dart' as entrypoint;
 /// until a fix is released.
 void main() {
   entrypoint.main();
-}
+}

app/lib/myapp.dart

@@ -13,19 +13,24 @@ class MyApp extends StatelessWidget {
   Widget build(BuildContext context) {
     return ThemeBuilder(
       themes: [
-        ThemeData(backgroundColor: Colors.red, accentColor: Colors.blue),
+        ThemeData(
+            backgroundColor: Colors.red,
+            colorScheme:
+                ColorScheme.fromSwatch().copyWith(secondary: Colors.blue)),
       ],
       darkTheme: ThemeData(
         brightness: Brightness.dark,
         backgroundColor: Colors.blue[700],
-        accentColor: Colors.yellow[700],
+        colorScheme:
+            ColorScheme.fromSwatch().copyWith(secondary: Colors.yellow[700]),
       ),
       lightTheme: ThemeData(
         brightness: Brightness.light,
         backgroundColor: Colors.blue[300],
-        accentColor: Colors.yellow[300],
+        colorScheme:
+            ColorScheme.fromSwatch().copyWith(secondary: Colors.yellow[300]),
       ),
-      builder: (context, regularTheme, darkTheme, themeMode) =>  MaterialApp(
+      builder: (context, regularTheme, darkTheme, themeMode) => MaterialApp(
           navigatorKey: AppService.navigatorKey,
           builder: (context, widget) => ResponsiveWrapper.builder(
                 ClampingScrollWrapper.builder(context, widget!),

app/lib/navigation/app_router.dart

@@ -8,7 +8,7 @@ class AppRouter {
     switch (settings.name) {
       case RoutePaths.Splash:
         return CupertinoPageRoute(
-            builder: (context) => SplashPage(),
+            builder: (context) => const SplashPage(),
             settings: const RouteSettings(name: RoutePaths.Splash));
 
       default:

app/scripts/hooks/pre-commit.sh

@@ -13,6 +13,6 @@ else
   echo "Static analysis failed. Running dart fix."
   dart fix --apply
   echo "Static analysis failed. Running flutter format"
-  flutter format lib
+  flutter format app/lib
   exit 1
 fi

app/scripts/setup-hooks.sh

@@ -8,4 +8,4 @@ echo All hooks marked as executable
 
 echo Moving all hooks to .git/hooks/
 
-rsync -P scripts/hooks/* .git/hooks/
+rsync -P app/scripts/hooks/* .git/hooks/

core/data/example/data_example.dart

@@ -1,4 +1,3 @@
-import 'package:data/data.dart';
 
 void main() {
 

core/data/test/data_test.dart

@@ -1,4 +1,3 @@
-import 'package:data/data.dart';
 import 'package:test/test.dart';
 
 void main() {

core/domain/example/domain_example.dart

@@ -1,4 +1,3 @@
-import 'package:domain/domain.dart';
 
 void main() {
 

core/domain/lib/src/usecase/base/params.dart

@@ -4,7 +4,7 @@ import 'package:shared/shared.dart';
 abstract class Params {
   final bool reloading;
 
-  Params({this.reloading: false});
+  Params({this.reloading = false});
 
   Either<AppError, bool> verify();
 }

core/domain/test/domain_test.dart

@@ -1,4 +1,3 @@
-import 'package:domain/domain.dart';
 import 'package:test/test.dart';
 
 void main() {

core/shared/lib/src/model/error/database_error.dart

@@ -14,7 +14,7 @@ class DatabaseError extends BaseError {
 
   @override
   String getFriendlyMessage() {
-    return "${error.message}";
+    return error.message;
   }
 
   @override

core/shared/lib/src/model/error/network_error.dart

@@ -6,13 +6,13 @@ import 'base_error.dart';
 class NetworkError extends BaseError {
   NetworkError({
     required int httpError,
-    String message: "",
+    String message = "",
     required Exception cause,
   }) : super(error: ErrorInfo(code: httpError, message: message), cause: cause);
 
   @override
   String getFriendlyMessage() {
-    return "${this.error.message}";
+    return error.message;
   }
 
   @override

dependency-injection/example/dependency_injection_example.dart

@@ -1,4 +1,3 @@
-import 'package:dependency_injection/dependency_injection.dart';
 
 void main() {
 

localisation/example/localisation_example.dart

@@ -1,4 +1,3 @@
-import 'package:localisation/strings.dart';
 
 void main() {
 

localisation/test/localisation_test.dart

@@ -1,5 +1,3 @@
-import 'package:localisation/strings.dart';
-import 'package:test/test.dart';
 
 void main() {
 

services/test/services_test.dart

@@ -1,4 +1,3 @@
-import 'package:services/services.dart';
 import 'package:test/test.dart';
 
 void main() {

statemanagement-core/lib/src/base_page_state.dart

@@ -32,7 +32,7 @@ abstract class CoreBasePageState<VM, T extends StatefulWidget> extends State<T>
         backgroundColor: scaffoldBackgroundColor(),
         appBar: buildAppbar(),
         extendBodyBehindAppBar: extendBodyBehindAppBar(),
-        body: buildScaffoldBody(context, _viewModel!),
+        body: buildScaffoldBody(context, _viewModel as VM),
         drawer: buildDrawer(),
         drawerEnableOpenDragGesture: drawerEnableOpenDragGesture(),
         bottomNavigationBar: buildBottomNavigationBar(),

statemanagement-riverpod/example/statemanagement_riverpod_example.dart

@@ -1,4 +1,3 @@
-import 'package:statemanagement_riverpod/statemanagement_riverpod.dart';
 
 void main() {
 

statemanagement-riverpod/lib/src/base_page.dart

@@ -40,7 +40,7 @@ abstract class BasePageViewWidget<T extends BasePageViewModel> extends Widget {
 
   @override
   DataProviderElement<T> createElement() =>
-      DataProviderElement<T>(this, this.providerBase);
+      DataProviderElement<T>(this, providerBase);
 }
 
 class DataProviderElement<T extends BasePageViewModel>

themes/example/themes_example.dart

@@ -1,4 +1,3 @@
-import 'package:themes/src/theme_manager.dart';
 
 void main() {
 

themes/lib/src/theme_manager.dart

@@ -69,7 +69,7 @@ class ThemeManager {
   int? get selectedThemeIndex {
     if (themes != null && themes!.isNotEmpty) {
       int? themeIndex = _sharedPreferences.themeIndex;
-      return themeIndex == null ? 0 : themeIndex;
+      return themeIndex ?? 0;
     }
     return null;
   }
@@ -86,7 +86,7 @@ class ThemeManager {
     var hasMultipleThemes = themes != null && themes!.length > 1;
     var hasLightAndDarkThemes = darkTheme != null && lightTheme != null;
     assert(hasMultipleThemes || hasLightAndDarkThemes,
-        '''You have to supply themes if you want to use themes. You have supplied no themes. Don\'t do that. Supply themes.
+        '''You have to supply themes if you want to use themes. You have supplied no themes. Don't do that. Supply themes.
 You can supply either a list of ThemeData objects to the themes property or a lightTheme and a darkTheme to be swapped between.
         ''');
 
@@ -128,13 +128,13 @@ You can supply either a list of ThemeData objects to the themes property or a li
       updateOverlayColors(selectedTheme);
     }
 
-    ThemeModel _currTheme = ThemeModel(
+    ThemeModel currTheme = ThemeModel(
         selectedTheme: selectedTheme,
         darkTheme: darkTheme,
         themeMode: _selectedThemeMode);
 
-    _themesController = BehaviorSubject<ThemeModel>.seeded(_currTheme);
-    _initialTheme = _currTheme;
+    _themesController = BehaviorSubject<ThemeModel>.seeded(currTheme);
+    _initialTheme = currTheme;
 
     ThemeService.getInstance().setThemeManager(this);
   }