Version 0.0.3. (#4)

* 🏗️ Update main architecture.

* 🩹 Fix JetBrain's terminal issue.

* 🎨 Update code structure.

* 📝 Update README.md.

* 🚸 Add cancelSign to empty informed messages.

* 🎨 Create NullableStringExtension.

* 🔖 Version bump 0.0.3.

Author: edufolly

.github/workflows/main.yml

@@ -17,6 +17,7 @@ jobs:
       - name: Get Pubspec Version
         run: |
           VERSION=$(grep 'version:' pubspec.yaml | cut -c 10- | cut -f 1 -d '+')
+          sed -i "s/dev/$VERSION/g" bin/gitmoji.dart
           echo "VERSION=$VERSION" >> $GITHUB_ENV
 
       - name: Check if version is used

README.md

@@ -1,4 +1,4 @@
-# 🚀 gitmoji
+# 🚀 gitmoji 😄
 
 A tool inspired by **[gitmoji](https://gitmoji.dev/)** that helps you create
 standardized, emoji-based Git commits — **without installing any dependencies,
@@ -24,3 +24,9 @@ This project solves that by providing:
 ## 📦 Installation
 
 Just download the binary for your operating system and make it executable.
+
+```shell
+curl -sSLO https://github.com/edufolly/gitmoji/releases/latest/download/gitmoji
+chmod +x gitmoji
+sudo mv gitmoji /usr/local/bin
+```

bin/gitmoji.dart

@@ -1,9 +1,15 @@
+import 'package:gitmoji/github_client.dart';
 import 'package:gitmoji/gitmoji.dart';
 import 'package:gitmoji/gitmoji_client.dart';
 import 'package:gitmoji/main.dart';
 
 void main(List<String> arguments) async {
-  List<Gitmoji> gitmojiList = await GitmojiClient().fetch(false);
+  final String version = 'dev';
+  final bool debug = false;
 
-  if (gitmojiList.isNotEmpty) Main().run(gitmojiList);
+  await GithubClient(debug).fetch(version);
+
+  List<Gitmoji> gitmojiList = await GitmojiClient(debug).fetch();
+
+  if (gitmojiList.isNotEmpty) Main(debug).run(gitmojiList);
 }

lib/ansi.dart

@@ -18,10 +18,8 @@ class Ansi {
   static String cursorPosition({int row = 1, int col = 1}) =>
       row < 1 || col < 1 ? '' : '$csi$row;${col}H';
 
-  static String cursorSavePosition = '${csi}s';
-
-  static String cursorRestorePosition = '${csi}u';
-
+  static const String cursorSavePosition = '${csi}s';
+  static const String cursorRestorePosition = '${csi}u';
   static const String clearDisplayDown = '${csi}0J';
   static const String clearDisplayUp = '${csi}1J';
   static const String clearEntireLine = '${csi}2K';
@@ -32,6 +30,8 @@ class Ansi {
   static const String dim = '${csi}2m';
   static const String italic = '${csi}3m';
   static const String underline = '${csi}4m';
+  static const String slowBlink = '${csi}5m';
+  static const String fastBlink = '${csi}6m';
 
   /// Colors - 3-bit and 4-bit
   static const String red = '${csi}31m';

lib/github_client.dart

@@ -0,0 +1,53 @@
+import 'dart:convert';
+
+import 'package:http/http.dart' as http;
+
+import 'ansi.dart';
+
+class GithubClient {
+  final bool debug;
+
+  GithubClient(this.debug);
+
+  Future<void> fetch(
+    String version, {
+    String newVersionMessage = 'New version available:',
+    String url =
+        'https://api.github.com/repos/edufolly/gitmoji/releases/latest',
+    int timeout = 2,
+  }) async {
+    if (version == 'dev') return;
+
+    try {
+      final response = await http
+          .get(
+            Uri.parse(url),
+            headers: {'Accept': 'application/vnd.github+json'},
+          )
+          .timeout(Duration(seconds: timeout));
+
+      if (response.statusCode != 200) {
+        if (debug) {
+          print('Status code: ${response.statusCode}');
+          print('Body: ${response.body}');
+        }
+        return;
+      }
+
+      final body = jsonDecode(response.body);
+
+      final name = body['name']?.toString() ?? 'ERROR';
+
+      if (version != name) {
+        print(
+          '\n$newVersionMessage ${Ansi.green}${Ansi.bold}$name${Ansi.reset}\n',
+        );
+      }
+    } on Exception catch (e, s) {
+      if (debug) {
+        print(e);
+        print(s);
+      }
+    }
+  }
+}

lib/gitmoji.dart

@@ -16,6 +16,21 @@ class Gitmoji {
     required this.semver,
   }) : key = '$name $description'.toLowerCase();
 
+  factory Gitmoji.fromJson(dynamic map) {
+    if (map is Map<dynamic, dynamic>) {
+      return Gitmoji(
+        emoji: map['emoji'].toString(),
+        entity: map['entity'].toString(),
+        code: map['code'].toString(),
+        description: map['description'].toString().trim(),
+        name: map['name'].toString(),
+        semver: map['semver']?.toString(),
+      );
+    } else {
+      throw Exception();
+    }
+  }
+
   @override
   String toString() => '$emoji  $description';
 }

lib/gitmoji_client.dart

@@ -1,13 +1,17 @@
 import 'dart:convert';
 import 'dart:io' as io;
 
+import 'package:gitmoji/nullable_string_extension.dart';
 import 'package:http/http.dart' as http;
 
 import 'gitmoji.dart';
 
 class GitmojiClient {
-  Future<List<Gitmoji>> fetch(
-    bool debug, {
+  final bool debug;
+
+  GitmojiClient(this.debug);
+
+  Future<List<Gitmoji>> fetch({
     String url =
         'https://raw.githubusercontent.com/carloscuesta/gitmoji/refs/heads'
         '/master/packages/gitmojis/src/gitmojis.json',
@@ -25,33 +29,25 @@ class GitmojiClient {
       if (debug) print('Getting definition...');
       jsonString = await _fetchFromWeb(debug, url);
 
-      if (jsonString.isEmpty && cacheFile.existsSync()) {
-        print('Using old cache.');
-        jsonString = cacheFile.readAsStringSync();
+      if (jsonString.isNotEmpty) {
+        cacheFile.writeAsStringSync(jsonString);
+      } else {
+        if (cacheFile.existsSync()) {
+          if (debug) print('Using old cache.');
+          jsonString = cacheFile.readAsStringSync();
+        }
       }
     }
 
-    if (jsonString.trim().isEmpty) {
-      throw Exception('GitMojis definition not found.');
+    if (jsonString.isNullOrBlank) {
+      throw Exception('Gitmojis definition not found.');
     }
 
     final body = jsonDecode(jsonString);
 
-    cacheFile.writeAsStringSync(jsonString);
-
     final List<dynamic> list = body['gitmojis'];
 
-    return list.map((item) {
-      final map = item as Map<String, dynamic>;
-      return Gitmoji(
-        emoji: map['emoji'].toString(),
-        entity: map['entity'].toString(),
-        code: map['code'].toString(),
-        description: map['description'].toString().trim(),
-        name: map['name'].toString(),
-        semver: map['semver']?.toString(),
-      );
-    }).toList();
+    return list.map((item) => Gitmoji.fromJson(item)).toList();
   }
 
   Future<String> _fetchFromWeb(bool debug, String url) async {