File Watcher Pro

Real-time file statistics and workspace insights for Lokus

Features • Installation • Configuration • Commands • Changelog

---

Overview

File Watcher Pro is a powerful plugin for Lokus that provides real-time file and folder statistics for your workspace. Monitor your project's structure, track file counts, and get instant insights right from your editor.

Whether you're managing a small project or a large monorepo, File Watcher Pro gives you the visibility you need to understand your codebase at a glance.

---

Features

📊 Real-time Statistics

• File Count — Track total files in your workspace
• Folder Count — Monitor directory structure
• Live Updates — Statistics refresh automatically on changes

🎯 Status Bar Integration

• Always-visible file/folder counts in the status bar
• Click to refresh or access quick actions
• Customizable position (left/right)

🌳 Explorer Tree View

• Dedicated statistics panel in the explorer
• Hierarchical breakdown of workspace contents
• Quick access to file metrics

⌨️ Keyboard Shortcuts

• Cmd+Shift+T — Run all diagnostics
• Cmd+Shift+N — Show notification with current stats

🔔 Smart Notifications

• Get notified when stats are updated
• Configurable notification types (info, success, warning, error)

⚙️ Highly Configurable

• Enable/disable features as needed
• Customize refresh behavior
• Choose notification preferences

---

Installation

One-Click Install

Or open this link: lokus://install/file-watcher-pro

From Lokus Plugin Marketplace

1. Open Lokus
2. Go to Settings → Plugins → Browse
3. Search for "File Watcher Pro"
4. Click Install

Manual Installation

# Clone or download the plugin
git clone https://github.com/pratham/file-watcher-pro.git

# Navigate to plugin directory
cd file-watcher-pro

# Install dependencies
npm install

# Build the plugin
npm run build

# Link for development
npx lokus-plugin link

---

Configuration

File Watcher Pro can be configured through Lokus settings:

Example Configuration

{
  "file-watcher-pro.enabled": true,
  "file-watcher-pro.notificationType": "success",
  "file-watcher-pro.autoRefresh": true,
  "file-watcher-pro.showStatusBar": true,
  "file-watcher-pro.statusBarPosition": "left"
}

---

Commands

Access these commands via the Command Palette (Cmd+Shift+P):

---

Context Menus

Editor Context Menu

Right-click in the editor to access:

• Insert Test Text — Insert plugin test content
• Show Test Notification — Trigger a notification

Explorer Context Menu

Right-click in the file explorer to access:

• Show File Stats — View statistics for selection
• Refresh Stats — Update statistics

---

Views

Activity Bar

File Watcher Pro adds a dedicated icon to the activity bar with:

• File Statistics — Overview of workspace metrics
• Quick Actions — Common operations at your fingertips

Explorer Panel

A dedicated "File Watcher Stats" section in the explorer showing:

• 📄 Files — Total file count
• 📁 Folders — Total folder count
• 📊 Total — Combined count

---

Requirements

• Lokus version 1.0.0 or higher
• Node.js 16.0.0 or higher (for development)

Permissions Required

---

Plugin Structure

file-watcher-pro/
├── src/
│   ├── index.ts          # Main plugin class
│   └── tree-provider.ts  # Tree view data provider
├── dist/                 # Compiled output
├── assets/
│   └── logo.png          # Plugin icon
├── plugin.json           # Plugin manifest
├── package.json          # NPM configuration
├── tsconfig.json         # TypeScript config
└── README.md             # This file

---

Changelog

v1.0.0 (2025-12-18) — Major Release

Comprehensive UI Testing Suite

✨ Added

• Complete UI API testing framework (60+ API paths)
• Real-time file and folder statistics
• Status bar integration with clickable items
• Explorer tree view for statistics
• Keyboard shortcuts (Cmd+Shift+T, Cmd+Shift+N)
• Context menu integration (editor + explorer)
• 5 configurable settings
• Smart notification system
• Activity bar with custom views
• Full TypeScript support

---

v0.2.0 (2025-12-18) — Beta

• Basic file/folder counting
• Simple status bar display
• Initial command registration
• SDK compatibility fixes

---

v0.1.0 (2025-12-18) — Initial

• Plugin scaffolding
• Basic plugin structure
• Initial manifest configuration

---

Development

# Install dependencies
npm install

# Development with watch mode
npm run build:watch

# Run tests
npm test

# Lint code
npm run lint

# Format code
npm run format

# Generate documentation
npm run docs:generate

---

Troubleshooting

Plugin not loading?

1. Check that permissions are declared in plugin.json
2. Verify Lokus version compatibility
3. Check the developer console for errors

Statistics not updating?

1. Enable autoRefresh in settings
2. Try the manual refresh command
3. Check filesystem permissions

Notifications not showing?

1. Verify ui:notifications permission
2. Check notification type setting
3. Look for React errors in console

---

Support

• 📖 Documentation
• 🐛 Report Issues
• 💬 Discussions

---

License

MIT License — see LICENSE for details.

---

Made with ❤️ for the Lokus community

lokusmd.com