softprops/zig-termsize

terminal size matters

termsize

terminal size matters

---

🍬 features

Termsize is a zig library providing a multi-platform interface for resolving your terminal's current size in rows and columns. On most unix systems, this is similar invoking the stty(1) program, requesting the terminal size.

examples

const std = @import("std");
const termsize = @import("termsize");

pub fn main() !void {
    std.debug.print(
        "{any}",
        .{termsize.termSize(std.io.getStdOut())},
    );
}

📼 installing

Create a new exec project with zig init-exe. Copy the echo handler example above into src/main.zig

Create a build.zig.zon file to declare a dependency

.zon short for "zig object notation" files are essentially zig structs. build.zig.zon is zigs native package manager convention for where to declare dependencies

Starting in zig 0.12.0, you can use and should prefer

zig fetch --save https://github.com/softprops/zig-termsize/archive/refs/tags/v0.1.0.tar.gz

otherwise, to manually add it, do so as follows

.{
    .name = "my-app",
    .version = "0.1.0",
    .dependencies = .{
+        // 👇 declare dep properties
+        .termsize = .{
+            // 👇 uri to download
+            .url = "https://github.com/softprops/zig-termsize/archive/refs/tags/v0.1.0.tar.gz",
+            // 👇 hash verification
+            .hash = "{current-hash}",
+        },
    },
}

the hash below may vary. you can also depend any tag with https://github.com/softprops/zig-termsize/archive/refs/tags/v{version}.tar.gz or current main with https://github.com/softprops/zig-termsize/archive/refs/heads/main/main.tar.gz. to resolve a hash omit it and let zig tell you the expected value.

Add the following in your build.zig file

const std = @import("std");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});

    const optimize = b.standardOptimizeOption(.{});
+    // 👇 de-reference termsize dep from build.zig.zon
+    const termsize = b.dependency("termsize", .{
+        .target = target,
+        .optimize = optimize,
+    }).module("termsize");
    var exe = b.addExecutable(.{
        .name = "your-exe",
        .root_source_file = .{ .path = "src/main.zig" },
        .target = target,
        .optimize = optimize,
    });
+    // 👇 add the termsize module to executable
+    exe.root_module.addImport("termsize", termsize);

    b.installArtifact(exe);
}

🥹 for budding ziglings

Does this look interesting but you're new to zig and feel left out? No problem, zig is young so most us of our new are as well. Here are some resources to help get you up to speed on zig

• the official zig website
• zig's one-page language documentation
• ziglearn
• ziglings exercises

- softprops 2024