https://github.com/yelmuratoff/ispect
Wrapper around Inspector, Talker and etc
https://github.com/yelmuratoff/ispect
dart device-info flutter helper inspector ispect logger package-info performance-tracker tools
Last synced: 10 months ago
JSON representation
Wrapper around Inspector, Talker and etc
- Host: GitHub
- URL: https://github.com/yelmuratoff/ispect
- Owner: yelmuratoff
- License: mit
- Created: 2024-04-07T20:40:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T05:24:03.000Z (over 1 year ago)
- Last Synced: 2024-12-12T06:25:25.062Z (over 1 year ago)
- Topics: dart, device-info, flutter, helper, inspector, ispect, logger, package-info, performance-tracker, tools
- Language: Dart
- Homepage: https://pub.dev/packages/ispect
- Size: 5.72 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Logging and inspection tool for Flutter development and testing
## 🔍 Overview
> **ISpect** is the main debugging and inspection toolkit designed specifically for Flutter applications.
📊 **Real-time Monitoring** • 🐛 **Debugging** • 🔍 **Inspection** • ⚡ **Performance Tracking**
ISpect empowers Flutter developers with a suite of debugging tools that seamlessly integrate into your development workflow. From monitoring HTTP requests in real-time to tracking performance metrics and managing application state, ISpect provides an intuitive interface that makes debugging efficient and insightful.
### 🎯 Key Features
- 🌐 **Network Monitoring**: Detailed HTTP request/response inspection with error tracking
- 📝 **Logging**: Advanced logging system with categorization and filtering
- ⚡ **Performance Analysis**: Real-time performance metrics and monitoring
- 🔍 **UI Inspector**: Widget hierarchy inspection with color picker and layout analysis
- 📱 **Device Information**: System and app metadata collection
- 🐛 **Bug Reporting**: Integrated feedback system with screenshot capture
- 🗄️ **Cache Management**: Application cache inspection and management
## 🏗️ Architecture
ISpect is built as a modular system with specialized packages:
| Package | Purpose | Version |
|---------|---------|---------|
| [ispect](packages/ispect) | Core debugging interface and tools | [](https://pub.dev/packages/ispect) |
| [ispectify](packages/ispectify) | Foundation logging system (based on Talker) | [](https://pub.dev/packages/ispectify) |
| [ispectify_dio](packages/ispectify_dio) | Dio HTTP client integration | [](https://pub.dev/packages/ispectify_dio) |
| [ispectify_http](packages/ispectify_http) | Standard HTTP client integration | [](https://pub.dev/packages/ispectify_http) |
| [ispectify_bloc](packages/ispectify_bloc) | BLoC state management integration | [](https://pub.dev/packages/ispectify_bloc) |
| [ispect_jira](packages/ispect_jira) | Jira ticket creation integration | [](https://pub.dev/packages/ispect_jira) |
## 🌐 Internationalization
- Support for 12 languages: English, Russian, Kazakh, Chinese, Spanish, French, German, Portuguese, Arabic, Korean, Japanese, Hindi
- Extensible localization system
## 📱 Interface Preview
## 📦 Installation
Add ispect to your `pubspec.yaml`:
```yaml
dependencies:
ispect: ^4.1.4
```
## 🚀 Quick Start
```dart
import 'package:flutter/material.dart';
import 'package:ispect/ispect.dart';
void main() {
// Initialize ISpectify for logging
final ISpectify logger = ISpectifyFlutter.init();
// Wrap your app with ISpect
ISpect.run(
() => runApp(MyApp()),
logger: logger,
);
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
localizationsDelegates: ISpectLocalizations.localizationDelegates([
// Add your localization delegates here
]),
builder: (context, child) => ISpectBuilder(
child: child ?? const SizedBox.shrink(),
),
home: Scaffold(
appBar: AppBar(title: const Text('ISpect Example')),
body: Center(
child: ElevatedButton(
onPressed: () {
ISpect.logger.info('Button pressed!');
},
child: const Text('Press me'),
),
),
),
);
}
}
```
## ⚙️ Advanced Configuration
### 🎨 Custom Theming
```dart
MaterialApp(
builder: (context, child) => ISpectBuilder(
theme: ISpectTheme(
pageTitle: 'Your name here',
lightBackgroundColor: Colors.white,
darkBackgroundColor: Colors.black,
lightDividerColor: Colors.grey.shade300,
darkDividerColor: Colors.grey.shade800,
logColors: {
'error': Colors.red,
'info': Colors.blue,
},
logIcons: {
'error': Icons.error,
'info': Icons.info,
},
logDescriptions: [
LogDescription(
key: 'riverpod-add',
isDisabled: true,
),
LogDescription(
key: 'riverpod-update',
isDisabled: true,
),
LogDescription(
key: 'riverpod-dispose',
isDisabled: true,
),
LogDescription(
key: 'riverpod-fail',
isDisabled: true,
),
],
),
child: child ?? const SizedBox.shrink(),
),
/* ... */
)
```
### 🎛️ Panel Customization
```dart
MaterialApp(
builder: (context, child) => ISpectBuilder(
options: ISpectOptions(
locale: const Locale('your_locale'),
isFeedbackEnabled: true,
actionItems: [
ISpectActionItem(
onTap: (BuildContext context) {},
title: 'Some title here',
icon: Icons.add),
],
panelItems: [
ISpectPanelItem(
enableBadge: false,
icon: Icons.settings,
onTap: (context) {
// Handle settings tap
},
),
],
panelButtons: [
ISpectPanelButtonItem(
icon: Icons.info,
label: 'Info',
onTap: (context) {
// Handle info tap
}),
],
),
child: child ?? const SizedBox.shrink(),
),
/* ... */
)
```
## 📚 Examples
Complete example applications are available in the [example/](example/) directory demonstrating core functionality.
## 🏗️ Architecture
ISpect is built as a modular system with specialized packages:
| Package | Purpose | Version |
|---------|---------|---------|
| [ispect](../ispect) | Core debugging interface and tools | [](https://pub.dev/packages/ispect) |
| [ispectify](../ispectify) | Foundation logging system (based on Talker) | [](https://pub.dev/packages/ispectify) |
| [ispectify_dio](../ispectify_dio) | Dio HTTP client integration | [](https://pub.dev/packages/ispectify_dio) |
| [ispectify_http](../ispectify_http) | Standard HTTP client integration | [](https://pub.dev/packages/ispectify_http) |
| [ispectify_bloc](../ispectify_bloc) | BLoC state management integration | [](https://pub.dev/packages/ispectify_bloc) |
| [ispect_jira](../ispect_jira) | Jira ticket creation integration | [](https://pub.dev/packages/ispect_jira) |
## 🤝 Contributing
Contributions are welcome! Please read our [contributing guidelines](../../CONTRIBUTING.md) and submit pull requests to the main branch.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🔗 Related Packages
- [ispectify](../ispectify) - Foundation logging system
- [ispectify_dio](../ispectify_dio) - Dio HTTP client integration
- [ispectify_http](../ispectify_http) - Standard HTTP client integration
- [ispectify_bloc](../ispectify_bloc) - BLoC state management integration
- [ispect_jira](../ispect_jira) - Jira ticket creation integration
---
Built with ❤️ for the Flutter community
