ci(compile-and-publish-binaries-to-release): install the correct Rust target instead of leaving it unspecified

chore(ac-qu-ai-nt): release v0.0.14

.github/workflows/check-and-build-and-test.yml

@@ -18,8 +18,8 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  formatting-and-deny-and-audit:
-    name: Check formatting, cargo-deny, and cargo-audit
+  audit-and-deny-and-clippy-and-formatting:
+    name: Check cargo-audit, cargo-deny, clippy, and formatting
     runs-on: ubuntu-latest
     timeout-minutes: 4
     steps:
@@ -31,14 +31,21 @@ jobs:
       - name: Install cargo-audit
         uses: taiki-e/install-action@cargo-audit
 
-      - name: Formatting
-        run: cargo fmt --check --verbose
+      - uses: Swatinem/rust-cache@v2
+
+      - name: cargo-audit
+        run: cargo-audit audit --deny warnings
 
       - name: cargo-deny
         uses: EmbarkStudios/cargo-deny-action@v2
 
-      - name: cargo-audit
-        run: cargo-audit audit --deny warnings
+      - name: Clippy
+        run: cargo clippy
+        env:
+          RUSTFLAGS: "--deny warnings"
+
+      - name: Formatting
+        run: cargo fmt --check --verbose
 
   check-and-build:
     strategy:
@@ -198,24 +205,24 @@ jobs:
   msrv:
     strategy:
       matrix:
-        crate_directory:
-          - ./core
-          - ./cli-clap
-          - ./gui-eframe
-          - ./tui-ratatui
-          - ./multibinary
-
         supporteds:
           - runner: macos-latest
             target: aarch64-apple-darwin
 
+          - runner: macos-latest
+            target: x86_64-apple-darwin
+
           - runner: ubuntu-latest
             target: x86_64-unknown-linux-gnu
 
+          - install_prerequisite: sudo apt-get update && sudo apt-get install musl-dev musl-tools && sudo ln -s /bin/g++ /bin/musl-g++
+            runner: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+
           - prerequisite_step: rm ~/.cargo/bin/cargo.exe; rm ~/.cargo/bin/rust-analyzer.exe; rm ~/.cargo/bin/rustfmt.exe; rustup update
             runner: windows-latest
             target: x86_64-pc-windows-msvc
-    name: Verify MSRV of ${{ matrix.crate_directory }} for ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }})
+    name: Verify MSRV for ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }})
     runs-on: ${{ matrix.supporteds.runner }}
     timeout-minutes: 8
     steps:
@@ -236,6 +243,18 @@ jobs:
         with:
           tool: cargo-msrv
 
-      - name: Verify declared MSRV (minimum supported Rust version)
+      - name: Verify core's declared MSRV (minimum supported Rust version)
         run: cargo-msrv verify --output-format json
-        working-directory: ${{ matrix.crate_directory }}
+        working-directory: ./core
+      - name: Verify cli-clap's declared MSRV (minimum supported Rust version)
+        run: cargo-msrv verify --output-format json
+        working-directory: ./cli-clap
+      - name: Verify gui-eframe's declared MSRV (minimum supported Rust version)
+        run: cargo-msrv verify --output-format json
+        working-directory: ./gui-eframe
+      - name: Verify tui-ratatui's declared MSRV (minimum supported Rust version)
+        run: cargo-msrv verify --output-format json
+        working-directory: ./tui-ratatui
+      - name: Verify multibinary's declared MSRV (minimum supported Rust version)
+        run: cargo-msrv verify --output-format json
+        working-directory: ./multibinary

.github/workflows/compile-and-publish-binaries-to-release.yml

@@ -65,6 +65,8 @@ jobs:
 
       - name: Install stable Rust toolchain
         uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.supporteds.target }}
 
       - uses: Swatinem/rust-cache@v2
         with:
@@ -72,7 +74,7 @@ jobs:
           cache-on-failure: "true"
 
       - name: Build for release
-        run: cargo build --release --verbose
+        run: cargo build --release --verbose --target ${{ matrix.supporteds.target }}
 
       # Have to do it like this because of https://github.com/actions/runner/issues/1985
       - if: startsWith(github.event.release.tag_name, 'ac-qu-ai-nt-v')

.github/workflows/daily.yml

@@ -2,7 +2,7 @@ name: Daily
 
 on:
   schedule:
-    - cron: "27 17 * * *"
+    - cron: "26 9 * * *"
 
 jobs:
   audit:
@@ -150,7 +150,7 @@ jobs:
 
       - uses: Swatinem/rust-cache@v2
         with:
-          shared-key: ${{ matrix.supporteds.target }}-latest
+          shared-key: ${{ matrix.supporteds.target }}-latest-nightly
           cache-on-failure: "true"
 
       - name: Test

Cargo.lock

@@ -4,19 +4,21 @@ version = 3
 
 [[package]]
 name = "ac-qu-ai-nt"
-version = "0.0.12"
+version = "0.0.14"
 dependencies = [
  "ac-qu-ai-nt-cli-clap",
  "ac-qu-ai-nt-gui-eframe",
  "ac-qu-ai-nt-tui-ratatui",
+ "cfg-if",
  "clap",
  "dirs-next",
+ "snafu",
  "tracing-subscriber",
 ]
 
 [[package]]
 name = "ac-qu-ai-nt-cli-clap"
-version = "0.0.8"
+version = "0.0.9"
 dependencies = [
  "clap",
  "tracing",
@@ -24,7 +26,7 @@ dependencies = [
 
 [[package]]
 name = "ac-qu-ai-nt-core"
-version = "0.0.3"
+version = "0.0.4"
 dependencies = [
  "llama-cpp-2",
  "snafu",
@@ -33,14 +35,14 @@ dependencies = [
 
 [[package]]
 name = "ac-qu-ai-nt-gui-eframe"
-version = "0.0.5"
+version = "0.0.6"
 dependencies = [
  "tracing",
 ]
 
 [[package]]
 name = "ac-qu-ai-nt-tui-ratatui"
-version = "0.0.5"
+version = "0.0.6"
 dependencies = [
  "tracing",
 ]

README.md

@@ -5,6 +5,7 @@ This is a placeholder while I take small steps to build out the project.
 # Installation
 
 ## Automatically Updatable
+
 You won't find it very useful yet, because it doesn't really do much of anything, but you can install the multibinary with [Binstall](https://github.com/cargo-bins/cargo-binstall). This means you don't need to have the same development environment (which will require the Vulkan SDK and CUDA Toolkit in the future) in order to use the program, because you'll just download a precompiled executable.
 
 ```sh
@@ -12,28 +13,35 @@ cargo-binstall -y ac-qu-ai-nt
 ```
 
 Install [`cargo-update`](https://github.com/nabijaczleweli/cargo-update) and periodically run
+
 ```sh
 cargo install-update --all
 ```
+
 in order to keep this program up to date.
 
 I'm not sure if you need a Rust compiler installed for either or if they can work standalone.
 
 ## Just the Executable
+
 Head to [the Releases page](https://github.com/babichjacob/ac-qu-ai-nt/releases) and download the asset corresponding to your computer architecture and operating system.
 
 Decompress the archive and place the executable contained within it somewhere useful to you (e.g. in a directory in [your `PATH` variable](https://superuser.com/a/284351)).
 
 # Usage
+
 If it's your preference, you should be able to double click the executable in the folder to be able to run it (defaulting to launching a graphical interface (once I actually make one lol)).
 
 You could also type
+
 ```sh
 ac-qu-ai-nt
 ```
+
 on the command line to run it. This is also a way to launch a GUI (once there actually is one) for the application.
 
 ## Command Line Interface
+
 It's going to be a goal of this project for there to be feature parity between the GUI, CLI, and TUI.
 
 If you want to use its command line interface, start with
@@ -41,13 +49,22 @@ If you want to use its command line interface, start with
 ```sh
 ac-qu-ai-nt cli
 ```
+
 to see what capabilities are available.
 
 (This is an alias for `ac-qu-ai-nt cli-clap` to allow the possibility of experimenting with different implementations of the same type of interface.)
 
 # Contributing
 
-This is a summary of the crates I expect to be in this project and how they are used:
+## Issues and Pull Requests
+
+Please create an issue before working on a pull request. It's helpful for you to know if the idea you have in mind will for sure be incorporated into the project, and won't require you to _acquaint_ yourself with the project internals. It even opens the floor for someone else to do the work implementing it for you.
+
+Some [existing issues are labeled `straightforward`](https://github.com/babichjacob/ac-qu-ai-nt/issues?q=is%3Aissue+is%3Aopen+label%3Astraightforward) and expected to be the easiest to work on, if you'd like to try.
+
+## Project Breakdown
+
+This is a summary of the crates in this project and how they are used:
 
 ```mermaid
 flowchart TD
@@ -59,6 +76,28 @@ gui-eframe --> multibinary
 tui-ratatui --> multibinary
 ```
 
+### `core`
+
+The core of the project, where code for large language model and embedding model inference using [`llama-cpp-2`](https://crates.io/crates/llama-cpp-2) will be (because it's not started yet at the time of writing), where ingesting data will be done, and where public APIs that the other crates (`cli-clap`, `gui-eframe`, and `tui-ratatui`) use will be.
+
+Each of the interface crates are expected to have feature parity (as in capability, not as in a Cargo feature) where possible, but we'll see how that goes.
+
+### `cli-clap`
+
+A command line interface (CLI) for the project written with [`clap`](https://crates.io/crates/clap).
+
+### `gui-eframe`
+
+A graphical user interface (GUI) for the project written with [`eframe`](https://crates.io/crates/eframe) for [`egui`](https://crates.io/crates/egui).
+
+As of right now, it isn't started yet.
+
+### `tui-ratatui`
+
+A terminal user interface (TUI) for the project written with [`ratatui`](https://crates.io/crates/ratatui).
+
+As of right now, it isn't started yet.
+
 ## Versioning
 
 This project aims to adhere to [semantic versioning](https://semver.org/) using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), conducted by [Release-plz](https://release-plz.ieni.dev/).
@@ -74,8 +113,9 @@ All the crates in this project have a [minimum supported Rust version (MSRV)](ht
 ## License
 
 All contents of this repository are licensed under either the
-* [MIT license](LICENSE-MIT), or
-* [Apache 2.0 license](LICENSE-APACHE), or
-* [Unlicense](LICENSE-UNLICENSE)
+
+- [MIT license](LICENSE-MIT), or
+- [Apache 2.0 license](LICENSE-APACHE), or
+- [Unlicense](LICENSE-UNLICENSE)
 
 at your option.

cli-clap/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.9](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.8...ac-qu-ai-nt-cli-clap-v0.0.9) - 2024-10-15
+
+### Fixed
+
+- *(ac-qu-ai-nt-cli-clap)* write a `main` function instead of re-exporting so that the declared MSRV can be met
+
+### Other
+
+- *(cli-clap)* ignore the `Args` argument because it doesn't get used yet (to satisfy Clippy)
+- build out the infrastructure for commands to be passed to the clap CLI
+
 ## [0.0.8](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.7...ac-qu-ai-nt-cli-clap-v0.0.8) - 2024-10-07
 
 ### Other

cli-clap/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt-cli-clap"
 description = "A CLI (written with clap) for ac-qu-ai-nt"
-version = "0.0.8"
+version = "0.0.9"
 edition = "2021"
 rust-version = "1.76"
 

cli-clap/src/lib.rs

@@ -1,4 +1,15 @@
-pub fn main() {
+use clap::{Parser, Subcommand};
+
+#[derive(Debug, Subcommand)]
+enum Command {}
+
+#[derive(Debug, Parser)]
+pub struct Args {
+    #[command(subcommand)]
+    command: Command,
+}
+
+pub fn main(_args: Args) {
     #[cfg(feature = "tracing")]
     tracing::info!("What's up, world?");
 }

cli-clap/src/main.rs

@@ -1,3 +1,7 @@
+use clap::Parser;
+
 fn main() {
-    ac_qu_ai_nt_cli_clap::main();
+    let args = ac_qu_ai_nt_cli_clap::Args::parse();
+
+    ac_qu_ai_nt_cli_clap::main(args);
 }

core/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.4](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-core-v0.0.3...ac-qu-ai-nt-core-v0.0.4) - 2024-10-15
+
+### Other
+
+- update `llama-cpp-2` and other packages
+- *(ac-qu-ai-nt-core)* update `llama-cpp-2`
+- *(core)* add `snafu` as a dependency
+
 ## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-core-v0.0.2...ac-qu-ai-nt-core-v0.0.3) - 2024-10-07
 
 ### Other

core/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt-core"
 description = "The core library of ac-qu-ai-nt. If you're looking for the application, see cli-clap or gui-eframe or tui-ratatui or the multibinary"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2021"
 rust-version = "1.76"
 

gui-eframe/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.6](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-gui-eframe-v0.0.5...ac-qu-ai-nt-gui-eframe-v0.0.6) - 2024-10-15
+
+### Fixed
+
+- *(ac-qu-ai-nt-gui-eframe)* write a `main` function instead of re-exporting so that the declared MSRV can be met
+
 ## [0.0.5](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-gui-eframe-v0.0.4...ac-qu-ai-nt-gui-eframe-v0.0.5) - 2024-10-07
 
 ### Other

gui-eframe/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt-gui-eframe"
 description = "A GUI (written with egui / eframe) for ac-qu-ai-nt"
-version = "0.0.5"
+version = "0.0.6"
 edition = "2021"
 rust-version = "1.76"
 

multibinary/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.14](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.13...ac-qu-ai-nt-v0.0.14) - 2024-10-16
+
+### Added
+
+- *(multibinary)* support running the binary without arguments (using a sensible user interface as the default), and improve error reporting by using `snafu`
+
+### Other
+
+- *(multibinary)* mark the Clippy lint against manually implementing `Default` for `Command` as allowed
+- *(multibinary)* add `cfg-if` and `snafu` as dependencies
+
+## [0.0.13](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.12...ac-qu-ai-nt-v0.0.13) - 2024-10-15
+
+### Other
+
+- build out the infrastructure for commands to be passed to the clap CLI
+
 ## [0.0.12](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.11...ac-qu-ai-nt-v0.0.12) - 2024-10-07
 
 ### Other

multibinary/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt"
 description = "A WIP project using AI to break down a user's query, acquire the knowledge to answer it, then transfer those insights to the user"
-version = "0.0.12"
+version = "0.0.14"
 edition = "2021"
 rust-version = "1.76"
 
@@ -27,11 +27,13 @@ tracing = [
 ]
 
 [dependencies]
-ac-qu-ai-nt-cli-clap = { version = "0.0.8", path = "../cli-clap", optional = true }
-ac-qu-ai-nt-gui-eframe = { version = "0.0.5", path = "../gui-eframe", optional = true }
-ac-qu-ai-nt-tui-ratatui = { version = "0.0.5", path = "../tui-ratatui", optional = true }
+ac-qu-ai-nt-cli-clap = { version = "0.0.9", path = "../cli-clap", optional = true }
+ac-qu-ai-nt-gui-eframe = { version = "0.0.6", path = "../gui-eframe", optional = true }
+ac-qu-ai-nt-tui-ratatui = { version = "0.0.6", path = "../tui-ratatui", optional = true }
 
+cfg-if = "1.0.0"
 clap = { workspace = true, features = ["derive", "env"] }
 dirs-next = "2.0.0"
+snafu = { workspace = true }
 
 tracing-subscriber = { version = "0.3.18", optional = true }

multibinary/src/main.rs

@@ -1,6 +1,12 @@
-use std::{fs::create_dir_all, io::ErrorKind, path::PathBuf};
+use std::{
+    fs::create_dir_all,
+    io::ErrorKind,
+    path::{Path, PathBuf},
+};
 
+use cfg_if::cfg_if;
 use clap::{Parser, Subcommand};
+use snafu::{ResultExt, Snafu};
 
 #[derive(Debug, Parser)]
 struct Args {
@@ -11,24 +17,93 @@ struct Args {
     )]
     application_data_directory: PathBuf,
 
+    // If there is a GUI or TUI available from this binary,
+    // then calling this program without arguments
+    // is acceptable: it will launch a user interface
+    #[cfg(any(feature = "gui-eframe", feature = "tui-ratatui"))]
+    #[command(subcommand)]
+    command: Option<Command>,
+
+    #[cfg(not(any(feature = "gui-eframe", feature = "tui-ratatui")))]
     #[command(subcommand)]
     command: Command,
 }
 
 #[derive(Debug, Subcommand)]
 enum Command {
-    #[cfg(feature = "cli-clap")]
-    #[command(alias = "cli")]
-    CliClap,
     #[cfg(feature = "gui-eframe")]
     #[command(alias = "gui")]
     GuiEframe,
+
     #[cfg(feature = "tui-ratatui")]
     #[command(alias = "tui")]
     TuiRatatui,
+
+    #[cfg(feature = "cli-clap")]
+    #[command(alias = "cli")]
+    CliClap(ac_qu_ai_nt_cli_clap::Args),
 }
 
-fn main() {
+// When this program is run without arguments,
+// it will launch a user interface
+cfg_if!(
+    // with the GUI (made with eframe)
+    // being considered more appealing (made the default)
+    if #[cfg(feature = "gui-eframe")] {
+        #[allow(clippy::derivable_impls)]
+        impl Default for Command {
+            fn default() -> Self {
+                Command::GuiEframe
+            }
+        }
+    }
+    // than the TUI (made with Ratatui)
+    else if #[cfg(feature = "tui-ratatui")] {
+        #[allow(clippy::derivable_impls)]
+        impl Default for Command {
+            fn default() -> Self {
+                Command::TuiRatatui
+            }
+        }
+    }
+    // with it not being logical to specify
+    // the CLI (made with clap)
+    // as an option,
+    // because if `ac-qu-ai-nt ask "why is the sky blue?"`
+    // were accepted and worked when `cli-clap` was the only
+    // interface enabled, then when another interface
+    // like `gui-eframe` were enabled, it would stop working
+    // (only able to work as `ac-qu-ai-nt cli-clap ask "why is the sky blue?"`)
+    // so it should be required to do it the way that would work
+    // in both cases from the beginning
+);
+
+#[derive(Debug, Snafu)]
+enum ApplicationError {
+    #[snafu(display("failed to create the {path:?} directory"))]
+    DirectoryCreationError {
+        path: PathBuf,
+        source: std::io::Error,
+    },
+}
+
+/// Create the directory and its parents,
+/// but don't return an error if it already exists and is a directory
+fn create_dir_all_exist_ok(path: impl AsRef<Path>) -> Result<(), std::io::Error> {
+    match create_dir_all(&path) {
+        Ok(()) => Ok(()),
+        Err(e) => {
+            if e.kind() == ErrorKind::AlreadyExists && path.as_ref().is_dir() {
+                Ok(())
+            } else {
+                Err(e)
+            }
+        }
+    }
+}
+
+#[snafu::report]
+fn main() -> Result<(), ApplicationError> {
     let Args {
         application_data_directory,
         command,
@@ -37,30 +112,28 @@ fn main() {
     #[cfg(feature = "tracing")]
     tracing_subscriber::fmt::init();
 
-    match create_dir_all(&application_data_directory) {
-        Ok(()) => {}
-        Err(e) if e.kind() == ErrorKind::AlreadyExists => {}
-        Err(e) => {
-            panic!("{}", e);
+    create_dir_all_exist_ok(&application_data_directory).with_context(|_| {
+        DirectoryCreationSnafu {
+            path: application_data_directory.clone(),
         }
-    }
+    })?;
 
     let tracing_directory = application_data_directory.join("logs");
+    create_dir_all_exist_ok(&tracing_directory).with_context(|_| DirectoryCreationSnafu {
+        path: tracing_directory.clone(),
+    })?;
 
-    match create_dir_all(&tracing_directory) {
-        Ok(()) => {}
-        Err(e) if e.kind() == ErrorKind::AlreadyExists => {}
-        Err(e) => {
-            panic!("{}", e);
-        }
-    }
+    #[cfg(any(feature = "gui-eframe", feature = "tui-ratatui"))]
+    let command = command.unwrap_or_default();
 
     match command {
         #[cfg(feature = "cli-clap")]
-        Command::CliClap => ac_qu_ai_nt_cli_clap::main(),
+        Command::CliClap(args) => ac_qu_ai_nt_cli_clap::main(args),
         #[cfg(feature = "gui-eframe")]
         Command::GuiEframe => ac_qu_ai_nt_gui_eframe::main(),
         #[cfg(feature = "tui-ratatui")]
         Command::TuiRatatui => ac_qu_ai_nt_tui_ratatui::main(),
     }
+
+    Ok(())
 }

tui-ratatui/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.6](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-tui-ratatui-v0.0.5...ac-qu-ai-nt-tui-ratatui-v0.0.6) - 2024-10-15
+
+### Fixed
+
+- *(ac-qu-ai-nt-tui-ratatui)* write a `main` function instead of re-exporting so that the declared MSRV can be met
+
 ## [0.0.5](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-tui-ratatui-v0.0.4...ac-qu-ai-nt-tui-ratatui-v0.0.5) - 2024-10-07
 
 ### Other

tui-ratatui/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt-tui-ratatui"
 description = "A TUI (written with Ratatui) for ac-qu-ai-nt"
-version = "0.0.5"
+version = "0.0.6"
 edition = "2021"
 rust-version = "1.76"