A package combining Inspector, Talker, and more from pub.dev for efficient project implementation. 🚀
This package is not meant to be a groundbreaking innovation but rather a curated collection of high-quality tools from pub.dev, tailored for my future projects. I've decided to share it with the community in hopes it might be of use to others. It combines time-tested utilities and my personal enhancements aimed at improving project efficiency and adaptability.
As the underlying packages evolve, I plan to update and enhance this package, possibly adding new features based on community feedback and emerging needs. This package is meant to be a dynamic toolset that grows and improves over time, facilitating smoother development processes for Flutter developers.
Your feedback is highly valued as it will help shape future updates and ensure the package remains relevant and useful. 😊
Show some ❤️ and star the repo to support the project!
Packages
ISpect can be extended using other parts of this package
Package | Version | Description |
---|---|---|
ispect | Main package of ISpect | |
ispect_ai | An add-on package to use the Gemini AI Api to generate a report and log questions |
|
ispect_jira | An add-on package to use the Jira Atlassian Api to create issue tickets immediately via Feedback |
📌 Features
- ✅ Draggable button for route to ISpect page, manage Inspector tools
- ✅ Localizations: ru, en, kk. (I will add more translations in the future.)
- ✅ Talker logger implementation: BLoC, Dio, http, Routing, Provider
- ✅ You can customize more options during initialization of ISpectTalker like BLoC, Dispatcher error and etc.
- ✅ Updated ISpectTalker page: added more options.
- Detailed
HTTP
logs:request
,response
,error
- Debug tools
- Cache manager
- Device and app info
- Detailed
- ✅ Feedback
- ✅ Performance tracker
- ✅ AI helper
📜 Showcase
📌 Getting Started
Follow these steps to use this package
Add dependency
dependencies:
ispect: ^2.0.7
ispect_ai: ^0.0.2
Add import package
import 'package:ispect/ispect.dart';
import 'package:talker_flutter/talker_flutter.dart';
import 'package:ispect_ai/ispect_ai.dart';
Easy to use
Instructions for use:
- Wrap
runApp
withISpect.run
method and passTalker
instance to it. - Initialize
ISpectGoogleAi
toMaterialApp
and pass the Google Ai token. For example, from an.env
file or an environment variable.
ISpectGoogleAi.init('token');
- In
actionItems
insideISpectOptions
add the corresponding Action buttons. For example:
actionItems: [
TalkerActionItem(
title: 'AI Chat',
icon: Icons.bubble_chart,
onTap: (context) {
Navigator.of(context).push(
MaterialPageRoute(
builder: (context) => const AiChatPage(),
),
);
},
),
TalkerActionItem(
title: 'AI Reporter',
icon: Icons.report_rounded,
onTap: (context) {
Navigator.of(context).push(
MaterialPageRoute(
builder: (context) => const AiReporterPage(),
),
);
},
),
],
- Add
ISpectAILocalization
to yourlocalizationsDelegates
inMaterialApp
.
localizationsDelegates: ISpectLocalizations.localizationDelegates([
ExampleGeneratedLocalization.delegate,
ISpectAILocalization.delegate,
]),
- Wrap your root widget with
ISpectScopeWrapper
widget to enableISpect
where you can pass theme and options. - Add
ISpectBuilder
widget to your material app's builder and putNavigatorObserver
.
Please, check the example for more details.
Note
- To add
ISpect Jira
, follow the instructions provided here ispect_jira.
You can also check out an example of usage directly in ispect_jira/example.
### For change `ISpect` theme:
```dart
ISpect.read(context).setThemeMode(value ? ThemeMode.dark : ThemeMode.light);
For handle routing (GoRouter)
You can use ISpectNavigatorObserver
, but in practice it does not always work correctly with the GoRouter
package. You need add observer in each GoRoute.
Alternatively, you can use a listener
:
_router.routerDelegate.addListener(() {
final String location =
_router.routerDelegate.currentConfiguration.last.matchedLocation;
talkerWrapper.route(location);
});
How to use Jira:
In order to go to the authorization page of Jira, you need to open ISpect, click on the "burger menu" (Actions) and open "Jira". The first time you will be taken to the authorization page, the next time you will be taken to the Jira card creation page.
- Next we will be greeted by the authorization page. As indicated, you will need to log in to Jira, click on your avatar and go to "Manage account".
- Go to "Settings".
- Scroll down to "API tokens" and click on "Create and manage API tokens".
- And click on "Create API token", copy and paste the token into the application.
You should end up with something like this. In the "Project domain" field enter domain like "anydevkz", then the mail you use to log in to Jira. It can be found in the settings. When you click on "Authorization" I will validate your data, if everything fits, you will have to select your active project. This can always be changed.
Then you go back and when you go to the Jira page again, you will be taken to the task creation page.
This is where you select a project, as I mentioned above, this is an intermediate mandatory step. You choose a project and move on. But you can move on to another project if needed.
Also, after authorization in Jira, you will have a "Create Jira Issue" button when describing an issue in the Feedback builder. It will immediately take you to the issue creation page with a description of the issue you described and a screenshot attachment with all your drawings.
Referenced packages:
A list of great packages I've used in ISpect AI: talker, path_provider, device_info_plus, share_plus, package_info_plus, gap, auto_size_text, feedback, inspector, performance, cr_json_widget. google_generative_ai. flutter_markdown.
Libraries
- ai/bloc/ai_chat/ai_chat_bloc
- ai/bloc/ai_reporter/ai_reporter_cubit
- ai/bloc/log_descriptions/log_descriptions_cubit
- ai/core/data/datasource/ai_remote_ds
- ai/core/data/models/chat_message
- ai/core/data/models/log_description
- ai/core/data/models/log_report
- ai/core/data/repositories/ai_repository
- ai/core/domain/ai_repository
- ai/presentation/pages/ai_chat_page
- ai/presentation/pages/ai_reporter_page
- ai/presentation/widgets/ai_painter
- ai/presentation/widgets/gemini_logo
- ispect_ai