initial commit

.gitignore

@@ -0,0 +1 @@
+zig-out/

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 nref
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,2 @@
+build:
+	@zig build -Doptimize=ReleaseSafe

README.md

@@ -0,0 +1,118 @@
+# pdir
+
+pdir ("pretty directory" or "print directory") is a lightweight, Zig-based
+implementation of the Linux tree command. It provides a visual representation
+of directory structures, using 📁 icons for directories and 📄 icons for files.
+
+## Features
+
+- Customizable directory path and depth
+- Intuitive visual representation of file system structures
+- Provides count of directories, files, sym-links, and others
+- Simple and efficient command-line interface
+
+## Requirements
+
+This was made with Zig version 0.14.0-dev.130+cb308ba3a
+
+[Zig](https://ziglang.org/download/) - master release (2024-06-28 or later)
+
+> [!CAUTION]
+> This program was only tested on Linux.
+
+## Installation
+
+1. Clone the repository:
+
+```sh
+git clone https://github.com/nronzel/pdir
+cd pdir
+```
+
+2. Build the binary:
+
+```sh
+make
+```
+
+OR
+
+[Download the latest release binary](/releases)
+
+Be sure to add the binary to a directory that is on your `$PATH`. See [quick setup](#quick-setup)
+
+## Usage
+
+```sh
+pdir [directory] [depth]
+```
+
+- directory: Optional. Path to the directory you want to visualize. Defaults to
+  the current working directory.
+- depth: Optional. Maximum depth of directory traversal. Defaults to 2.
+
+### Examples
+
+```sh
+pdir ~/Documents 3
+```
+
+This command will display the directory structure of ~/Documents up to a depth
+of 3 levels.
+
+```sh
+pdir
+```
+
+This command will display the directory structure of the current working
+directory up to a depth of 2 levels.
+
+## Quick Setup
+
+To use pdir from anywhere in your terminal:
+
+1. Copy the binary to a directory that is in your PATH:
+
+```sh
+cp ./zig-out/bin/pdir ~/.local/bin/
+```
+
+On Linux, you can view the directories in your path by running:
+
+```sh
+echo $PATH
+```
+
+Now you can run pdir from any location in your terminal.
+
+## Testing
+
+Run the included tests:
+
+```sh
+zig test src/main.zig
+```
+
+## About
+
+I write this re-implementation of `tree` any time I am learning a new language
+as I feel it helps me get a good grasp of some of the basics of the language
+(i.e. working with strings, files & directories, directory traversal,
+recursion, comparisons, sorting, argument parsing, etc.).
+
+Overall this was a joy to build. I'm sure there are plenty of areas for
+improvement in my implementation and use of the language, but as a first project
+after going through [Ziglings](https://codeberg.org/ziglings/exercises/) I am
+happy with what I have.
+
+As for Zig, I am realling liking the language and I'm excited to follow its
+development as it approaches v1.0 and beyond.
+
+Coming from mostly writing Go for the past year, having proper enums, unions,
+tagged unions, and optionals is like a breath of fresh air.
+
+I will definitely be using more Zig in my side projects!
+
+> [!NOTE]
+> I developed this on my local self-hosted forgejo and uploaded to Github later,
+> hence the lack of commit history.

build.zig

@@ -0,0 +1,77 @@
+const std = @import("std");
+
+// Although this function looks imperative, note that its job is to
+// declaratively construct a build graph that will be executed by an external
+// runner.
+pub fn build(b: *std.Build) void {
+    // Standard target options allows the person running `zig build` to choose
+    // what target to build for. Here we do not override the defaults, which
+    // means any target is allowed, and the default is native. Other options
+    // for restricting supported target set are available.
+    const target = b.standardTargetOptions(.{});
+
+    // Standard optimization options allow the person running `zig build` to select
+    // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
+    // set a preferred release mode, allowing the user to decide how to optimize.
+    const optimize = b.standardOptimizeOption(.{});
+
+    const exe = b.addExecutable(.{
+        .name = "pdir",
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    // This declares intent for the executable to be installed into the
+    // standard location when the user invokes the "install" step (the default
+    // step when running `zig build`).
+    b.installArtifact(exe);
+
+    // This *creates* a Run step in the build graph, to be executed when another
+    // step is evaluated that depends on it. The next line below will establish
+    // such a dependency.
+    const run_cmd = b.addRunArtifact(exe);
+
+    // By making the run step depend on the install step, it will be run from the
+    // installation directory rather than directly from within the cache directory.
+    // This is not necessary, however, if the application depends on other installed
+    // files, this ensures they will be present and in the expected location.
+    run_cmd.step.dependOn(b.getInstallStep());
+
+    // This allows the user to pass arguments to the application in the build
+    // command itself, like this: `zig build run -- arg1 arg2 etc`
+    if (b.args) |args| {
+        run_cmd.addArgs(args);
+    }
+
+    // This creates a build step. It will be visible in the `zig build --help` menu,
+    // and can be selected like this: `zig build run`
+    // This will evaluate the `run` step rather than the default, which is "install".
+    const run_step = b.step("run", "Run the app");
+    run_step.dependOn(&run_cmd.step);
+
+    // Creates a step for unit testing. This only builds the test executable
+    // but does not run it.
+    // const lib_unit_tests = b.addTest(.{
+    //     .root_source_file = b.path("src/root.zig"),
+    //     .target = target,
+    //     .optimize = optimize,
+    // });
+
+    // const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
+
+    const exe_unit_tests = b.addTest(.{
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);
+
+    // Similar to creating the run step earlier, this exposes a `test` step to
+    // the `zig build --help` menu, providing a way for the user to request
+    // running the unit tests.
+    const test_step = b.step("test", "Run unit tests");
+    // test_step.dependOn(&run_lib_unit_tests.step);
+    test_step.dependOn(&run_exe_unit_tests.step);
+}

build.zig.zon

@@ -0,0 +1,72 @@
+.{
+    // This is the default name used by packages depending on this one. For
+    // example, when a user runs `zig fetch --save <url>`, this field is used
+    // as the key in the `dependencies` table. Although the user can choose a
+    // different name, most users will stick with this provided value.
+    //
+    // It is redundant to include "zig" in this name because it is already
+    // within the Zig package namespace.
+    .name = "pdir",
+
+    // 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",
+
+    // This field is optional.
+    // This is currently advisory only; Zig does not yet do anything
+    // with this value.
+    //.minimum_zig_version = "0.11.0",
+
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // internet connectivity.
+    .dependencies = .{
+        // See `zig fetch --save <url>` for a command-line interface for adding dependencies.
+        //.example = .{
+        //    // When updating this field to a new URL, be sure to delete the corresponding
+        //    // `hash`, otherwise you are communicating that you expect to find the old hash at
+        //    // the new URL.
+        //    .url = "https://example.com/foo.tar.gz",
+        //
+        //    // This is computed from the file contents of the directory of files that is
+        //    // obtained after fetching `url` and applying the inclusion rules given by
+        //    // `paths`.
+        //    //
+        //    // This field is the source of truth; packages do not come from a `url`; they
+        //    // come from a `hash`. `url` is just one of many possible mirrors for how to
+        //    // obtain a package matching this `hash`.
+        //    //
+        //    // Uses the [multihash](https://multiformats.io/multihash/) format.
+        //    .hash = "...",
+        //
+        //    // When this is provided, the package is found in a directory relative to the
+        //    // build root. In this case the package's hash is irrelevant and therefore not
+        //    // computed. This field and `url` are mutually exclusive.
+        //    .path = "foo",
+
+        //    // When this is set to `true`, a package is declared to be lazily
+        //    // fetched. This makes the dependency only get fetched if it is
+        //    // actually used.
+        //    .lazy = false,
+        //},
+    },
+
+    // Specifies the set of files and directories that are included in this package.
+    // Only files and directories listed here are included in the `hash` that
+    // is computed for this package. Only files listed here will remain on disk
+    // when using the zig package manager. As a rule of thumb, one should list
+    // files required for compilation plus any license(s).
+    // Paths are relative to the build root. Use the empty string (`""`) to refer to
+    // the build root itself.
+    // A directory listed here means that all files within, recursively, are included.
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+        // For example...
+        //"LICENSE",
+        //"README.md",
+    },
+}