Merge pull request #20 from utox39/fix/invalid-module-memory-leak

Fix a memory leak when the InvalidModule error occurs

.github/workflows/build.yml

@@ -65,17 +65,11 @@ jobs:
         ls -la zig-out/bin/
         file zig-out/bin/zigfetch-${{ matrix.target }}
 
-    - name: Create archive
-      run: |
-        tar -czf zigfetch-${{ matrix.target }}.tar.gz -C zig-out/bin zigfetch-${{ matrix.target }}
-
     - name: Upload artifacts
       uses: actions/upload-artifact@v4
       with:
         name: zigfetch-${{ matrix.target }}
-        path: |
-          # zig-out/bin/zigfetch-${{ matrix.target }}
-          zigfetch-${{ matrix.target }}.tar.gz
+        path: zig-out/bin/zigfetch-${{ matrix.target }}
         retention-days: 3
 
   test:

README.md

@@ -2,10 +2,15 @@
 
 ![Zig](https://img.shields.io/badge/Zig-%23F7A41D.svg?style=flat&logo=zig&logoColor=white)
 ![GitHub Release](https://img.shields.io/github/v/release/utox39/zigfetch)
+![GitHub License](https://img.shields.io/github/license/utox39/zigfetch)
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/utox39/zigfetch/build.yml)
 ![macOS](https://img.shields.io/badge/mac%20os-000000?style=flat&logo=macos&logoColor=F0F0F0)
 ![Linux](https://img.shields.io/badge/Linux-FCC624?style=flat&logo=linux&logoColor=black)
 
+|                     Default config                      |                     Custom config                     |
+| :-----------------------------------------------------: | :---------------------------------------------------: |
+| ![dafault-config](assets/screenshot-default-config.png) | ![custom-config](assets/screenshot-custom-config.png) |
+
 ---
 
 -   [Description](#description)
@@ -74,6 +79,83 @@ $ touch config.json
 $ cp /path/to/zigfetch/config.json ~/.config/zigfetch/config.json
 ```
 
+#### Modules
+
+Available modules:
+
+-   Os
+-   Kernel
+-   Uptime
+-   Packages
+-   Shell
+-   Cpu
+-   Gpu
+-   Ram
+-   Swap
+-   Disk
+-   Net
+-   Terminal
+-   Locale
+-   Custom
+
+| Module type |      Linux      |          macOS           | Windows |
+| :---------: | :-------------: | :----------------------: | :-----: |
+|     os      |       Yes       |           Yes            |   WIP   |
+|   kernel    |       Yes       |           Yes            |   WIP   |
+|   uptime    |       Yes       |           Yes            |   WIP   |
+|  packages   |       WIP       | Yes (Homebrew, Macports) |   WIP   |
+|    shell    | Yes (bash, zsh) |     Yes (bash, zsh)      |   WIP   |
+|     cpu     |       Yes       |           Yes            |   WIP   |
+|     gpu     |       Yes       | Yes (Apple Silicon only) |   WIP   |
+|     ram     |       Yes       |           Yes            |   WIP   |
+|    swap     |       Yes       |           Yes            |   WIP   |
+|    disk     |       Yes       |           Yes            |   WIP   |
+|     net     |       Yes       |           Yes            |   WIP   |
+|  terminal   |       Yes       |           Yes            |   WIP   |
+|   locale    |       Yes       |           Yes            |   WIP   |
+
+```json
+  "modules": [
+    {
+      "type": "os",
+      "key": "OS",
+      "key_color": "#5E81AC"
+    },
+    ...
+  ]
+```
+
+#### Custom module
+
+```json
+  "modules": [
+    {
+      "type": "custom",
+      "key": "-----------",
+      "key_color": "#5E81AC"
+    },
+    ...
+  ]
+```
+
+#### Custom ASCII art
+
+To use an ASCII art of your choice:
+
+```json
+"ascii_abs_path": "absolute_path/to/your/ascii_art.txt"
+```
+
+Don't use the `~` character.
+
+#### Username and Hostname color
+
+To change the Username and Hostname color (HEX colors only):
+
+```json
+"username_hostname_color": "#5E81AC"
+```
+
 ## Roadtrip
 
 -   [ ] Add ASCII art for each operating system and Linux distro

build.zig.zon

@@ -10,7 +10,7 @@
 
     // This is a [Semantic Version](https://semver.org/).
     // In a future version of Zig it will be used for package deduplication.
-    .version = "0.21.1",
+    .version = "0.22.1",
 
     // Together with name, this represents a globally unique package
     // identifier. This field is generated by the Zig toolchain when the

src/config.zig

@@ -1,5 +1,4 @@
 const std = @import("std");
-const builtin = @import("builtin");
 const ascii = @import("ascii.zig");
 
 pub const Module = struct {
@@ -10,6 +9,7 @@ pub const Module = struct {
 
 pub const Config = struct {
     ascii_abs_path: ?[]u8 = null,
+    username_hostname_color: ?[]u8 = null,
     modules: []Module,
 };
 
@@ -31,7 +31,15 @@ pub const ModuleType = enum {
 };
 
 pub fn getAsciiPath(config: ?std.json.Parsed(Config)) ?[]u8 {
-    return config.?.value.ascii_abs_path;
+    if (config) |c| {
+        return c.value.ascii_abs_path;
+    } else return null;
+}
+
+pub fn getUsernameHostnameColor(config: ?std.json.Parsed(Config)) ?[]u8 {
+    if (config) |c| {
+        return c.value.username_hostname_color;
+    } else return null;
 }
 
 pub fn getModulesTypes(allocator: std.mem.Allocator, config: ?std.json.Parsed(Config)) !std.array_list.Managed(ModuleType) {
@@ -43,6 +51,7 @@ pub fn getModulesTypes(allocator: std.mem.Allocator, config: ?std.json.Parsed(Co
             if (module_enum) |m| {
                 try modules_list.append(m);
             } else {
+                modules_list.deinit();
                 return error.InvalidModule;
             }
         }

src/formatters.zig

@@ -41,6 +41,17 @@ pub const default_formatters = [_]*const fn (allocator: std.mem.Allocator) anyer
     &getDefaultFormattedLocaleInfo,
 };
 
+pub fn getFormattedUsernameHostname(allocator: std.mem.Allocator, color: []const u8, username: []const u8, hostname: []const u8) ![]u8 {
+    return try std.fmt.allocPrint(allocator, "{s}{s}{s}@{s}{s}{s}", .{
+        color,
+        username,
+        ascii.Reset,
+        color,
+        hostname,
+        ascii.Reset,
+    });
+}
+
 pub fn getDefaultFormattedKernelInfo(allocator: std.mem.Allocator) !Result {
     return try getFormattedKernelInfo(allocator, "Kernel", ascii.Yellow);
 }

src/main.zig

@@ -27,14 +27,15 @@ pub fn main() !void {
 
     const username = try detection.user.getUsername(allocator);
     const hostname = try detection.system.getHostname(allocator);
-    try modules_list.append(try std.fmt.allocPrint(allocator, "{s}{s}{s}@{s}{s}{s}", .{
-        ascii.Yellow,
-        username,
-        ascii.Reset,
-        ascii.Yellow,
-        hostname,
-        ascii.Reset,
-    }));
+
+    const username_hostname_color = if (config.getUsernameHostnameColor(conf)) |color| blk: {
+        var buf: [32]u8 = undefined;
+        const rgb = try ascii.hexColorToRgb(color);
+        const formatted_color = try std.fmt.bufPrint(&buf, "\x1b[38;2;{d};{d};{d}m", .{ rgb.r, rgb.g, rgb.b });
+        break :blk formatted_color;
+    } else ascii.Yellow;
+
+    try modules_list.append(try formatters.getFormattedUsernameHostname(allocator, username_hostname_color, username, hostname));
     allocator.free(hostname);
     allocator.free(username);