feat: add --version and --help CLI flags, bump to v0.2.0

Author: subtleGradient

build.zig

@@ -1,5 +1,7 @@
 const std = @import("std");
 
+const version = "0.2.0";
+
 // Although this function looks imperative, it does not perform the build
 // directly and instead it mutates the build graph (`b`) that will be then
 // executed by an external runner. The functions in `std.Build` implement a DSL
@@ -77,6 +79,10 @@ pub fn build(b: *std.Build) void {
     //
     // If neither case applies to you, feel free to delete the declaration you
     // don't need and to put everything under a single module.
+    // Create build options module to pass version to the executable
+    const build_options = b.addOptions();
+    build_options.addOption([]const u8, "version", version);
+
     const exe = b.addExecutable(.{
         .name = "ansilust",
         .root_module = b.createModule(.{
@@ -100,6 +106,7 @@ pub fn build(b: *std.Build) void {
                 // importing modules from different packages).
                 .{ .name = "ansilust", .module = mod },
                 .{ .name = "parsers", .module = parsers_mod },
+                .{ .name = "build_options", .module = build_options.createModule() },
             },
         }),
     });

build.zig.zon

@@ -9,7 +9,7 @@
     .name = .ansilust,
     // This is a [Semantic Version](https://semver.org/).
     // In a future version of Zig it will be used for package deduplication.
-    .version = "0.0.0",
+    .version = "0.2.0",
     // Together with name, this represents a globally unique package
     // identifier. This field is generated by the Zig toolchain when the
     // package is first created, and then *never changes*. This allows

packages/ansilust/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ansilust",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Next-generation text art processing system - convert, render, and animate ANSI art",
   "main": "index.js",
   "bin": {
@@ -26,16 +26,16 @@
     "detect-libc": "^2.1.2"
   },
   "optionalDependencies": {
-    "ansilust-darwin-arm64": "0.0.1",
-    "ansilust-darwin-x64": "0.0.1",
-    "ansilust-linux-aarch64-gnu": "0.0.1",
-    "ansilust-linux-aarch64-musl": "0.0.1",
-    "ansilust-linux-arm-gnu": "0.0.1",
-    "ansilust-linux-arm-musl": "0.0.1",
-    "ansilust-linux-i386-musl": "0.0.1",
-    "ansilust-linux-x64-gnu": "0.0.1",
-    "ansilust-linux-x64-musl": "0.0.1",
-    "ansilust-win32-x64": "0.0.1"
+    "ansilust-darwin-arm64": "0.2.0",
+    "ansilust-darwin-x64": "0.2.0",
+    "ansilust-linux-aarch64-gnu": "0.2.0",
+    "ansilust-linux-aarch64-musl": "0.2.0",
+    "ansilust-linux-arm-gnu": "0.2.0",
+    "ansilust-linux-arm-musl": "0.2.0",
+    "ansilust-linux-i386-musl": "0.2.0",
+    "ansilust-linux-x64-gnu": "0.2.0",
+    "ansilust-linux-x64-musl": "0.2.0",
+    "ansilust-win32-x64": "0.2.0"
   },
   "engines": {
     "node": ">=14.0.0"

src/main.zig

@@ -1,5 +1,31 @@
 const std = @import("std");
 const ansilust = @import("ansilust");
+const build_options = @import("build_options");
+
+const version = build_options.version;
+
+fn printVersion() void {
+    const stdout_file = std.fs.File{ .handle = std.posix.STDOUT_FILENO };
+    stdout_file.writeAll("ansilust " ++ version ++ "\n") catch {};
+}
+
+fn printHelp(file: std.fs.File) void {
+    file.writeAll(
+        \\ansilust - Next-generation text art processing system
+        \\
+        \\USAGE:
+        \\    ansilust [OPTIONS] <file.ans> [<file2.ans> ...]
+        \\
+        \\OPTIONS:
+        \\    -h, --help       Print this help message
+        \\    -V, --version    Print version information
+        \\
+        \\EXAMPLES:
+        \\    ansilust artwork.ans           Render ANSI art to terminal
+        \\    ansilust file1.ans file2.ans   Render multiple files
+        \\
+    ) catch {};
+}
 
 fn processFile(allocator: std.mem.Allocator, path: []const u8) !void {
     const file_data = std.fs.cwd().readFileAlloc(allocator, path, 100 * 1024 * 1024) catch |e| {
@@ -34,14 +60,40 @@ pub fn main() !void {
 
     _ = args.next(); // skip argv0
 
+    const stdout_file = std.fs.File{ .handle = std.posix.STDOUT_FILENO };
+    const stderr_file = std.fs.File{ .handle = std.posix.STDERR_FILENO };
+
     var file_count: usize = 0;
-    while (args.next()) |path| {
-        try processFile(allocator, path);
-        file_count += 1;
+    var show_help = false;
+    var show_version = false;
+
+    while (args.next()) |arg| {
+        if (std.mem.eql(u8, arg, "-h") or std.mem.eql(u8, arg, "--help")) {
+            show_help = true;
+        } else if (std.mem.eql(u8, arg, "-V") or std.mem.eql(u8, arg, "--version")) {
+            show_version = true;
+        } else if (std.mem.startsWith(u8, arg, "-")) {
+            std.debug.print("error: unknown option '{s}'\n", .{arg});
+            stderr_file.writeAll("Try 'ansilust --help' for more information.\n") catch {};
+            std.process.exit(1);
+        } else {
+            try processFile(allocator, arg);
+            file_count += 1;
+        }
     }
 
-    if (file_count == 0) {
-        std.debug.print("usage: ansilust <file.ans> [<file2.ans> ...]\n", .{});
+    if (show_version) {
+        printVersion();
+        return;
+    }
+
+    if (show_help) {
+        printHelp(stdout_file);
         return;
     }
+
+    if (file_count == 0) {
+        printHelp(stderr_file);
+        std.process.exit(1);
+    }
 }