From bb152cf37b047fc9ba98d5889827f8e022de2694 Mon Sep 17 00:00:00 2001 From: Damien LeBerrigaud Date: Sat, 12 Aug 2023 19:56:03 -0600 Subject: [PATCH] README tweaks --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b2beb74..30c36ec 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Some of the code is useful for desktop apps too. This is an example of a simple mobile app with API integration and how to set it up with some dependency injection and predictable testing of API integrations. -* See [`AppDependencies`](weather_app/lib/app_dependencies.dart) for some simple dependency injection using +* See [`AppDependencies`](weather_app/lib/app_dependencies/app_dependencies.dart) for some simple dependency injection using a [Provider](https://pub.dev/packages/provider). * See [`TestDepdendencies`](weather_app/test/test_dependencies.dart) for injection of test dependencies. * See [`result.dart`](weather_app/lib/prelude/result.dart) for functional handling of errors. @@ -67,11 +67,20 @@ make format ``` If your prefer a different line length, feel free to update the `Makefile` to your team's liking -and have developers configure Android Studio as well. +and have developers configure their IDE as well. + +## Checking for cyclic dependencies + +Make sure your imports are relative only for files in the same folder, otherwise use `package:` imports. +Run the make task for checking cycles: + +``` +make check-cycles +``` ## Check before push -To check formatting and run tests before pushing your code +To check formatting, cyclic dependencies and run tests before pushing your code ``` make check