The second revision (#8)

Author: habedi

.github/workflows/lints.yml

@@ -2,8 +2,6 @@ name: Run Linter Checks
 
 on:
   push:
-    branches:
-      - main
     tags:
       - 'v*'
 

.github/workflows/tests.yml

@@ -2,8 +2,6 @@ name: Run Tests
 
 on:
   push:
-    branches:
-      - main
     tags:
       - 'v*'
 

.pre-commit-config.yaml

@@ -1,4 +1,5 @@
 default_stages: [ pre-push ]
+fail_fast: false
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -39,4 +40,3 @@ repos:
         entry: make test
         language: system
         pass_filenames: false
-        stages: [ pre-push ]

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
-# Code of Conduct
+## Code of Conduct
 
 We adhere to the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) version 2.1.

CONTRIBUTING.md

@@ -1,34 +1,34 @@
-# Contribution Guidelines
+## Contribution Guidelines
 
 Thank you for considering contributing to this project!
 Contributions are always welcome and appreciated.
 
-## How to Contribute
+### How to Contribute
 
 Please check the [issue tracker](https://github.com/habedi/chilli/issues) to see if there is an issue you
 would like to work on or if it has already been resolved.
 
-### Reporting Bugs
+#### Reporting Bugs
 
 1. Open an issue on the [issue tracker](https://github.com/habedi/chilli/issues).
 2. Include information such as steps to reproduce the observed behavior and relevant logs or screenshots.
 
-### Suggesting Features
+#### Suggesting Features
 
 1. Open an issue on the [issue tracker](https://github.com/habedi/chilli/issues).
 2. Provide details about the feature, its purpose, and potential implementation ideas.
 
-## Submitting Pull Requests
+### Submitting Pull Requests
 
-- Ensure all tests pass before submitting a pull request.
+- Make sure all tests pass before submitting a pull request.
 - Write a clear description of the changes you made and the reasons behind them.
 
 > [!IMPORTANT]
 > It's assumed that by submitting a pull request, you agree to license your contributions under the project's license.
 
-## Development Workflow
+### Development Workflow
 
-### Prerequisites
+#### Prerequisites
 
 Install GNU Make on your system if it's not already installed.
 
@@ -39,22 +39,22 @@ sudo apt-get install make
 
 - Use the `make install-deps` command to install the development dependencies.
 
-### Code Style
+#### Code Style
 
 - Use the `make format` command to format the code.
 
-### Running Tests
+#### Running Tests
 
 - Use the `make test` command to run the tests.
 
-### Running Linters
+#### Running Linters
 
 - Use the `make lint` command to run the linters.
 
-### See Available Commands
+#### See Available Commands
 
 - Run `make help` to see all available commands for managing different tasks.
 
-## Code of Conduct
+### Code of Conduct
 
-We adhere to the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) version 2.1.
+We adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md).

Makefile

@@ -35,15 +35,15 @@ help: ## Show the help messages for all targets
 	@grep -E '^[a-zA-Z_-]+:.*## .*$$' Makefile | \
 	awk 'BEGIN {FS = ":.*## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}'
 
-all: build test lint doc  ## build, test, lint, and doc
+all: build test lint docs  ## build, test, lint, and doc
 
 build: ## Build project (Mode=$(BUILD_TYPE))
 	@echo "Building project in $(BUILD_TYPE) mode with $(JOBS) concurrent jobs..."
 	@$(ZIG) build $(BUILD_OPTS) -j$(JOBS)
 
 rebuild: clean build  ## clean and build
 
-run: ## Run an example (e.g. 'make run EXAMPLE=trie' or 'make run' for all)
+run: ## Run an example (e.g. 'make run EXAMPLE=e1_simple_cli' or 'make run' for all)
 	@if [ "$(EXAMPLE)" = "all" ]; then \
 	   echo "--> Running all examples..."; \
 	   for ex in $(EXAMPLES); do \

README.md

@@ -8,9 +8,9 @@
 
 [![Tests](https://img.shields.io/github/actions/workflow/status/habedi/chilli/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/habedi/chilli/actions/workflows/tests.yml)
 [![CodeFactor](https://img.shields.io/codefactor/grade/github/habedi/chilli?label=code%20quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/habedi/chilli)
-[![Zig Version](https://img.shields.io/badge/Zig-0.14.1-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
-[![Docs](https://img.shields.io/github/v/tag/habedi/chilli?label=docs&color=blue&style=flat&labelColor=282c34&logo=read-the-docs)](https://habedi.github.io/chilli/)
-[![Examples](https://img.shields.io/github/v/tag/habedi/chilli?label=examples&color=green&style=flat&labelColor=282c34&logo=zig)](https://github.com/habedi/chilli/tree/main/examples)
+[![Zig Version](https://img.shields.io/badge/Zig-0.15.1-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
+[![Docs](https://img.shields.io/badge/docs-view-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://habedi.github.io/chilli/)
+[![Examples](https://img.shields.io/badge/examples-view-green?style=flat&labelColor=282c34&logo=zig)](https://github.com/habedi/chilli/tree/main/examples)
 [![Release](https://img.shields.io/github/release/habedi/chilli.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/habedi/chilli/releases/latest)
 [![License](https://img.shields.io/badge/license-MIT-007ec6?label=license&style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/habedi/chilli/blob/main/LICENSE)
 
@@ -47,7 +47,8 @@ Run the following command in the root directory of your project to download Chil
 zig fetch --save=chilli "https://github.com/habedi/chilli/archive/<branch_or_tag>.tar.gz"
 ```
 
-Replace `<branch_or_tag>` with the desired branch or tag, like `main` or `v0.1.0`.
+Replace `<branch_or_tag>` with the desired branch or tag, like `main` (for the development version) or `v0.2.0`
+(for the latest release).
 This command will download Chilli and add it to Zig's global cache and update your project's `build.zig.zon` file.
 
 #### Adding to Build Script
@@ -61,21 +62,25 @@ pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
 
-    const exe = b.addExecutable(.{
-        .name = "your-cli-app",
-        .root_source_file = b.path("src/main.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-
     // 1. Get the dependency object from the builder
     const chilli_dep = b.dependency("chilli", .{});
 
-    // 2. Get chilli's top-level module
+    // 2. Create a module for the dependency
     const chilli_module = chilli_dep.module("chilli");
 
-    // 3. Add the module to your executable so you can @import("chilli")
-    exe.root_module.addImport("chilli", chilli_module);
+    // 3. Create your executable module and add chilli as import
+    const exe_module = b.createModule(.{
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+    exe_module.addImport("chilli", chilli_module);
+
+    // 4. Create executable with the module
+    const exe = b.addExecutable(.{
+        .name = "your-cli-app",
+        .root_module = exe_module,
+    });
 
     b.installArtifact(exe);
 }
@@ -136,6 +141,23 @@ pub fn main() anyerror!void {
 }
 ```
 
+You can now run your CLI application with the `--help` flag to see the output below:
+
+```bash
+$ ./your-cli-app --help
+your-cli-app v0.2.0
+A new CLI built with Chilli
+
+USAGE:
+    your-cli-app [FLAGS]
+
+FLAGS:
+    -n, --name <string>      The name to greet [default: World]
+        --excitement <int>   How excited to be [default: 1]
+    -h, --help               Prints help information
+    -V, --version            Prints version information
+```
+
 ---
 
 ### Documentation
@@ -147,12 +169,9 @@ from the source code.
 This will generate HTML documentation in the `docs/api` directory, which you can serve locally with `make serve-docs`
 and view in your web browser at [http://localhost:8000](http://localhost:8000).
 
-> [!NOTE]
-> To generate the documentation, you need to have Zig (version 0.14.1) and Python 3 installed on your system.
-
 ### Examples
 
-Check out the [examples](examples/README.md) directory for examples of how Chilli can be used to build a variety of CLI
+Check out the [examples](examples/) directory for examples of how Chilli can be used to build a variety of CLI
 applications.
 
 ### Feature Roadmap

build.zig

@@ -8,16 +8,23 @@ pub fn build(b: *std.Build) void {
     // --- Library Setup ---
     const lib_source = b.path("src/lib.zig");
 
-    const lib = b.addStaticLibrary(.{
-        .name = "chilli",
+    const lib_module = b.createModule(.{
         .root_source_file = lib_source,
         .target = target,
         .optimize = optimize,
     });
+
+    const lib = b.addLibrary(.{
+        .name = "chilli",
+        .root_module = lib_module,
+    });
     b.installArtifact(lib);
 
-    const lib_module = b.createModule(.{
+    // Export the module so downstream projects can use it
+    _ = b.addModule("chilli", .{
         .root_source_file = lib_source,
+        .target = target,
+        .optimize = optimize,
     });
 
     // --- Docs Setup ---
@@ -39,12 +46,16 @@ pub fn build(b: *std.Build) void {
     docs_step.dependOn(&gen_docs_cmd.step);
 
     // --- Test Setup ---
-    const lib_unit_tests = b.addTest(.{
+    const test_module = b.createModule(.{
         .root_source_file = lib_source,
         .target = target,
         .optimize = optimize,
     });
 
+    const lib_unit_tests = b.addTest(.{
+        .root_module = test_module,
+    });
+
     const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
     const test_step = b.step("test", "Run unit tests");
     test_step.dependOn(&run_lib_unit_tests.step);
@@ -61,13 +72,17 @@ pub fn build(b: *std.Build) void {
         const exe_name = fs.path.stem(entry.name);
         const exe_path = b.fmt("{s}/{s}", .{ examples_path, entry.name });
 
-        const exe = b.addExecutable(.{
-            .name = exe_name,
+        const exe_module = b.createModule(.{
             .root_source_file = b.path(exe_path),
             .target = target,
             .optimize = optimize,
         });
-        exe.root_module.addImport("chilli", lib_module);
+        exe_module.addImport("chilli", lib_module);
+
+        const exe = b.addExecutable(.{
+            .name = exe_name,
+            .root_module = exe_module,
+        });
         b.installArtifact(exe);
 
         const run_cmd = b.addRunArtifact(exe);

examples/README.md

@@ -1,4 +1,4 @@
-# Chilli's Examples
+## Chilli Examples
 
 | **#** | **File**                                         | **Description**                                                             |
 |-------|--------------------------------------------------|-----------------------------------------------------------------------------|

examples/e1_simple_cli.zig

@@ -60,7 +60,7 @@ pub fn main() anyerror!void {
 fn rootExec(ctx: chilli.CommandContext) anyerror!void {
     const app_ctx = ctx.getContextData(AppContext).?;
     const config_slice = try ctx.getFlag("config", []const u8);
-    const stdout = std.io.getStdOut().writer();
+    const stdout = std.fs.File.stdout().deprecatedWriter();
 
     if (app_ctx.config_path.len > 0) {
         ctx.app_allocator.free(app_ctx.config_path);
@@ -75,7 +75,7 @@ fn rootExec(ctx: chilli.CommandContext) anyerror!void {
 fn runExec(ctx: chilli.CommandContext) anyerror!void {
     const task_name = try ctx.getArg("task-name", []const u8);
     const files = ctx.getArgs("files");
-    const stdout = std.io.getStdOut().writer();
+    const stdout = std.fs.File.stdout().deprecatedWriter();
 
     try stdout.print("Running task '{s}'...\n", .{task_name});