core xtask functionality

Author: adamperkowski

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+xtask = "run --package xtask --"

.github/workflows/xtask.yml

@@ -0,0 +1,56 @@
+name: XTasks
+
+on:
+  pull_request:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+  push:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  docgen:
+    name: DocGen
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-registry-
+
+      - name: Cache Cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-index-
+
+      - name: Run cargo xtask docgen
+        run: cargo xtask docgen
+
+      - name: Check uncommitted documentation changes
+        run: |
+          git diff
+          git diff-files --quiet \
+            || (echo "Run 'cargo xtask docgen' and push the changes" \
+            && exit 1)

Cargo.lock

@@ -1,12 +1,13 @@
 [workspace.package]
 license = "MIT"
 version = "24.9.28"
+edition = "2021"
 
 [workspace.dependencies]
 ego-tree = "0.6.2"
 
 [workspace]
-members = ["tui", "core"]
+members = ["tui", "core", "xtask"]
 resolver = "2"
 
 [patch.crates-io]

Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "xtask"
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+
+[dependencies]
+linutil_core = { path = "../core" }

xtask/Cargo.toml

@@ -0,0 +1,17 @@
+use crate::DynError;
+use linutil_core::{ListNode, Tab};
+
+pub fn ttest() {
+    let ok = linutil_core::get_tabs(false).1;
+
+    for tab in ok {
+        #[cfg(debug_assertions)]
+        println!("Tab: {}", tab.name);
+
+        for entry in tab.tree {
+            #[cfg(debug_assertions)]
+            println!("  Entry: {}", entry.name);
+            println!("    Description: {}", entry.description);
+        }
+    }
+}

xtask/src/docgen.rs

@@ -0,0 +1,37 @@
+mod docgen;
+
+use std::{env, error::Error};
+
+type DynError = Box<dyn Error>;
+
+pub mod tasks {
+    use crate::{docgen::ttest, DynError};
+
+    pub fn docgen() -> Result<(), DynError> {
+        ttest();
+        Ok(())
+    }
+
+    pub fn print_help() {
+        println!(
+            "
+Usage: `cargo xtask <task>`
+
+    Tasks:
+        docgen: Generate Markdown files.
+"
+        );
+    }
+}
+
+fn main() -> Result<(), DynError> {
+    let task = env::args().nth(1);
+    match task {
+        None => tasks::print_help(),
+        Some(t) => match t.as_str() {
+            "docgen" => tasks::docgen()?,
+            invalid => return Err(format!("Invalid task: {}", invalid).into()),
+        },
+    };
+    Ok(())
+}