NPM Pilot - VS Code Extension

✨ Features

Package.json Scripts

• Beautiful Sidebar Interface - Clean, modern UI integrated into VS Code's activity bar
• Smart Icon Mapping - Automatically displays appropriate icons for script types (dev, build, test, start, deploy, docker, and more)
• Real-time Search - Instantly filter scripts by name or command
• One-Click Execution - Run any script directly in the terminal
• Auto-refresh - Automatically updates when package.json changes or sidebar becomes visible
• Keyboard Shortcut - Open panel instantly with Ctrl+Alt+S (Windows/Linux) or Cmd+Alt+S (Mac)
• Auto-Focus Search - Search input is automatically focused when panel opens

Custom Scripts & Flows

• Create Custom Commands - Add single commands that aren't in your package.json
• Build Command Flows - Chain multiple commands together like CI/CD pipelines
• Workspace-Specific - Custom scripts and flows are saved per workspace/project
• Type Toggle - Easily switch between creating a single command or a multi-command flow
• Cross-Platform - Flows work on Windows, macOS, and Linux

Globals (Cross-Workspace)

• Global Commands - Create commands accessible from any project
• Global Flows - Build multi-command workflows that work everywhere
• Always Available - Your global entries are not tied to any specific workspace

Hover Tooltips

• Detailed View - Hover over any item to see full command details
• Flow Preview - See all commands in a flow with numbered indices
• Type Badges - Quickly identify command vs flow type

Usage Tracking

• Usage Counter - See how many times you've run each script
• Last Used Time - Know when you last ran a command
• Recent Indicator - Recently used scripts are highlighted

Settings

• Customizable UI - Enable/disable features to fit your workflow
• Toggle Tooltips - Show or hide hover tooltips
• Toggle Import/Export - Show or hide data management buttons
• Toggle Stats - Show or hide usage count and last used time
• Toggle Tabs - Show or hide Custom and Globals tabs
• Persistent - Settings are saved globally across all workspaces

Data Management

• View Data - Inspect your saved scripts and flows as JSON
• Export - Backup your custom scripts, flows, and globals to a file
• Import - Restore or share configurations with replace/merge options
• Tab-Specific Actions - Export/import only what you need

📦 Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X)
3. Search for "NPM Pilot"
4. Click Install

From VSIX File

1. Download the .vsix file
2. Open VS Code
3. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
4. Type "Install from VSIX..."
5. Select the downloaded .vsix file
6. Reload VS Code when prompted

🚀 Usage

Getting Started

1. Open a workspace that contains a package.json file
2. Click the NPM Pilot icon in the activity bar (left sidebar)
3. View all your npm scripts organized in a clean interface

Running Scripts

• Package.json Scripts - Click any script to run npm run <script> in a new terminal
• Custom Scripts - Create and run your own single commands
• Flows - Execute multiple commands in sequence
• Globals - Run commands that work in any project

Navigation Tabs

Creating Custom Scripts or Flows

1. Switch to the Custom tab
2. Click to expand "Add New"
3. Choose type: Command (single) or Flow (multiple)
4. Enter a name and command(s)
5. Click "Create"

Creating Globals

1. Switch to the Globals tab
2. Click to expand "Add New Global"
3. Choose type: Command or Flow
4. Enter a name and command(s)
5. Click "Create Global"

Settings

1. Click the gear icon in the top-right corner
2. Toggle settings on/off:
   • Show hover tooltips
   • Show import/export buttons
   • Show last used time
   • Show used count
   • Enable Custom tab
   • Enable Globals tab

Import/Export

• Global Actions (top) - View All, Export All, Import All data
• Tab Actions (bottom of each tab) - Work with specific data types only

📋 Requirements

• VS Code: 1.74.0 or higher
• Node.js: Project with package.json file

👤 Author

Abdelrahman Seada

• Email: abdom.seada@gmail.com
• GitLab: @abdom.seada

📝 License

This project is licensed under the MIT License.

📮 Support

If you encounter any issues or have suggestions:

• Open an issue on GitLab
• Email: abdom.seada@gmail.com