npm - @chongdashu/cc-statusline - Versions diffs - 1.3.0 → 1.3.2 - Mend

@chongdashu/cc-statusline 1.3.0 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/CHANGELOG.md +157 -127
package/CLAUDE.md +76 -61
package/CONTRIBUTING.md +207 -207
package/LICENSE +20 -20
package/README.md +373 -310
package/dist/index.js +181 -14
package/dist/index.js.map +1 -1
package/package.json +57 -57
package/test/test-concurrent-locking.sh +54 -54
package/test/test-installation.sh +335 -335
package/test/test-statusline-with-lock.sh +67 -67

package/CHANGELOG.md CHANGED Viewed

@@ -1,128 +1,158 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-## [1.3.0] - 2025-08-28
-### Changed
-- 🔥 **Cost Burn Rate Calculation** - Now calculates burn rate ($/hour) directly from Claude Code's cost and duration data
-  - No longer relies on ccusage for burn rate calculation
-  - Uses `cost.total_cost_usd` and `cost.total_duration_ms` from Claude Code's input
-  - More accurate and reliable burn rate display
-- 📁 **Project-Relative Logging** - Statusline logs are now created relative to where the statusline script is installed
-  - Logs go to `.claude/statusline.log` in the project directory when installed locally
-  - Previously always logged to `~/.claude/statusline.log` regardless of installation location
-### Fixed
-- 🐛 Fixed version drift between CLI and package.json
-- 🐛 Fixed logging directory to respect project-level installations
-### Added
-- ✨ Version number now included in generated statusline headers (e.g., `# Generated by cc-statusline v1.3.0`)
-## [1.2.7] - 2025-08-28
-### Fixed
-- 🐛 **ccusage Integration Fix** - Fixed ccusage stats not displaying in statusline
-  - Moved `input=$(cat)` before logging to ensure proper input capture
-  - Simplified ccusage execution by removing complex locking mechanism
-  - Now properly calls `ccusage blocks --json` directly with internal caching
-  - Fixed cost display, burn rate, token stats, and session time display
-## [1.2.6] - 2025-08-27
-### Fixed
-- 🐛 **Installation Prompt Fix** - Fixed spinner blocking the overwrite confirmation prompt during installation
-  - Removed ora spinner during installation phase to ensure prompts are visible
-  - Replaced spinner with simple console messages for better UX
-  - Users can now properly see and respond to overwrite confirmations
-## [1.2.5] - 2025-08-27
-### Fixed
-- 🐛 **Cost Display Fix** - Fixed incorrect cost values (e.g., $48.00) caused by improper quoting in printf statements
-  - Removed unnecessary escaped quotes around `$cost_usd` in bash generator
-  - Cost values now display correctly with proper decimal formatting
-## [1.2.4] - 2025-08-26
-### Added
-- 🆕 **Installation Location Choice** - Choose between global (`~/.claude`) or project-level (`./.claude`) installation
-- 🔒 **Safe Installation** - Confirmation prompts before overwriting existing statusline.sh files
-- 🛡️ **Settings Protection** - Smart settings.json updates that preserve existing configurations
-- ⚠️ **Conflict Detection** - Warns when other statuslines are already configured
-- ✅ **Better Error Handling** - Clear messages for cancelled installations and conflicts
-### Changed
-- Installation prompt now includes location selection (global vs project)
-- Default installation is project-level for safety
-- Improved settings.json update logic to prevent accidental overwrites
-## [1.2.3] - 2025-08-20
-### Fixed
-- 🔒 **Critical Process Spawning Fix** - Added file-based locking mechanism to prevent infinite ccusage process spawning
-- ⚡ **Performance** - Implemented 3-second timeout for ccusage calls to prevent hanging
-- 🛡️ **Stability** - Added PID tracking for stale lock detection and cleanup
-- 🔧 **Cross-platform** - Multiple timeout strategies for Linux, macOS, and BSD compatibility
-### Contributors
-- 🙏 **Special thanks to [Jonathan Borgwing (@DevVig)](https://github.com/DevVig)** for identifying and implementing the critical process spawning fix ([#4](https://github.com/chongdashu/cc-statusline/pull/4))
-### Technical Details
-- **File-based locking**: Uses `/tmp/ccusage_statusline.lock` directory as a mutex to ensure single execution
-- **PID tracking**: Stores process ID in `/tmp/ccusage_statusline.pid` for stale lock detection
-- **Graceful degradation**: Skips execution when locked instead of queuing (prevents pile-up)
-- **Automatic cleanup**: Detects and removes stale locks from crashed processes using `kill -0`
-- **Cross-platform timeouts**: Multiple timeout strategies (timeout/gtimeout/fallback) for all systems
-- **Testing included**: Comprehensive test suite in `test/` directory to verify locking behavior
-## [1.0.1] - 2025-08-13
-### Added
-- CONTRIBUTING.md with comprehensive contribution guidelines
-- Development workflow documentation
-- Code standards and testing guidelines
-### Changed
-- Updated package name to unscoped `cc-statusline`
-- Enhanced README contributing section with better guidance
-## [1.0.0] - 2025-08-13
-### Added
-- Initial release of cc-statusline
-- Interactive configuration wizard with 2 simple prompts
-- Bash script generation with optimized performance
-- Real-time ccusage integration for usage statistics
-- Preview mode for testing statusline scripts with mock data
-- Auto-installation with settings.json configuration
-- Support for directory, git, model, usage, session, token, and burn rate features
-- TTY-aware color support with NO_COLOR environment variable respect
-- Manual configuration instructions when auto-update fails
-- Comprehensive documentation and examples
-- Performance analysis and validation in preview mode
-- Timestamp and npm URL in generated script headers
-### Features
-- 📁 Working Directory display with `~` abbreviation
-- 🌿 Git Branch integration
-- 🤖 Model Name & Version display
-- 💵 Real-time Usage & Cost tracking
-- ⌛ Session Time Remaining with progress bars
-- 📊 Token Statistics (optional)
-- ⚡ Burn Rate monitoring (optional)
-### Technical
-- TypeScript with strict type checking
-- ESM module support
-- Commander.js for CLI interface
-- Inquirer.js for interactive prompts
-- Chalk for colorized output
-- Ora for loading spinners
-- Comprehensive error handling and validation
-- Modular architecture for easy maintenance
+# Changelog
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [1.3.2] - 2025-08-28
+### Fixed
+- 🪟 **Windows Bash Compatibility** - Fixed JSON extraction in bash fallback mode for Windows Git Bash/MinGW
+  - Improved nested JSON field extraction for `workspace.current_dir` and `model.display_name`
+  - Added Windows path conversion from backslashes to forward slashes
+  - Fixed cost data extraction without jq
+  - Generator now uses `bash .claude/statusline.sh` command in settings.json for Windows
+## [1.3.1] - 2025-08-28
+### Fixed
+- 🐛 **Critical: Bash JSON Fallback Parser** - Fixed syntax error in fallback JSON parser for systems without jq
+  - Fixed malformed grep patterns with incorrect quote escaping in `bash-generator.ts`
+  - Statusline now works correctly on systems without jq installed
+  - Properly escapes quotes in generated bash script (`\"${field}\"` instead of `"${field}"`)
+### Added
+- ✨ **jq Detection and Installation Guide** - Added automatic jq detection during init
+  - Checks if jq is installed and warns about limited functionality without it
+  - Provides platform-specific installation instructions (macOS, Linux, Windows)
+  - Asks users if they want to continue without jq
+  - Clear documentation in README about which features require jq
+### Changed
+- 📚 **Enhanced Windows Documentation** - Clarified jq installation for Windows users
+  - Specific file names for download (`jq-windows-amd64.exe` for 64-bit)
+  - Step-by-step PATH configuration instructions
+  - Clear options between package managers and manual installation
+## [1.3.0] - 2025-08-28
+### Changed
+- 🔥 **Cost Burn Rate Calculation** - Now calculates burn rate ($/hour) directly from Claude Code's cost and duration data
+  - No longer relies on ccusage for burn rate calculation
+  - Uses `cost.total_cost_usd` and `cost.total_duration_ms` from Claude Code's input
+  - More accurate and reliable burn rate display
+- 📁 **Project-Relative Logging** - Statusline logs are now created relative to where the statusline script is installed
+  - Logs go to `.claude/statusline.log` in the project directory when installed locally
+  - Previously always logged to `~/.claude/statusline.log` regardless of installation location
+### Fixed
+- 🐛 Fixed version drift between CLI and package.json
+- 🐛 Fixed logging directory to respect project-level installations
+### Added
+- ✨ Version number now included in generated statusline headers (e.g., `# Generated by cc-statusline v1.3.0`)
+## [1.2.7] - 2025-08-28
+### Fixed
+- 🐛 **ccusage Integration Fix** - Fixed ccusage stats not displaying in statusline
+  - Moved `input=$(cat)` before logging to ensure proper input capture
+  - Simplified ccusage execution by removing complex locking mechanism
+  - Now properly calls `ccusage blocks --json` directly with internal caching
+  - Fixed cost display, burn rate, token stats, and session time display
+## [1.2.6] - 2025-08-27
+### Fixed
+- 🐛 **Installation Prompt Fix** - Fixed spinner blocking the overwrite confirmation prompt during installation
+  - Removed ora spinner during installation phase to ensure prompts are visible
+  - Replaced spinner with simple console messages for better UX
+  - Users can now properly see and respond to overwrite confirmations
+## [1.2.5] - 2025-08-27
+### Fixed
+- 🐛 **Cost Display Fix** - Fixed incorrect cost values (e.g., $48.00) caused by improper quoting in printf statements
+  - Removed unnecessary escaped quotes around `$cost_usd` in bash generator
+  - Cost values now display correctly with proper decimal formatting
+## [1.2.4] - 2025-08-26
+### Added
+- 🆕 **Installation Location Choice** - Choose between global (`~/.claude`) or project-level (`./.claude`) installation
+- 🔒 **Safe Installation** - Confirmation prompts before overwriting existing statusline.sh files
+- 🛡️ **Settings Protection** - Smart settings.json updates that preserve existing configurations
+- ⚠️ **Conflict Detection** - Warns when other statuslines are already configured
+- ✅ **Better Error Handling** - Clear messages for cancelled installations and conflicts
+### Changed
+- Installation prompt now includes location selection (global vs project)
+- Default installation is project-level for safety
+- Improved settings.json update logic to prevent accidental overwrites
+## [1.2.3] - 2025-08-20
+### Fixed
+- 🔒 **Critical Process Spawning Fix** - Added file-based locking mechanism to prevent infinite ccusage process spawning
+- ⚡ **Performance** - Implemented 3-second timeout for ccusage calls to prevent hanging
+- 🛡️ **Stability** - Added PID tracking for stale lock detection and cleanup
+- 🔧 **Cross-platform** - Multiple timeout strategies for Linux, macOS, and BSD compatibility
+### Contributors
+- 🙏 **Special thanks to [Jonathan Borgwing (@DevVig)](https://github.com/DevVig)** for identifying and implementing the critical process spawning fix ([#4](https://github.com/chongdashu/cc-statusline/pull/4))
+### Technical Details
+- **File-based locking**: Uses `/tmp/ccusage_statusline.lock` directory as a mutex to ensure single execution
+- **PID tracking**: Stores process ID in `/tmp/ccusage_statusline.pid` for stale lock detection
+- **Graceful degradation**: Skips execution when locked instead of queuing (prevents pile-up)
+- **Automatic cleanup**: Detects and removes stale locks from crashed processes using `kill -0`
+- **Cross-platform timeouts**: Multiple timeout strategies (timeout/gtimeout/fallback) for all systems
+- **Testing included**: Comprehensive test suite in `test/` directory to verify locking behavior
+## [1.0.1] - 2025-08-13
+### Added
+- CONTRIBUTING.md with comprehensive contribution guidelines
+- Development workflow documentation
+- Code standards and testing guidelines
+### Changed
+- Updated package name to unscoped `cc-statusline`
+- Enhanced README contributing section with better guidance
+## [1.0.0] - 2025-08-13
+### Added
+- Initial release of cc-statusline
+- Interactive configuration wizard with 2 simple prompts
+- Bash script generation with optimized performance
+- Real-time ccusage integration for usage statistics
+- Preview mode for testing statusline scripts with mock data
+- Auto-installation with settings.json configuration
+- Support for directory, git, model, usage, session, token, and burn rate features
+- TTY-aware color support with NO_COLOR environment variable respect
+- Manual configuration instructions when auto-update fails
+- Comprehensive documentation and examples
+- Performance analysis and validation in preview mode
+- Timestamp and npm URL in generated script headers
+### Features
+- 📁 Working Directory display with `~` abbreviation
+- 🌿 Git Branch integration
+- 🤖 Model Name & Version display
+- 💵 Real-time Usage & Cost tracking
+- ⌛ Session Time Remaining with progress bars
+- 📊 Token Statistics (optional)
+- ⚡ Burn Rate monitoring (optional)
+### Technical
+- TypeScript with strict type checking
+- ESM module support
+- Commander.js for CLI interface
+- Inquirer.js for interactive prompts
+- Chalk for colorized output
+- Ora for loading spinners
+- Comprehensive error handling and validation
+- Modular architecture for easy maintenance
 [1.0.0]: https://github.com/chongdashu/cc-statusline/releases/tag/v1.0.0

package/CLAUDE.md CHANGED Viewed

@@ -1,62 +1,77 @@
-# CLAUDE.md
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-## Project Overview
-cc-statusline is a TypeScript CLI tool that generates custom statuslines for Claude Code. It creates optimized bash scripts that display directory, git info, model name, usage costs, and session time in the terminal.
-## Development Commands
-```bash
-# Install dependencies
-npm install
-# Build the project (required before testing)
-npm run build
-# Watch mode for development
-npm run dev
-# Test the CLI locally
-./dist/index.js init --no-install
-./dist/index.js preview ./test-statusline.sh
-# Test as if installed globally
-npx . init
-```
-## Architecture
-The codebase follows a modular ESM TypeScript architecture:
-- **CLI Layer** (`src/cli/`): Commander.js-based CLI with interactive prompts using Inquirer
-- **Generator Layer** (`src/generators/`): Creates optimized bash scripts based on user configuration
-- **Feature Modules** (`src/features/`): Isolated implementations for git, usage tracking, and colors
-- **Utility Layer** (`src/utils/`): Installation, validation, and testing utilities
-Key design patterns:
-- Feature flags determine which bash code blocks are included in generated scripts
-- All bash generation is template-based with conditional sections
-- Mock testing simulates Claude Code's JSON input for preview functionality
-## Key Implementation Details
-**Build System**: Uses tsup for ESM bundling with Node 16+ target. The `#!/usr/bin/env node` shebang is automatically added during build.
-**Generated Scripts**: The bash statuslines are self-contained with graceful fallbacks when dependencies (jq, git, ccusage) are missing. Scripts execute in <100ms with minimal resource usage.
-**Installation Flow**:
-1. Collects user preferences via inquirer prompts
-2. Generates optimized bash script with only selected features
-3. Writes to `.claude/statusline.sh` with execute permissions
-4. Updates `.claude/settings.json` to register the statusline command
-**Testing Approach**: Preview command uses mock Claude Code JSON data to test statuslines before installation. Real testing requires manual verification with Claude Code running.
-## Important Conventions
-- Use ESM imports with `.js` extensions (even for `.ts` files)
-- Maintain 2-space indentation without semicolons
-- Follow conventional commits format for commit messages
+# CLAUDE.md
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+## Project Overview
+cc-statusline is a TypeScript CLI tool that generates custom statuslines for Claude Code. It creates optimized bash scripts that display directory, git info, model name, usage costs, and session time in the terminal.
+## Development Commands
+```bash
+# Install dependencies
+npm install
+# Build the project (required before testing)
+npm run build
+# Watch mode for development
+npm run dev
+# Test the CLI locally
+./dist/index.js init --no-install
+./dist/index.js preview ./test-statusline.sh
+# Test as if installed globally
+npx . init
+# Test the generated statusline with mock data
+./test_debug.sh
+# Run installation tests
+./test/test-installation.sh
+```
+## Architecture
+The codebase follows a modular ESM TypeScript architecture:
+- **CLI Layer** (`src/cli/`): Commander.js-based CLI with interactive prompts using Inquirer
+- **Generator Layer** (`src/generators/`): Creates optimized bash scripts based on user configuration
+- **Feature Modules** (`src/features/`): Isolated implementations for git, usage tracking, and colors
+- **Utility Layer** (`src/utils/`): Installation, validation, and testing utilities
+Key design patterns:
+- Feature flags determine which bash code blocks are included in generated scripts
+- All bash generation is template-based with conditional sections
+- Mock testing simulates Claude Code's JSON input for preview functionality
+## Key Implementation Details
+**Build System**: Uses tsup for ESM bundling with Node 16+ target. The `#!/usr/bin/env node` shebang is automatically added during build.
+**Generated Scripts**: The bash statuslines are self-contained with graceful fallbacks when dependencies (jq, git, ccusage) are missing. Scripts execute in <100ms with minimal resource usage.
+**Installation Flow**:
+1. Collects user preferences via inquirer prompts
+2. Generates optimized bash script with only selected features
+3. Writes to `.claude/statusline.sh` with execute permissions
+4. Updates `.claude/settings.json` to register the statusline command
+**Testing Approach**: Preview command uses mock Claude Code JSON data to test statuslines before installation. Real testing requires manual verification with Claude Code running.
+## Critical Bug-Prone Areas
+**JSON Parsing in Bash**: The `bash-generator.ts` file contains a fallback JSON parser for systems without `jq`. This uses complex grep/sed patterns with careful quote escaping. The quotes in the grep patterns must be escaped as `\\"` in the TypeScript template strings to generate valid bash code.
+**Quote Escaping in bash-generator.ts**: Lines 100-105 contain grep patterns that require double escaping:
+- TypeScript template literal needs `\\` for a single backslash
+- Bash needs `\"` for escaped quotes
+- Combined: `\\"\\${field}\\"` to produce `"${field}"` in the final bash script
+## Important Conventions
+- Use ESM imports with `.js` extensions (even for `.ts` files)
+- Maintain 2-space indentation without semicolons
+- Follow conventional commits format for commit messages
 - Generated bash scripts must be POSIX-compliant with fallbacks