arckit-cli 6.1.1__py3-none-any.whl

arckit_cli-6.1.1.data/data/share/arckit/scripts/bash/common.sh

@@ -0,0 +1,359 @@
+#!/usr/bin/env bash
+# Common utilities for ArcKit scripts
+
+set -euo pipefail
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Logging functions
+log_info() {
+    echo -e "${BLUE}[INFO]${NC} $1" >&2
+}
+
+log_success() {
+    echo -e "${GREEN}[SUCCESS]${NC} $1" >&2
+}
+
+log_warning() {
+    echo -e "${YELLOW}[WARNING]${NC} $1" >&2
+}
+
+log_error() {
+    echo -e "${RED}[ERROR]${NC} $1" >&2
+}
+
+# Find the repository root
+find_repo_root() {
+    local current_dir="$PWD"
+    while [[ "$current_dir" != "/" ]]; do
+        if [[ -d "$current_dir/.arckit" ]]; then
+            echo "$current_dir"
+            return 0
+        fi
+        current_dir="$(dirname "$current_dir")"
+    done
+    log_error "Not in an ArcKit project (no .arckit directory found)"
+    exit 1
+}
+
+# Get the next project number
+get_next_project_number() {
+    local repo_root="$1"
+    local projects_dir="$repo_root/projects"
+
+    if [[ ! -d "$projects_dir" ]]; then
+        echo "001"
+        return 0
+    fi
+
+    local max_num=0
+    for dir in "$projects_dir"/*; do
+        if [[ -d "$dir" ]]; then
+            local basename="$(basename "$dir")"
+            if [[ "$basename" =~ ^([0-9]{3})- ]]; then
+                local num="${BASH_REMATCH[1]}"
+                if ((num > max_num)); then
+                    max_num=$num
+                fi
+            fi
+        fi
+    done
+
+    printf "%03d" $((max_num + 1))
+}
+
+# Create project directory structure
+create_project_dir() {
+    local project_dir="$1"
+
+    mkdir -p "$project_dir"
+    mkdir -p "$project_dir/vendors"
+    mkdir -p "$project_dir/external"
+    mkdir -p "$project_dir/final"
+    mkdir -p "$project_dir/decisions"
+    mkdir -p "$project_dir/diagrams"
+    mkdir -p "$project_dir/wardley-maps"
+    mkdir -p "$project_dir/data-contracts"
+    mkdir -p "$project_dir/reviews"
+
+    log_success "Created project directory: $project_dir"
+}
+
+# Output JSON for consumption by AI agents
+output_json() {
+    local project_dir="$1"
+    local project_number="$2"
+    local project_name="$3"
+
+    cat <<EOF
+{
+  "project_dir": "$project_dir",
+  "project_number": "$project_number",
+  "project_name": "$project_name",
+  "requirements_file": "$project_dir/requirements.md",
+  "sow_file": "$project_dir/sow.md",
+  "evaluation_file": "$project_dir/evaluation-criteria.md",
+  "vendors_dir": "$project_dir/vendors",
+  "traceability_file": "$project_dir/traceability-matrix.md"
+}
+EOF
+}
+
+# Check if git is available
+check_git() {
+    if ! command -v git &> /dev/null; then
+        log_warning "Git not found - some features may not work"
+        return 1
+    fi
+    return 0
+}
+
+# Slugify a string (convert to kebab-case, preserving accented characters)
+slugify() {
+    local lower="${1,,}"
+    echo "$lower" | sed 's/[^[:alnum:]]\+/-/g' | sed 's/^-\|-$//g'
+}
+
+# ============================================================================
+# Git Integration Functions
+# ============================================================================
+
+# Check if git is available (enhanced version)
+has_git() {
+    command -v git >/dev/null 2>&1
+}
+
+# Get current git branch
+get_current_branch() {
+    if has_git && git rev-parse --git-dir > /dev/null 2>&1; then
+        git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "main"
+    else
+        echo "main"
+    fi
+}
+
+# Check if working directory is clean
+check_git_clean() {
+    if ! has_git; then
+        return 0  # If no git, consider it "clean"
+    fi
+
+    if ! git diff-index --quiet HEAD -- 2>/dev/null; then
+        log_warning "You have uncommitted changes"
+        return 1
+    fi
+    return 0
+}
+
+# Get repository root using git (fallback to .arckit search)
+get_repo_root() {
+    if has_git && git rev-parse --git-dir > /dev/null 2>&1; then
+        git rev-parse --show-toplevel 2>/dev/null
+    else
+        find_repo_root
+    fi
+}
+
+# ============================================================================
+# Project Finding and Management
+# ============================================================================
+
+# Find project directory by number or prefix
+find_project_dir_by_prefix() {
+    local prefix="$1"
+    local repo_root="${2:-$(find_repo_root)}"
+    local projects_dir="$repo_root/projects"
+
+    if [[ ! -d "$projects_dir" ]]; then
+        log_error "No projects directory found"
+        return 1
+    fi
+
+    # Exact match first (e.g., "001")
+    for dir in "$projects_dir"/*; do
+        if [[ -d "$dir" ]]; then
+            local basename=$(basename "$dir")
+            # Check if matches exactly at start (001, 001-payment)
+            if [[ "$basename" == "$prefix" ]] || [[ "$basename" == "$prefix-"* ]]; then
+                echo "$dir"
+                return 0
+            fi
+        fi
+    done
+
+    # Fuzzy match (e.g., "payment" matches "001-payment-gateway")
+    for dir in "$projects_dir"/*; do
+        if [[ -d "$dir" ]]; then
+            local basename=$(basename "$dir")
+            if [[ "$basename" == *"$prefix"* ]]; then
+                echo "$dir"
+                return 0
+            fi
+        fi
+    done
+
+    log_error "No project found matching: $prefix"
+    return 1
+}
+
+# List all projects
+list_projects() {
+    local repo_root="${1:-$(find_repo_root)}"
+    local projects_dir="$repo_root/projects"
+
+    if [[ ! -d "$projects_dir" ]] || [[ -z $(ls -A "$projects_dir" 2>/dev/null) ]]; then
+        echo "No projects found"
+        return 0
+    fi
+
+    echo "Available projects:"
+    for dir in "$projects_dir"/*; do
+        if [[ -d "$dir" ]]; then
+            local basename=$(basename "$dir")
+            echo "  - $basename"
+        fi
+    done
+}
+
+# Get project number from directory name
+get_project_number_from_dir() {
+    local dir="$1"
+    local basename=$(basename "$dir")
+
+    if [[ "$basename" =~ ^([0-9]{3})- ]]; then
+        echo "${BASH_REMATCH[1]}"
+        return 0
+    fi
+
+    return 1
+}
+
+# ============================================================================
+# Validation Helper Functions
+# ============================================================================
+
+# Check if file exists and print status
+check_file() {
+    local file="$1"
+    local description="${2:-$(basename "$file")}"
+
+    if [[ -f "$file" ]]; then
+        echo "  ✓ $description"
+        return 0
+    else
+        echo "  ✗ $description"
+        return 1
+    fi
+}
+
+# Check if directory exists and is not empty
+check_dir() {
+    local dir="$1"
+    local description="${2:-$(basename "$dir")}"
+
+    if [[ -d "$dir" && -n $(ls -A "$dir" 2>/dev/null) ]]; then
+        echo "  ✓ $description"
+        return 0
+    else
+        echo "  ✗ $description"
+        return 1
+    fi
+}
+
+# Require file to exist (exit with error if not)
+require_file() {
+    local file="$1"
+    local description="${2:-$(basename "$file")}"
+
+    if [[ ! -f "$file" ]]; then
+        log_error "Required file not found: $description"
+        log_error "  Path: $file"
+        return 1
+    fi
+
+    log_success "Found: $description"
+    return 0
+}
+
+# Require directory to exist
+require_dir() {
+    local dir="$1"
+    local description="${2:-$(basename "$dir")}"
+
+    if [[ ! -d "$dir" ]]; then
+        log_error "Required directory not found: $description"
+        log_error "  Path: $dir"
+        return 1
+    fi
+
+    log_success "Found: $description"
+    return 0
+}
+
+# ============================================================================
+# JSON Helper Functions
+# ============================================================================
+
+# Escape string for JSON
+json_escape() {
+    local string="$1"
+    # Escape backslashes, quotes, and newlines
+    echo "$string" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed ':a;N;$!ba;s/\n/\\n/g'
+}
+
+# Output JSON array from bash array
+output_json_array() {
+    local items=("$@")
+    local json="["
+    local first=true
+
+    for item in "${items[@]}"; do
+        if [[ "$first" == "true" ]]; then
+            first=false
+        else
+            json="$json,"
+        fi
+        json="$json\"$(json_escape "$item")\""
+    done
+
+    json="$json]"
+    echo "$json"
+}
+
+# Check if running in JSON mode (common pattern)
+is_json_mode() {
+    [[ "${JSON_MODE:-false}" == "true" ]]
+}
+
+# ============================================================================
+# Path Helper Functions
+# ============================================================================
+
+# Get .arckit directory path
+get_arckit_dir() {
+    local repo_root="${1:-$(find_repo_root)}"
+    echo "$repo_root/.arckit"
+}
+
+# Get projects directory path
+get_projects_dir() {
+    local repo_root="${1:-$(find_repo_root)}"
+    echo "$repo_root/projects"
+}
+
+# Get memory directory path
+get_memory_dir() {
+    local repo_root="${1:-$(find_repo_root)}"
+    echo "$repo_root/projects/000-global"
+}
+
+# Get templates directory path
+get_templates_dir() {
+    local repo_root="${1:-$(find_repo_root)}"
+    echo "$repo_root/.arckit/templates"
+}