From 556bb95b4c737d389043b95ec4e75d69583c2cbc Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Sat, 1 Nov 2025 14:19:11 +0100 Subject: [PATCH 1/3] Fix the URL mismatch --- CONTRIBUTING.md | 6 +++--- README.md | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6234df9..c7c6878 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,17 +5,17 @@ Contributions are always welcome and appreciated. ### How to Contribute -Please check the [issue tracker](https://github.com/habedi/chilli/issues) to see if there is an issue you +Please check the [issue tracker](https://github.com/CogitatorTech/chilli/issues) to see if there is an issue you would like to work on or if it has already been resolved. #### Reporting Bugs -1. Open an issue on the [issue tracker](https://github.com/habedi/chilli/issues). +1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/chilli/issues). 2. Include information such as steps to reproduce the observed behavior and relevant logs or screenshots. #### Suggesting Features -1. Open an issue on the [issue tracker](https://github.com/habedi/chilli/issues). +1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/chilli/issues). 2. Provide details about the feature, its purpose, and potential implementation ideas. ### Submitting Pull Requests diff --git a/README.md b/README.md index b448594..f56c402 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@

Chilli

-[![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) +[![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/chilli/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/chilli/actions/workflows/tests.yml) +[![CodeFactor](https://img.shields.io/codefactor/grade/github/CogitatorTech/chilli?label=code%20quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/CogitatorTech/chilli) [![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) +[![Docs](https://img.shields.io/badge/docs-read-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://CogitatorTech.github.io/chilli/) +[![Examples](https://img.shields.io/badge/examples-view-green?style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/chilli/tree/main/examples) +[![Release](https://img.shields.io/github/release/CogitatorTech/chilli.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/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/CogitatorTech/chilli/blob/main/LICENSE) A microframework for creating command-line applications in Zig @@ -44,7 +44,7 @@ You can add Chilli to your project and start using it by following the steps bel Run the following command in the root directory of your project to download Chilli: ```sh -zig fetch --save=chilli "https://github.com/habedi/chilli/archive/.tar.gz" +zig fetch --save=chilli "https://github.com/CogitatorTech/chilli/archive/.tar.gz" ``` Replace `` with the desired branch or tag, like `main` (for the development version) or `v0.2.0` @@ -162,7 +162,7 @@ FLAGS: ### Documentation -You can find the full API documentation for the latest release of Chilli [here](https://habedi.github.io/chilli/). +You can find the full API documentation for the latest release of Chilli [here](https://CogitatorTech.github.io/chilli/). Alternatively, you can use the `make docs` command to generate the API documentation for the current version of Chilli from the source code. From 6069b347e49acd9fbc75d4e8eb2417c076b3d67a Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Sat, 1 Nov 2025 14:24:47 +0100 Subject: [PATCH 2/3] Add a `ROADMAP.md` file --- README.md | 41 ++++++++++------------------------------- ROADMAP.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 31 deletions(-) create mode 100644 ROADMAP.md diff --git a/README.md b/README.md index f56c402..4cf745b 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ [![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/chilli/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/chilli/actions/workflows/tests.yml) [![CodeFactor](https://img.shields.io/codefactor/grade/github/CogitatorTech/chilli?label=code%20quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/CogitatorTech/chilli) -[![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-read-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://CogitatorTech.github.io/chilli/) +[![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-read-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://CogitatorTech.github.io/chilli) [![Examples](https://img.shields.io/badge/examples-view-green?style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/chilli/tree/main/examples) [![Release](https://img.shields.io/github/release/CogitatorTech/chilli.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/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/CogitatorTech/chilli/blob/main/LICENSE) @@ -33,6 +33,12 @@ while being small and fast, and not getting in the way of your application logic - Uses a shared context to pass application state - Written in pure Zig with no external dependencies +See the [ROADMAP.md](ROADMAP.md) for the list of implemented and planned features. + +> [!IMPORTANT] +> Chilli is in early development, so bugs and breaking changes are expected. +> Please use the [issues page](https://github.com/CogitatorTech/chilli/issues) to report bugs or request features. + --- ### Getting Started @@ -162,7 +168,7 @@ FLAGS: ### Documentation -You can find the full API documentation for the latest release of Chilli [here](https://CogitatorTech.github.io/chilli/). +You can find the full API documentation for the latest release of Chilli [here](https://CogitatorTech.github.io/chilli). Alternatively, you can use the `make docs` command to generate the API documentation for the current version of Chilli from the source code. @@ -171,36 +177,9 @@ and view in your web browser at [http://localhost:8000](http://localhost:8000). ### Examples -Check out the [examples](examples/) 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 - -- [x] **Command Structure** - - [x] Nested commands and subcommands - - [x] Command aliases and single-character shortcuts - - [x] Persistent flags (flags on parent commands are available to children) - -- [x] **Argument & Flag Parsing** - - [x] Long flags (`--verbose`), short flags (`-v`), and grouped boolean flags (`-vf`) - - [x] Positional Arguments (supports required, optional, and variadic) - - [x] Type-safe access for flags and arguments (e.g., `ctx.getFlag("count", i64)`) - - [x] Reading flag values from environment variables - -- [x] **Help & Usage Output** - - [x] Automatic and context-aware `--help` flag - - [x] Automatic `--version` flag - - [x] Clean, aligned help output for commands, flags, and arguments - - [x] Grouping subcommands into custom sections - -- [x] **Developer Experience** - - [x] Simple, declarative API for building commands - - [x] Named access for all flags and arguments - - [x] Shared context data for passing application state - - [ ] Deprecation notices for commands or flags - - [ ] Built-in TUI components (like spinners and progress bars) - - [ ] Automatic command history and completion - --- ### Contributing diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..002e19c --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,32 @@ +## Feature Roadmap + +This document includes the roadmap for the Chilli project. +It outlines features to be implemented and their current status. + +> [!IMPORTANT] +> This roadmap is a work in progress and is subject to change. + +- **Command Structure** + - [x] Nested commands and subcommands + - [x] Command aliases and single-character shortcuts + - [x] Persistent flags (flags on parent commands are available to children) + +- **Argument & Flag Parsing** + - [x] Long flags (`--verbose`), short flags (`-v`), and grouped boolean flags (`-vf`) + - [x] Positional Arguments (supports required, optional, and variadic) + - [x] Type-safe access for flags and arguments (e.g., `ctx.getFlag("count", i64)`) + - [x] Reading flag values from environment variables + +- **Help & Usage Output** + - [x] Automatic and context-aware `--help` flag + - [x] Automatic `--version` flag + - [x] Clean, aligned help output for commands, flags, and arguments + - [x] Grouping subcommands into custom sections + +- **Developer Experience** + - [x] Simple, declarative API for building commands + - [x] Named access for all flags and arguments + - [x] Shared context data for passing application state + - [ ] Deprecation notices for commands or flags + - [ ] Built-in TUI components (like spinners and progress bars) + - [ ] Automatic command history and completion From 9638a507ca8316f108a17e5c76193d71717b0d23 Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Sat, 1 Nov 2025 14:27:12 +0100 Subject: [PATCH 3/3] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++++ build.zig.zon | 2 +- 4 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..db16dc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Logs** +If applicable, add logs to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..83c4904 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discussions + url: https://github.com/CogitatorTech/chilli/discussions + about: Please ask and answer general questions here diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..11fc491 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/build.zig.zon b/build.zig.zon index 0bf68c8..cbc5913 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -1,6 +1,6 @@ .{ .name = .chilli, - .version = "0.2.1", + .version = "0.2.2", .fingerprint = 0x6c259741ae4f5f73, // Changing this has security and trust implications. .minimum_zig_version = "0.15.1", .paths = .{