fix: help system integration, build process optimization, and plugin rebuild efficiency ## Detailed Description This commit addresses critical issues in the help system discoverability, build process robustness, and plugin rebuild efficiency. ### 1. Help System Integration (New Feature) **Issue**: Version-update module recipes were not discoverable - Not shown in `just help modules` - Not referenced in `just help` - Not included in help navigation system - Users had to manually run `just --list` to find update commands **Solution**: - Added version-update module to all help outputs - Updated `justfiles/help.just` to document all 30+ version-update recipes - Created new `just commands` recipe as discoverable alias for `just --list` - Integrated version-update into help-all workflow **Impact**: - Version-update commands now fully discoverable via help system - Users can find update commands with: `just help modules`, `just help`, `just commands` - Improved overall help system navigation **Files Modified**: - `justfiles/help.just` (+23 lines) - Added version-update module to help sections - Added to modules list - Added to help-all workflow - New `commands` recipe showing all recipes by group ### 2. Build Process Fixes (Phase 3: Bin Archives) #### 2a. Plugin Archive Collection Bug **Issue**: "No plugins found to package" warning in Phase 3 - Collected 26 plugin binaries but reported 0 - Archive creation skipped because count was wrong **Root Cause**: `each` command returns null, so `| length` returned 0 ```nushell # ❌ OLD - each returns null let plugin_count = (ls nu_plugin_*/target/release/nu_plugin_* | each {|p| cp $p.name $"($temp_dir)/" } | length) # Returns 0! ``` **Solution**: Separated counting from copying with proper filtering ```nushell # ✅ NEW - count before operations let plugins_to_copy = (ls nu_plugin_*/target/release/nu_plugin_* | where type == "file") let plugin_count = ($plugins_to_copy | length) ``` **Impact**: - Now correctly collects and reports 26 plugins - Filters out .d dependency files automatically - Warning eliminated #### 2b. Tar Archive Path Handling **Issue**: Tar command failing silently with relative paths in subshell - `cd $temp_dir` changes context unpredictably - Relative path `../$archive_name` fails in subshell - Archive file not created despite exit code 0 **Root Cause**: Shell context and relative path issues in Nushell `do` block **Solution**: Used `tar -C` with absolute paths instead of `cd` ```nushell # ❌ OLD - unreliable context switching do { cd $temp_dir tar -czf ../$archive_name . } # ✅ NEW - absolute paths, no context switching tar -C $temp_dir -czf $archive_path . ``` **Additional Improvements**: - Absolute path construction using `pwd | path join` - Better error diagnostics with exit code and stderr output - File verification after creation **Impact**: - Tar archives now created successfully - Robust path handling across platforms - Clear error messages for debugging #### 2c. File Size Calculation Type Error **Issue**: Runtime error when calculating archive size ``` Error: The '/' operator does not work on values of type 'list<filesize>' ``` **Root Cause**: `ls` returns list of records, so `.size` was a list ```nushell # ❌ OLD - returns list<filesize> (ls $archive_path).size / 1024 / 1024 # ✅ NEW - returns filesize (ls $archive_path | get 0.size) / 1024 / 1024 ``` **Impact**: - Proper file size calculation in MB - No more type errors **Files Modified**: - `scripts/create_full_distribution.nu` (+58 lines, refactored plugin collection) - Fixed plugin counting logic - Improved path handling with absolute paths - Enhanced error diagnostics ### 3. Plugin Rebuild Optimization **Issue**: All plugins marked for rebuild even when dependencies unchanged - Step 4 (`update_all_plugins.nu`) touched all Cargo.toml files at 01:00:32 - Step 5 saw all files as "newer" than binaries - Marked ALL plugins for rebuild, though cargo only rebuilt changed ones **Root Cause**: Script always saved files, even when no changes made ```nushell # ❌ OLD - always saves, touching file timestamp $updated_content | to toml | save -f $cargo_toml ``` **Solution**: Only save if content actually changed ```nushell # ✅ NEW - compare before writing let original_toml = $content | to toml let new_toml = $updated_content | to toml if $original_toml != $new_toml { $updated_content | to toml | save -f $cargo_toml } ``` **Impact**: - Unchanged files preserve original timestamps - Only plugins with actual dependency changes are rebuilt - Efficient rebuild process with accurate file modification detection **Files Modified**: - `scripts/update_all_plugins.nu` (+12 lines, added content comparison) - Only touches files with real changes - Preserves timestamps for efficiency - Clearer logic and comments ### 4. Documentation **Files Modified**: - `CHANGELOG.md` (+56 lines) - Added comprehensive 2025-10-19 entry - Documented all fixes with root causes - Listed files modified and impact summary ## Technical Details ### Nushell Patterns Used 1. **Proper List Handling**: - `ls` returns list of records, access with `| get 0.size` - Filter with `where type == "file"` to exclude metadata 2. **Absolute Path Construction**: - `pwd | append "path" | path join` for cross-platform paths - Safer than string concatenation with `/` 3. **Content Comparison**: - Compare TOML string representation before saving - Preserves file timestamps for efficiency 4. **Error Diagnostics**: - Capture `stderr` from commands - Report exit codes and error messages separately ## Testing - [x] Help system shows version-update module - [x] `just commands` displays all recipes by group - [x] Phase 3 bin archive creation works - [x] Plugin collection reports correct count (26) - [x] Tar archives created successfully - [x] File size calculated correctly - [x] Plugin rebuild only touches changed files - [x] CHANGELOG updated with all changes ## Files Changed ``` 38 files changed, 2721 insertions(+), 2548 deletions(-) Core Changes: - justfiles/help.just (+23) Help system integration - scripts/create_full_distribution.nu (+58) Build process fixes - scripts/update_all_plugins.nu (+12) Rebuild optimization - CHANGELOG.md (+56) Documentation Dependency Updates: - All plugin Cargo.toml and Cargo.lock files (version consistency) ``` ## Breaking Changes None. These are bug fixes and optimizations that maintain backward compatibility. ## Migration Notes No migration needed. Improvements are transparent to users. ## Related Issues - Help system discoverability - Build process Phase 3 failures - Unnecessary plugin rebuilds - Build process reliability ## Checklist - [x] Changes follow Rust/Nushell idioms - [x] Code is well-commented - [x] Error handling is comprehensive - [x] Documentation is updated - [x] All changes tested - [x] No breaking changes introduced
224 lines
6.2 KiB
Bash
Executable File
224 lines
6.2 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Universal Nushell Script Runner
|
|
# Auto-detects nushell, checks version consistency, and runs nu scripts
|
|
|
|
# Colors for output
|
|
RED='\033[0;31m'
|
|
GREEN='\033[0;32m'
|
|
YELLOW='\033[1;33m'
|
|
BLUE='\033[0;34m'
|
|
CYAN='\033[0;36m'
|
|
NC='\033[0m' # No Color
|
|
|
|
# Get script directory and repository root
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
|
|
cd "$REPO_ROOT"
|
|
|
|
# Function to show usage
|
|
show_usage() {
|
|
echo -e "${BLUE}Universal Nushell Script Runner${NC}"
|
|
echo ""
|
|
echo "Usage: $0 [OPTIONS] SCRIPT [SCRIPT_ARGS...]"
|
|
echo ""
|
|
echo "Options:"
|
|
echo -e " ${GREEN}--check-only${NC} Only check version, don't run script"
|
|
echo -e " ${GREEN}--fix${NC} Auto-fix version mismatches"
|
|
echo -e " ${GREEN}--no-version-check${NC} Skip version checking (not recommended)"
|
|
echo -e " ${GREEN}--help, -h${NC} Show this help message"
|
|
echo ""
|
|
echo "Examples:"
|
|
echo " $0 plugin_status.nu # Run plugin status with version check"
|
|
echo " $0 --fix build_all.nu # Fix version issues then build"
|
|
echo " $0 --check-only # Only check version consistency"
|
|
echo ""
|
|
}
|
|
|
|
# Function to check if nushell is installed
|
|
check_nushell_installed() {
|
|
if ! command -v nu &> /dev/null; then
|
|
echo -e "${RED}❌ Nushell (nu) is not installed or not in PATH${NC}"
|
|
echo -e "${YELLOW}🔧 Installing nushell from submodule...${NC}"
|
|
|
|
if [[ -f "scripts/sh/update_nushell.sh" ]]; then
|
|
if bash scripts/sh/update_nushell.sh update; then
|
|
echo -e "${GREEN}✅ Nushell installed successfully${NC}"
|
|
return 0
|
|
else
|
|
echo -e "${RED}❌ Failed to install nushell${NC}"
|
|
echo "Please install manually: https://www.nushell.sh/book/installation.html"
|
|
return 1
|
|
fi
|
|
else
|
|
echo -e "${RED}❌ update_nushell.sh not found${NC}"
|
|
echo "Please install nushell manually: https://www.nushell.sh/book/installation.html"
|
|
return 1
|
|
fi
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
# Function to check version consistency
|
|
check_version_consistency() {
|
|
local fix_flag="$1"
|
|
|
|
echo -e "${CYAN}🔍 Checking nushell version consistency...${NC}"
|
|
|
|
if [[ -f "scripts/check_version.nu" ]]; then
|
|
local check_args=""
|
|
if [[ "$fix_flag" == "true" ]]; then
|
|
check_args="--fix"
|
|
fi
|
|
|
|
# Try project binary first (more reliable), fall back to system nu
|
|
local nu_bin="nu"
|
|
if [[ -f "nushell/target/release/nu" ]]; then
|
|
nu_bin="nushell/target/release/nu"
|
|
fi
|
|
|
|
if $nu_bin scripts/check_version.nu $check_args >/dev/null 2>&1; then
|
|
echo -e "${GREEN}✅ Version check passed${NC}"
|
|
return 0
|
|
else
|
|
echo -e "${RED}❌ Version check failed${NC}"
|
|
if [[ "$fix_flag" != "true" ]]; then
|
|
echo -e "${YELLOW}💡 Run with --fix to automatically resolve version issues${NC}"
|
|
fi
|
|
return 1
|
|
fi
|
|
else
|
|
echo -e "${YELLOW}⚠️ Version checker not found, skipping version check${NC}"
|
|
return 0
|
|
fi
|
|
}
|
|
|
|
# Function to run nushell script
|
|
run_script() {
|
|
local script_name="$1"
|
|
shift
|
|
local script_args="$@"
|
|
|
|
# Try different possible paths for the script
|
|
local script_paths=(
|
|
"scripts/$script_name"
|
|
"scripts/nu/$script_name"
|
|
"$script_name"
|
|
)
|
|
|
|
local script_path=""
|
|
for path in "${script_paths[@]}"; do
|
|
if [[ -f "$path" ]]; then
|
|
script_path="$path"
|
|
break
|
|
fi
|
|
done
|
|
|
|
if [[ -z "$script_path" ]]; then
|
|
echo -e "${RED}❌ Script not found: $script_name${NC}"
|
|
echo "Searched in:"
|
|
for path in "${script_paths[@]}"; do
|
|
echo " - $path"
|
|
done
|
|
return 1
|
|
fi
|
|
|
|
# Determine which nu binary to use (project first, then system)
|
|
local nu_bin="nu"
|
|
if [[ -f "nushell/target/release/nu" ]]; then
|
|
nu_bin="nushell/target/release/nu"
|
|
fi
|
|
|
|
echo -e "${BLUE}🚀 Running: $nu_bin $script_path $script_args${NC}"
|
|
echo ""
|
|
|
|
# Execute the nushell script
|
|
if $nu_bin "$script_path" $script_args; then
|
|
echo ""
|
|
echo -e "${GREEN}✅ Script completed successfully${NC}"
|
|
return 0
|
|
else
|
|
echo ""
|
|
echo -e "${RED}❌ Script failed${NC}"
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
# Parse command line arguments
|
|
FIX_VERSION=false
|
|
SKIP_VERSION_CHECK=false
|
|
CHECK_ONLY=false
|
|
SCRIPT_NAME=""
|
|
SCRIPT_ARGS=()
|
|
|
|
while [[ $# -gt 0 ]]; do
|
|
case $1 in
|
|
--check-only)
|
|
CHECK_ONLY=true
|
|
shift
|
|
;;
|
|
--fix)
|
|
FIX_VERSION=true
|
|
shift
|
|
;;
|
|
--no-version-check)
|
|
SKIP_VERSION_CHECK=true
|
|
shift
|
|
;;
|
|
-h|--help)
|
|
show_usage
|
|
exit 0
|
|
;;
|
|
-*)
|
|
echo -e "${RED}❌ Unknown option: $1${NC}"
|
|
echo ""
|
|
show_usage
|
|
exit 1
|
|
;;
|
|
*)
|
|
SCRIPT_NAME="$1"
|
|
shift
|
|
SCRIPT_ARGS=("$@")
|
|
break
|
|
;;
|
|
esac
|
|
done
|
|
|
|
# Main execution flow
|
|
|
|
# 1. Check if nushell is installed
|
|
if ! check_nushell_installed; then
|
|
exit 1
|
|
fi
|
|
|
|
# 2. Check version consistency (unless explicitly skipped)
|
|
if [[ "$SKIP_VERSION_CHECK" != "true" ]]; then
|
|
if ! check_version_consistency "$FIX_VERSION"; then
|
|
echo ""
|
|
echo -e "${RED}❌ Version check failed. Please fix version issues before continuing.${NC}"
|
|
echo -e "${YELLOW}💡 Use --fix flag to automatically resolve version issues${NC}"
|
|
echo -e "${YELLOW}💡 Or use --no-version-check to skip (not recommended)${NC}"
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# 3. If check-only mode, exit after version check
|
|
if [[ "$CHECK_ONLY" == "true" ]]; then
|
|
echo -e "${GREEN}✅ Version check completed${NC}"
|
|
exit 0
|
|
fi
|
|
|
|
# 4. Ensure script name is provided
|
|
if [[ -z "$SCRIPT_NAME" ]]; then
|
|
echo -e "${RED}❌ No script specified${NC}"
|
|
echo ""
|
|
show_usage
|
|
exit 1
|
|
fi
|
|
|
|
# 5. Run the requested script
|
|
if run_script "$SCRIPT_NAME" "${SCRIPT_ARGS[@]}"; then
|
|
exit 0
|
|
else
|
|
exit 1
|
|
fi |