diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..db3cb54 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/.zig-cache/ +/zig-out/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..d8b4369 --- /dev/null +++ b/README.md @@ -0,0 +1,122 @@ +``` + _ _ _ _ _ _ _ _ _ + | \ | (_) | | | | | \ / | | | | | + | \| |_ __ _| |__ | |_ \ \ _ / /_ _| |_ __| |___ + | . ` | |/ _` | '_ \| __| \ ` ' / _` | __|/ _| '_ \ + | |\ | | (_| | | | | |_ \ / (_| | |_| (_| | | | + |_| \_|_|\__, |_| |_|\__| \_|_/ \__,_|\__|\__|_| |_| + __/ | + |___/ + T H E N I G H T W A T C H +``` +![nightwatch](docs/nightwatch.png) + +> The city sleeps. +> The files do not. + +"FABRICATI DIEM, PVNC" + +**The Night Watch** is a file change tracker for directory trees, written +in **Zig**. + +It provides: + +- A standalone CLI for tracking filesystem changes +- A module for embedding change-tracking into other Zig programs +- Minimal dependencies and consistent, predictable, cross-platform behavior + +It does not interfere. +It does not speculate. +It simply keeps watch. + +------------------------------------------------------------------------ + +## Features + +- Recursive directory tree tracking +- Deterministic multi-platform support (Linux, FreeBSD, MacOS, Windows) +- Lightweight and fast +- Embeddable Zig module API +- Standalone CLI executable + +------------------------------------------------------------------------ + +# Installation + +The Watch is written in **Zig** and built using the Zig build system. + +## Requirements + +- Zig (latest stable recommended) + +## Build CLI + +``` bash +zig build +``` + +The executable will be located in: + +`zig-out/bin/nightwatch` + +## Install System-Wide + +``` bash +zig build install +``` + +------------------------------------------------------------------------ + +# Using as a Zig Module + +The Night Watch exposes a reusable module that can be imported into +other Zig programs. + +In your `build.zig`: + +``` zig +const nightwatch = b.dependency("nightwatch", .{ + .target = target, + .optimize = optimize, +}); + +exe.root_module.addImport("nightwatch", nightwatch.module("nightwatch")); +``` + +In your Zig source: + +``` zig +const nightwatch = @import("nightwatch"); +``` + +You now have programmatic access to the tracking engine. + +------------------------------------------------------------------------ + +# CLI Usage + +``` bash +nightwatch [{path}..] +``` + +Run: + +``` bash +nightwatch --help +``` + +for full command documentation. + +------------------------------------------------------------------------ + +# Philosophy + +Other tools watch files. + +The Night Watch keeps watch over the peace. + +It remembers what changed. +It records what vanished. +It notices what arrived at 2:14 AM. + +And it writes it down. diff --git a/build.zig b/build.zig new file mode 100644 index 0000000..2cf4311 --- /dev/null +++ b/build.zig @@ -0,0 +1,46 @@ +const std = @import("std"); + +pub fn build(b: *std.Build) void { + const target = b.standardTargetOptions(.{}); + const optimize = b.standardOptimizeOption(.{}); + + const mod = b.addModule("nightwatch", .{ + .root_source_file = b.path("src/nightwatch.zig"), + .target = target, + }); + + const exe = b.addExecutable(.{ + .name = "nightwatch", + .root_module = b.createModule(.{ + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + .imports = &.{ + .{ .name = "nightwatch", .module = mod }, + }, + }), + }); + + b.installArtifact(exe); + + const run_step = b.step("run", "Run the app"); + const run_cmd = b.addRunArtifact(exe); + run_step.dependOn(&run_cmd.step); + run_cmd.step.dependOn(b.getInstallStep()); + if (b.args) |args| + run_cmd.addArgs(args); + + const mod_tests = b.addTest(.{ + .root_module = mod, + }); + const run_mod_tests = b.addRunArtifact(mod_tests); + + const exe_tests = b.addTest(.{ + .root_module = exe.root_module, + }); + const run_exe_tests = b.addRunArtifact(exe_tests); + + const test_step = b.step("test", "Run tests"); + test_step.dependOn(&run_mod_tests.step); + test_step.dependOn(&run_exe_tests.step); +} diff --git a/build.zig.zon b/build.zig.zon new file mode 100644 index 0000000..d4d3787 --- /dev/null +++ b/build.zig.zon @@ -0,0 +1,81 @@ +.{ + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save `, 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 = .flow_changes, + // 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", + // 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 + // unambiguous detection of one package being an updated version of + // another. + // + // When forking a Zig project, this id should be regenerated (delete the + // field and run `zig build`) if the upstream project is still maintained. + // Otherwise, the fork is *hostile*, attempting to take control over the + // original project's identity. Thus it is recommended to leave the comment + // on the following line intact, so that it shows up in code reviews that + // modify the field. + .fingerprint = 0x63107cb039894510, // Changing this has security and trust implications. + // Tracks the earliest Zig version that the package considers to be a + // supported use case. + .minimum_zig_version = "0.15.2", + // 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 ` 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. If the contents of a URL change this will result in a hash mismatch + // // which will prevent zig from using it. + // .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", + }, +} diff --git a/docs/nightwatch.png b/docs/nightwatch.png new file mode 100644 index 0000000..fbc9566 Binary files /dev/null and b/docs/nightwatch.png differ diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..c4cbfb0 --- /dev/null +++ b/src/main.zig @@ -0,0 +1,8 @@ +const std = @import("std"); +const nightwatch = @import("nightwatch"); + +pub fn main() !void { + std.debug.print("FABRICATI DIEM, PVNC\n", .{}); +} + +test "simple test" {}