StatusBar Quick Actions

A comprehensive VSCode extension that provides highly customizable statusbar buttons for executing user-defined scripts and commands.

Features

🚀 Universal Command Execution

• Package Manager Scripts: Support for npm, yarn, pnpm, and bun
• GitHub CLI Integration: Execute GitHub commands directly from statusbar
• Custom Shell Scripts: Run any shell command with environment variables
• VSCode Commands: Execute built-in VSCode commands
• Auto-Detection: Automatically detect package managers from lock files

🎨 Modern Theme System

• Dark/Light Mode: Automatic theme detection from VSCode
• High Contrast Support: Accessibility-first design
• Custom Color Palettes: Configurable colors for different button states
• StatusBar Integration: Seamless integration with VSCode themes

👁️ Smart Visibility Conditions

• File Type Patterns: Show buttons based on current file type
• Git Repository Status: Conditional display based on repository state
• Workspace Folder Detection: Context-aware button visibility
• File/Directory Existence: Dynamic button configuration

⚡ Enterprise-Grade Features

• Real-time Progress: Visual feedback during command execution
• Error Handling: Comprehensive error management with user-friendly messages
• Command History: Track and analyze command execution patterns
• Timeout Management: Configurable execution timeouts
• Background Execution: Run commands in background with progress indicators

♿ Accessibility Support

• Keyboard Navigation: Full keyboard accessibility
• Screen Reader Compatibility: ARIA labels and descriptions
• High Contrast Mode: Optimized for accessibility needs
• Focus Management: Proper focus order and indicators

Installation

1. From VS Code: Search for "StatusBar Quick Actions" in the Extensions view

   https://marketplace.visualstudio.com/items?itemName=involvex.statusbar-quick-actions

2. From VSIX: Download the extension package and install via code --install-extension

3. Development: Clone the repository and install locally

Quick Start

Basic Configuration

1. Open VS Code Settings (Ctrl+, or Cmd+,)
2. Search for "StatusBar Quick Actions"
3. Configure your first button:

{
  "statusbarQuickActions": {
    "buttons": [
      {
        "id": "npm-dev",
        "text": "$(play) Dev",
        "tooltip": "Start development server",
        "command": {
          "type": "npm",
          "script": "dev"
        },
        "enabled": true,
        "alignment": "left",
        "priority": 100
      }
    ]
  }
}

Sample Configurations

The extension includes comprehensive sample configurations for various project types:

• JavaScript/Node.js: npm scripts, testing, building
• React/TypeScript: Development server, builds, testing
• Python Development: Virtual environments, testing, formatting
• Git Operations: Status, commit, push, pull workflows
• Docker Workflows: Container management and deployment

See SAMPLE-CONFIGURATIONS.md for detailed examples.

Configuration CLI

The extension includes a powerful command-line interface for managing configurations without opening VSCode settings.

Running the CLI

# Using bun (recommended)
bun run dev:cli

# Or directly
bun src/config-cli.ts

CLI Features

The CLI provides an interactive menu with the following options:

1. View Current Configuration

Display all configured buttons with their properties:

• Button ID, text, and command type
• Enabled/disabled status
• Current debug mode setting

2. Apply Preset

Apply pre-built button configurations:

• Node.js Development: npm start, test, build
• Bun Development: bun dev, test, build
• Git Workflow: git status, pull, push

Merge modes:

• Replace all (removes existing buttons)
• Append (adds to existing buttons)
• Merge (replaces buttons with same ID)

3. Add Button

Interactive wizard to create new buttons:

• Supports all command types (npm, yarn, pnpm, bun, shell, vscode, task, detect)
• Auto-generates unique IDs
• Configures text, tooltip, and command

4. Remove Button

Delete buttons from configuration with confirmation.

5. Toggle Debug Mode

Enable or disable debug logging for the extension.

6. Export Configuration

Save current configuration to a JSON file for backup or sharing.

7. Import Configuration

Load configuration from a JSON file with merge or replace options.

8. Apply Label Preset

Add dynamic labels to buttons for real-time information:

Git Presets:

• Git Branch: Show current branch ($(git-branch) main)
• Git Status: Show repository status ($(git-commit) Clean)
• Git Remote URL: Show remote origin URL

Package Presets:

• NPM Package Version: Monitor package versions from npm registry
  • Prompts for package name (e.g., vscode, react)
  • Updates every 5 minutes
  • Shows version like $(package) v1.2.3

System Presets:

• Current Time: Display real-time clock
• Environment Variable: Show any environment variable value

Example workflow:

# 1. Select "Apply Label Preset"
# 2. Choose settings location (user/workspace)
# 3. Select button to modify
# 4. Choose preset (e.g., "Git Branch")
# 5. Label updates automatically in VSCode

9. Configure Performance

Optimize extension performance with these settings:

Visibility Debounce (0-5000ms):

• Delay before checking button visibility conditions
• Lower = more responsive, higher = better performance
• Recommended: 300ms (balanced)

Virtualization:

• Enable for large button lists (10+ buttons)
• Improves rendering performance
• Slight delay on initial load

Result Caching:

• Cache visibility check results
• Reduces redundant computations
• Recommended: enabled

Performance Presets:

1. Balanced (300ms debounce, caching on)

   • Best for most users
   • Good balance of responsiveness and performance

2. Fast (100ms debounce, caching on, virtualization on)

   • For users with many buttons
   • Maximum responsiveness
   • Slightly higher CPU usage

3. Minimal (0ms debounce, caching off)

   • For debugging or testing
   • Instant updates but higher resource usage

10. Reset to Defaults

Remove all buttons and reset settings to defaults (requires confirmation).

11. Help

Display comprehensive help and usage information.

Settings Locations

The CLI allows managing two types of settings:

User Settings (Global):

• Location: %APPDATA%\Code\User\settings.json (Windows)
• Location: ~/Library/Application Support/Code/User/settings.json (macOS)
• Location: ~/.config/Code/User/settings.json (Linux)
• Applies to all VSCode workspaces

Workspace Settings (Project-specific):

• Location: <workspace>/.vscode/settings.json
• Only applies to current project
• Overrides user settings

CLI Examples

Example 1: Quick Setup with Preset

$ bun run dev:cli
# Choose option 2 (Apply Preset)
# Select location: 1 (User settings)
# Select preset: 1 (Node.js Development)
# Select merge mode: 1 (Replace all)
✅ Preset "Node.js Development" applied to user settings

Example 2: Add Dynamic Git Branch Label

$ bun run dev:cli
# Choose option 8 (Apply Label Preset)
# Select location: 2 (Workspace settings)
# Select button: 1 (Your existing button)
# Select preset: 1 (Git Branch)
✅ Label preset "Git Branch" applied to button "My Button"
# Button now shows: $(git-branch) main (updates automatically)

Example 3: Optimize Performance

$ bun run dev:cli
# Choose option 9 (Configure Performance)
# Select location: 1 (User settings)
# Choose option 4 (Apply Performance Preset)
# Select preset: 2 (Fast)
✅ Performance settings updated
# Debounce: 100ms, Caching: Enabled, Virtualization: Enabled

Example 4: Add NPM Version Monitor

$ bun run dev:cli
# Choose option 8 (Apply Label Preset)
# Select button to modify
# Select preset: 4 (NPM Package Version)
# Enter package name: react
✅ Label preset "NPM Package Version" applied
# Button shows: $(package) v18.2.0 (updates every 5 minutes)

Configuration Options

Button Configuration

{
  "id": "unique-button-id",
  "text": "$(icon) Button Text",
  "tooltip": "Tooltip description",
  "command": {
    "type": "npm|yarn|pnpm|bun|shell|github|vscode|detect",
    "script": "package-script-name",
    "command": "shell-command",
    "args": ["arg1", "arg2"]
  },
  "enabled": true,
  "alignment": "left|right",
  "priority": 100,
  "colors": {
    "foreground": "#ffffff",
    "background": "#6c757d"
  },
  "execution": {
    "foreground": true,
    "showProgress": true,
    "timeout": 300000,
    "notifications": {
      "showSuccess": true,
      "showError": true,
      "showOutput": false
    }
  },
  "visibility": {
    "conditions": [
      {
        "type": "fileType|fileExists|gitStatus|workspaceFolder",
        "patterns": ["*.js", "*.ts"],
        "status": "clean|dirty|ahead|behind",
        "folders": ["src", "test"],
        "invert": false
      }
    ]
  },
  "workingDirectory": "${workspaceFolder}",
  "environment": {
    "NODE_ENV": "development",
    "API_URL": "http://localhost:3000"
  }
}

Theme Configuration

{
  "statusbarQuickActions": {
    "theme": {
      "mode": "auto|dark|light|highContrast",
      "dark": {
        "button": { "foreground": "#ffffff", "background": "#6c757d" },
        "executing": { "foreground": "#ffffff", "background": "#007acc" },
        "error": { "foreground": "#ffffff", "background": "#dc3545" }
      },
      "light": {
        /* same structure */
      },
      "highContrast": {
        /* same structure */
      }
    }
  }
}

Notification Configuration

{
  "statusbarQuickActions": {
    "notifications": {
      "showSuccess": true,
      "showError": true,
      "showProgress": true,
      "position": "top-left|top-right|bottom-left|bottom-right",
      "duration": 5000,
      "includeOutput": false
    }
  }
}

Command Types

Package Manager Scripts

{
  "command": {
    "type": "npm",
    "script": "dev"
  }
}

Shell Commands

{
  "command": {
    "type": "shell",
    "command": "echo",
    "args": ["Hello", "World"]
  }
}

GitHub CLI

{
  "command": {
    "type": "github",
    "command": "pr",
    "args": ["create", "--fill"]
  }
}

VSCode Commands

{
  "command": {
    "type": "vscode",
    "command": "editor.action.formatDocument"
  }
}

Auto-Detection

{
  "command": {
    "type": "detect",
    "script": "dev"
  }
}

Visibility Conditions

File Type Patterns

{
  "conditions": [
    {
      "type": "fileType",
      "patterns": ["*.js", "*.ts", "*.jsx", "*.tsx"]
    }
  ]
}

Git Repository Status

{
  "conditions": [
    {
      "type": "gitStatus",
      "status": "dirty"
    }
  ]
}

Workspace Folders

{
  "conditions": [
    {
      "type": "workspaceFolder",
      "folders": ["api", "frontend"]
    }
  ]
}

File Existence

{
  "conditions": [
    {
      "type": "fileExists",
      "path": "Dockerfile"
    }
  ]
}

Commands

The extension provides several commands:

• statusbarQuickActions.editButton: Edit button configuration
• statusbarQuickActions.viewHistory: View command execution history
• statusbarQuickActions.clearHistory: Clear command history

Keyboard Shortcuts

• Alt+1-9: Execute buttons 1-9 (configurable)
• F1: Show command palette with extension commands

Development Workflows

JavaScript/Node.js

{
  "buttons": [
    {
      "id": "npm-install",
      "text": "$(cloud-download) Install",
      "command": { "type": "npm", "script": "install" }
    },
    {
      "id": "npm-test",
      "text": "$(beaker) Test",
      "command": { "type": "npm", "script": "test" }
    }
  ]
}

React Development

{
  "buttons": [
    {
      "id": "react-dev",
      "text": "$(triangle-right) Start",
      "command": { "type": "npm", "script": "dev" },
      "visibility": {
        "conditions": [{ "type": "fileType", "patterns": ["*.tsx", "*.ts"] }]
      }
    }
  ]
}

Git Workflow

{
  "buttons": [
    {
      "id": "git-status",
      "text": "$(git-branch) Status",
      "command": { "type": "shell", "command": "git", "args": ["status"] }
    },
    {
      "id": "git-commit",
      "text": "$(git-commit) Commit",
      "command": {
        "type": "shell",
        "command": "git",
        "args": ["commit", "-m", "${input:commitMessage}"]
      }
    }
  ]
}

Advanced Features

Environment Variables

{
  "environment": {
    "NODE_ENV": "development",
    "API_URL": "http://localhost:3000",
    "DEBUG": "app:*"
  }
}

Working Directory

{
  "workingDirectory": "${workspaceFolder}/src"
}

Timeout Configuration

{
  "execution": {
    "timeout": 300000,
    "showProgress": true
  }
}

Troubleshooting

Common Issues

1. Button not showing

   • Check visibility conditions
   • Verify file associations
   • Enable debug mode in settings

2. Command not found

   • Verify package manager installation
   • Check PATH environment variable
   • Ensure script exists in package.json

3. Permission errors

   • Check file permissions
   • Verify working directory access
   • Run VS Code as administrator (Windows)

Debug Mode

Enable debug mode for detailed logging:

{
  "statusbarQuickActions": {
    "settings": {
      "debug": true
    }
  }
}

Output Panel

Check the "StatusBar Quick Actions" output channel for:

• Command execution logs
• Error messages
• Configuration validation results

API Integration

VSCode Tasks Integration

The extension can integrate with VSCode's task system:

{
  "command": {
    "type": "shell",
    "command": "code",
    "args": ["--task", "build"]
  }
}

Custom Extensions

Developers can extend the extension by:

• Adding new command types
• Implementing custom visibility conditions
• Creating theme variants
• Adding notification providers

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/yourusername/vscode-statusbar-quick-actions.git

# Install dependencies
cd vscode-statusbar-quick-actions
npm install

# Build the extension
npm run compile

# Run in development mode
npm run watch

Code Style

• Use TypeScript with strict mode
• Follow ESLint configuration
• Write comprehensive tests
• Document public APIs

License

MIT License - see LICENSE file for details.

Changelog

v1.0.0

• Initial release
• Universal command execution
• Modern theme system
• Smart visibility conditions
• Comprehensive sample configurations
• Accessibility support
• Enterprise-grade error handling

Support

• Issues: Report bugs and feature requests on GitHub
• Documentation: Comprehensive guides and samples
• Community: Join discussions and share configurations

Streamline your development workflow with intelligent statusbar actions.