Refactor code structure for improved readability and maintainability

ymrabti · ymrabti · commit 82dd9183629b · 2026-02-23T01:56:00.000Z
diff --git a/.fvmrc b/.fvmrc
@@ -0,0 +1,3 @@
+{
+  "flutter": "3.41.2"
+}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,15 @@
+name: publish_pub_dev
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*" # Trigger on version tags
+  workflow_dispatch: # Allows manual triggering
+
+jobs:
+  publish:
+    permissions:
+      id-token: write
+    uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
+    # env:
+    #   PUB_DEV_TOKEN: zero
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,6 @@ build/
 # Omit committing pubspec.lock for library packages; see
 # https://dart.dev/guides/libraries/private-files#pubspeclock.
 pubspec.lock
+
+# FVM Version Cache
+.fvm/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "dart.flutterSdkPath": ".fvm/versions/3.41.2"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 2.0.0
+- Major update.
+- Use Dart developper logger.
+- Better documentation.
+- Beautify the code.
+- Update README.md and CHANGELOG.md.
+
 ## 1.0.1
 
 - Latest version.
diff --git a/README.md b/README.md
@@ -1,31 +1,135 @@
+<div align="center">
 
-## Usage
+<div align="center">
+    <img src="https://raw.githubusercontent.com/youmtinetflutterpacks/console_tools/refs/heads/main/assets/readme_banner.png" alt="console_tools logo"/>
+</div>
+
+[![pub package](https://img.shields.io/pub/v/console_tools.svg)](https://pub.dev/packages/console_tools)
+[![pub likes](https://img.shields.io/pub/likes/console_tools.svg)](https://pub.dev/packages/console_tools/score)
+[![pub points](https://img.shields.io/pub/points/console_tools.svg?color=blue)](https://pub.dev/packages/console_tools/score)
+[![platform](https://img.shields.io/badge/platform-flutter-blue)](https://flutter.dev)
+
+[![GitHub stars](https://img.shields.io/github/stars/youmtinetflutterpacks/console_tools.svg?style=flat&logo=github&colorB=&label=Stars)](https://github.com/youmtinetflutterpacks/console_tools/stargazers)
+[![GitHub issues](https://img.shields.io/github/issues/youmtinetflutterpacks/console_tools.svg?style=flat&logo=github&colorB=&label=Issues)](https://github.com/youmtinetflutterpacks/console_tools/issues)
+[![GitHub license](https://img.shields.io/github/license/youmtinetflutterpacks/console_tools.svg?style=flat&logo=github&colorB=&label=License)](https://github.com/youmtinetflutterpacks/console_tools/blob/main/LICENSE)
+[![GitHub last commit](https://img.shields.io/github/last-commit/youmtinetflutterpacks/console_tools.svg?style=flat&logo=github&colorB=&label=Last%20Commit)](https://github.com/youmtinetflutterpacks/console_tools/commits/main)
+
+
+[![Build status](https://github.com/youmtinetflutterpacks/console_tools/workflows/publish_pub_dev/badge.svg?style=flat&logo=github&colorB=&label=Build)](https://github.com/youmtinetflutterpacks/console_tools)
+</div>
+
+A lightweight Dart console logger with ANSI color support, log-level icons, timestamps, and JSON pretty-printing.
+
+---
+
+## Features
+
+- **Five log levels**: `debug`, `info`, `success`, `warning`, `error`
+- **ANSI color-coded output** (grey, cyan, green, yellow, red)
+- **Icons** for each level: 🐛 ℹ️ ✅ ⚠️ ❌
+- **Optional tag** to identify the source of a log entry
+- **Timestamp** prefix (`[HH:mm:ss]`)
+- **JSON pretty-printing** with indentation
+- Global toggles: `Console.enableColors` and `Console.showTimestamp`
+
+---
+
+## Installation
 
+Add the package to your `pubspec.yaml`:
+
+```yaml
+dependencies:
+  console_tools: ^2.0.0
+```
+
+Then run:
+
+```sh
+dart pub get
+```
+
+---
+
+## Usage
 
 ```dart
 import 'package:console_tools/console_tools.dart';
 
 void main() {
-  for (var element in ConsoleColors.values) {
-    Console.log(
-      element.name,
-      color: element,
-      consoleStyle: ConsoleStyles.normal,
-    );
-  }
-  Console.log('awesome: Console log normal 002', consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log normal 003', consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log normal 004', consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log normal', consoleStyle: ConsoleStyles.bold);
-  Console.log('awesome: Console log', consoleStyle: ConsoleStyles.bold);
-  Console.log('awesome: Console log clineote', consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log clineoteFast', consoleStyle: ConsoleStyles.clineoteFast);
-  Console.log('awesome: Console log italic', consoleStyle: ConsoleStyles.italic);
-  Console.log('awesome: Console log lineThrought', consoleStyle: ConsoleStyles.lineThrought);
-  Console.log('awesome: Console log normal2', consoleStyle: ConsoleStyles.normal2);
-  Console.log('awesome: Console log opacity', consoleStyle: ConsoleStyles.opacity);
-  Console.log('awesome: Console log underline', consoleStyle: ConsoleStyles.underline);
+  Console.d("Debug message");
+  Console.i("Info message", tag: "AUTH");
+  Console.s("Login successful");
+  Console.w("API slow response");
+  Console.e("Crash detected");
+
+  Console.json({
+    "user": "Younes",
+    "role": "developer",
+  });
 }
+```
 
+### Sample output
+
+```
+[12:34:56] 🐛  Debug message
+[12:34:56] ℹ️ [AUTH] Info message
+[12:34:56] ✅  Login successful
+[12:34:56] ⚠️  API slow response
+[12:34:56] ❌  Crash detected
+[12:34:56] 🐛  {
+  "user": "Younes",
+  "role": "developer"
+}
+```
+
+---
+
+## API Reference
+
+### `Console` class
+
+| Method | Level | Color | Description |
+|---|---|---|---|
+| `Console.d(msg, {tag})` | debug | grey | Debug information |
+| `Console.i(msg, {tag})` | info | cyan | General information |
+| `Console.s(msg, {tag})` | success | green | Success confirmation |
+| `Console.w(msg, {tag})` | warning | yellow | Non-critical warnings |
+| `Console.e(msg, {tag})` | error | red | Errors and exceptions |
+| `Console.json(obj, {tag})` | debug | grey | Pretty-prints a JSON object |
+| `Console.log(msg, {name})` | info | cyan | Alias for `Console.i` |
+
+### Global settings
+
+```dart
+Console.enableColors = false;    // disable ANSI colors (default: true)
+Console.showTimestamp = false;   // hide the [HH:mm:ss] prefix (default: true)
 ```
 
+---
+
+## License
+
+MIT
+
+## 🔗 More Packages
+
+- [Power GeoJSON](https://pub.dev/packages/power_geojson)
+- [PopupMenu2](https://pub.dev/packages/popup_menu_2)
+- [Flutter Azimuth](https://pub.dev/packages/flutter_azimuth)
+- [Map Contextual Menu](https://pub.dev/packages/longpress_popup)
+
+---
+
+## 👨‍💻 Developer Card
+
+<div align="center">
+    <img src="https://avatars.githubusercontent.com/u/47449165?v=4" alt="Younes M'rabti avatar" width="120" height="120" style="border-radius: 50%;" />
+
+### Younes M'rabti
+
+📧 Email: [admin@youmti.net](mailto:admin@youmti.net)  
+🌐 Website: [youmti.net](https://www.youmti.net/)  
+💼 LinkedIn: [younesmrabti1996](https://www.linkedin.com/in/younesmrabti1996/)
+</div>
diff --git a/assets/console_tools.png b/assets/console_tools.png
diff --git a/assets/console_tools_logo.png b/assets/console_tools_logo.png
diff --git a/assets/logo.png b/assets/logo.png
diff --git a/assets/readme_banner.png b/assets/readme_banner.png
diff --git a/example/console_tools_example.dart b/example/console_tools_example.dart
@@ -1,33 +1,14 @@
 import 'package:console_tools/console_tools.dart';
 
 void main() {
-  for (var element in ConsoleColors.values) {
-    Console.log(
-      element.name,
-      color: element,
-      consoleStyle: ConsoleStyles.normal,
-    );
-  }
-  Console.log('awesome: Console log normal 002',
-      consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log normal 003',
-      consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log normal 004',
-      consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log normal', consoleStyle: ConsoleStyles.bold);
-  Console.log('awesome: Console log', consoleStyle: ConsoleStyles.bold);
-  Console.log('awesome: Console log clineote',
-      consoleStyle: ConsoleStyles.clineote);
-  Console.log('awesome: Console log clineoteFast',
-      consoleStyle: ConsoleStyles.clineoteFast);
-  Console.log('awesome: Console log italic',
-      consoleStyle: ConsoleStyles.italic);
-  Console.log('awesome: Console log lineThrought',
-      consoleStyle: ConsoleStyles.lineThrought);
-  Console.log('awesome: Console log normal2',
-      consoleStyle: ConsoleStyles.normal2);
-  Console.log('awesome: Console log opacity',
-      consoleStyle: ConsoleStyles.opacity);
-  Console.log('awesome: Console log underline',
-      consoleStyle: ConsoleStyles.underline);
+  Console.d("Debug message");
+  Console.i("Info message", tag: "AUTH");
+  Console.s("Login successful");
+  Console.w("API slow response");
+  Console.e("Crash detected");
+
+  Console.json({
+    "user": "Younes",
+    "role": "developer",
+  });
 }
diff --git a/lib/src/console_tools_base.dart b/lib/src/console_tools_base.dart
@@ -1,50 +1,17 @@
 import 'dart:async';
-import 'dart:developer' as dev;
-
-enum ConsoleStyles {
-  normal,
-  bold,
-  opacity,
-  italic,
-  underline,
-  clineote,
-  clineoteFast,
-  none,
-  normal2,
-  lineThrought,
-}
-
-enum ConsoleColors {
-  /// #000000 black
-  black,
-
-  /// #c42654 Rose Red
-  roseRed,
-
-  /// #4c892d Sap Green
-  greenSap,
-
-  /// #94b428 Citron
-  citron,
-
-  /// #6a7ec8 Violet-Blue
-  crayola,
-
-  /// #8c6bc8 Middle Blue Purple
-  middleBluePurple,
+import 'dart:convert';
 
-  /// #
-  teal,
-
-  /// #
-  white,
+enum LogLevel {
+  debug,
+  info,
+  success,
+  warning,
+  error,
 }
 
 class Console {
   static log(
     Object? text, {
-    ConsoleColors color = ConsoleColors.white,
-    ConsoleStyles consoleStyle = ConsoleStyles.normal,
     String name = 'logger',
     DateTime? time,
     int? sequenceNumber,
@@ -53,17 +20,69 @@ class Console {
     Object? error,
     StackTrace? stackTrace,
   }) {
-    var printtext =
-        '\x1B[${color.index + 30}m$text\x1B[${consoleStyle.index}m\x1B[m';
-    dev.log(
-      printtext,
-      name: name,
-      error: error,
-      level: level,
-      sequenceNumber: sequenceNumber,
-      stackTrace: stackTrace,
-      time: time,
-      zone: zone,
-    );
+    i(text, tag: name);
+  }
+
+  Console._();
+
+  static bool enableColors = true;
+  static bool showTimestamp = true;
+
+  // ANSI colors
+  static const _reset = '\x1B[0m';
+
+  static const _colors = {
+    LogLevel.debug: '\x1B[90m', // grey
+    LogLevel.info: '\x1B[36m', // cyan
+    LogLevel.success: '\x1B[32m', // green
+    LogLevel.warning: '\x1B[33m', // yellow
+    LogLevel.error: '\x1B[31m', // red
+  };
+
+  static const _icons = {
+    LogLevel.debug: '🐛',
+    LogLevel.info: 'ℹ️',
+    LogLevel.success: '✅',
+    LogLevel.warning: '⚠️',
+    LogLevel.error: '❌',
+  };
+
+  static void d(Object? message, {String? tag}) => _log(LogLevel.debug, message, tag);
+
+  static void i(Object? message, {String? tag}) => _log(LogLevel.info, message, tag);
+
+  static void s(Object? message, {String? tag}) => _log(LogLevel.success, message, tag);
+
+  static void w(Object? message, {String? tag}) => _log(LogLevel.warning, message, tag);
+
+  static void e(Object? message, {String? tag}) => _log(LogLevel.error, message, tag);
+
+  static void json(Object jsonObj, {String? tag}) {
+    final encoder = const JsonEncoder.withIndent('  ');
+    final pretty = encoder.convert(jsonObj);
+    _log(LogLevel.debug, pretty, tag);
+  }
+
+  static void _log(LogLevel level, Object? message, String? tag) {
+    final time = showTimestamp ? _timeNow() : '';
+    final icon = _icons[level];
+    final tagPart = tag != null ? '[$tag]' : '';
+
+    final base = '$time $icon $tagPart $message';
+
+    if (!enableColors) {
+      print(base);
+      return;
+    }
+
+    final color = _colors[level];
+    print('$color$base$_reset');
+  }
+
+  static String _timeNow() {
+    final now = DateTime.now();
+    return '[${now.hour.toString().padLeft(2, '0')}:'
+        '${now.minute.toString().padLeft(2, '0')}:'
+        '${now.second.toString().padLeft(2, '0')}]';
   }
 }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,10 +1,10 @@
 name: console_tools
-description: A consolle logger class, have custom colors, and text styles already defined.
-version: 1.0.1
+description: A console logger class, with custom colors and text styles already defined.
+version: 2.0.0
 homepage: https://github.com/ymrabti/console_tools.git
 
 environment:
-  sdk: ">=3.1.0 <4.0.0"
+  sdk: ^3.11.0
 
 # dependencies:
 #   path: ^1.8.0

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "dart.flutterSdkPath": ".fvm/versions/3.41.2"`
	`3`	`+}`