gib-runs 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [2.0.0] - 2026-02-08
+
+### Added
+- 🎨 Beautiful modern UI with status indicator in browser
+- 📊 Performance monitoring (request count, reload count, uptime)
+- 🗜️ Built-in gzip compression for better performance
+- 🎪 Auto-reconnection with exponential backoff
+- 🎨 Colored console output with chalk
+- 📈 Statistics display on server shutdown
+- ⚡ Hot CSS injection without full page reload
+- 🔄 Smart file watching with timestamps
+- 🚀 Modern startup banner with detailed information
+- 📱 Better multi-device support display
+- 🎯 Enhanced SPA support
+- 🔌 Improved proxy configuration
+- 📦 Better middleware support
+
+### Changed
+- Renamed from `live-server` to `gib-runs`
+- Updated all dependencies to latest versions
+- Modernized codebase with better error handling
+- Improved logging with icons and colors
+- Enhanced WebSocket connection handling
+- Better file change detection messages
+- Modernized CLI help and version display
+
+### Improved
+- Performance optimizations
+- Better error messages
+- More informative console output
+- Enhanced developer experience
+- Improved documentation
+
+### Technical
+- Upgraded chokidar to v3.5.3
+- Replaced colors with chalk v4.1.2
+- Updated connect to v3.7.0
+- Added compression middleware
+- Modernized all dependencies
+- Better Node.js compatibility (>=12.0.0)
+
+---
+
+## Previous Versions
+
+This project is a complete modernization and rebranding of live-server with significant enhancements and new features.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sofinco (https://github.com/levouinse)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,441 @@
+[![npm version](https://img.shields.io/npm/v/gib-runs.svg)](https://www.npmjs.org/package/gib-runs)
+[![npm downloads](https://img.shields.io/npm/dm/gib-runs.svg)](https://www.npmjs.org/package/gib-runs)
+[![license](https://img.shields.io/npm/l/gib-runs.svg)](https://github.com/levouinse/gib-runs/blob/main/LICENSE)
+
+# 🚀 GIB-RUNS
+
+**Modern development server with live reload - Unlike some people, this actually runs on merit, not connections.**
+
+> *"GIB-RUNS: Because your development server shouldn't need a family dynasty to work properly."*
+
+Inspired by the need for something that actually **runs** based on capability, not nepotism. This development server proves that with the right features and hard work, you don't need a famous last name to be successful.
+
+## 🎭 Why "GIB-RUNS"?
+
+The name is a playful nod to someone who got a head start in life. But unlike certain political figures, this server:
+- ✅ Actually earned its position through features
+- ✅ Works hard without shortcuts
+- ✅ Doesn't rely on daddy's connections
+- ✅ Serves everyone equally, regardless of background
+- ✅ Transparent about what it does (no hidden agendas)
+
+*"When your development server has more integrity than some vice presidents."* 😏
+
+## ✨ Features
+
+### Core Features (Earned, Not Inherited)
+- 🔄 **Live Reload** - Automatic browser refresh on file changes (works without political intervention)
+- ⚡ **Hot CSS Injection** - Update styles without full page reload (no constitutional court needed)
+- 🎨 **Beautiful UI** - Modern status indicator with real-time feedback (actually designed, not just given)
+- 📊 **Performance Monitoring** - Track requests, reloads, and uptime (transparent metrics, unlike some careers)
+- 🗜️ **Compression** - Built-in gzip compression for better performance (optimized through effort, not privilege)
+- 🔒 **HTTPS/HTTP2 Support** - Secure development with modern protocols
+- 🌐 **CORS Support** - Easy cross-origin development (serves everyone equally)
+- 🔐 **HTTP Authentication** - Protect your development server (actual security, not just family name)
+- 🎯 **SPA Support** - Perfect for Single Page Applications
+- 🔌 **Proxy Support** - Proxy API requests during development
+- 📦 **Middleware Support** - Extend functionality with custom middleware
+- 🎭 **Mount Directories** - Serve multiple directories on different routes
+
+### Advanced Features (Built on Competence)
+- 🔍 **Smart File Watching** - Intelligent change detection with debouncing (actually smart, not just called smart)
+- 🎪 **Auto Reconnection** - WebSocket reconnection with exponential backoff
+- 📱 **Multi-Device Support** - Access from any device on your network (meritocracy in action)
+- 🎨 **Colored Logging** - Beautiful, informative console output
+- ⚙️ **Highly Configurable** - Extensive CLI options and config file support
+- 🚦 **Status Indicator** - Visual feedback on connection status
+- 📈 **Statistics** - Detailed metrics on shutdown (real data, not manufactured success stories)
+
+## 📦 Installation
+
+### Global Installation (Recommended)
+```bash
+npm install -g gib-runs
+```
+
+### Local Installation
+```bash
+npm install --save-dev gib-runs
+```
+
+### From Source
+```bash
+git clone https://github.com/levouinse/gib-runs.git
+cd gib-runs
+npm install
+npm install -g
+```
+
+## 🚀 Quick Start
+
+Navigate to your project directory and run:
+
+```bash
+gib-runs
+```
+
+That's it! Your project is now being served with live reload enabled.
+
+## 📖 Usage
+
+### Command Line
+
+```bash
+# Serve current directory on default port (8080)
+gib-runs
+
+# Serve specific directory
+gib-runs ./dist
+
+# Custom port
+gib-runs --port=3000
+
+# Open specific path in browser
+gib-runs --open=/dashboard
+
+# SPA mode with custom port
+gib-runs --spa --port=8000
+
+# HTTPS with custom config
+gib-runs --https=./config/https.conf.js
+
+# Multiple options
+gib-runs dist --port=3000 --spa --cors --no-browser
+```
+
+### CLI Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--port=NUMBER` | Port to use | `8080` |
+| `--host=ADDRESS` | Address to bind to | `0.0.0.0` |
+| `--open=PATH` | Path to open in browser | `/` |
+| `--no-browser` | Suppress browser launch | `false` |
+| `--browser=BROWSER` | Specify browser to use | System default |
+| `-q, --quiet` | Suppress logging | `false` |
+| `-V, --verbose` | Verbose logging | `false` |
+| `--watch=PATH` | Paths to watch (comma-separated) | All files |
+| `--ignore=PATH` | Paths to ignore (comma-separated) | None |
+| `--ignorePattern=RGXP` | Regex pattern to ignore | None |
+| `--no-css-inject` | Reload page on CSS change | `false` |
+| `--entry-file=PATH` | Entry file for SPA | None |
+| `--spa` | Single Page App mode | `false` |
+| `--mount=ROUTE:PATH` | Mount directory to route | None |
+| `--wait=MILLISECONDS` | Debounce reload delay | `100` |
+| `--htpasswd=PATH` | HTTP auth file | None |
+| `--cors` | Enable CORS | `false` |
+| `--https=PATH` | HTTPS config module | None |
+| `--https-module=MODULE` | Custom HTTPS module | `https` |
+| `--proxy=ROUTE:URL` | Proxy requests | None |
+| `--middleware=PATH` | Custom middleware | None |
+| `-v, --version` | Show version | - |
+| `-h, --help` | Show help | - |
+
+### Node.js API
+
+```javascript
+const gibRun = require('gib-runs');
+
+const server = gibRun.start({
+  port: 8080,
+  host: '0.0.0.0',
+  root: './public',
+  open: true,
+  file: 'index.html',
+  wait: 100,
+  logLevel: 2,
+  
+  // Advanced options
+  compression: true,
+  cors: true,
+  spa: true,
+  
+  // Watch specific paths
+  watch: ['./src', './public'],
+  
+  // Ignore patterns
+  ignore: ['node_modules', '.git'],
+  
+  // Mount directories
+  mount: [
+    ['/components', './node_modules'],
+    ['/assets', './static']
+  ],
+  
+  // Proxy configuration
+  proxy: [
+    ['/api', 'http://localhost:3000']
+  ],
+  
+  // Custom middleware
+  middleware: [
+    function(req, res, next) {
+      console.log('Custom middleware');
+      next();
+    }
+  ]
+});
+
+// Shutdown programmatically
+// gibRun.shutdown();
+```
+
+### Configuration File
+
+Create `~/.gib-runs.json` for default settings:
+
+```json
+{
+  "port": 8080,
+  "host": "0.0.0.0",
+  "open": true,
+  "logLevel": 2,
+  "compression": true,
+  "cors": false
+}
+```
+
+## 🔒 HTTPS Configuration
+
+Create an HTTPS configuration module:
+
+```javascript
+// https.conf.js
+const fs = require('fs');
+
+module.exports = {
+  cert: fs.readFileSync(__dirname + '/server.cert'),
+  key: fs.readFileSync(__dirname + '/server.key'),
+  passphrase: 'your-passphrase'
+};
+```
+
+Then run:
+```bash
+gib-runs --https=./https.conf.js
+```
+
+### HTTP/2 Support
+
+Install a custom HTTPS module like `spdy`:
+
+```bash
+npm install spdy
+gib-runs --https=./https.conf.js --https-module=spdy
+```
+
+## 🎯 Single Page Applications
+
+For SPAs (React, Vue, Angular, etc.):
+
+```bash
+# Redirect all routes to index.html
+gib-runs --spa
+
+# Or with entry file
+gib-runs --entry-file=index.html
+```
+
+### SPA Middleware Options
+
+- `spa` - Redirects all routes to `/#/route`
+- `spa-ignore-assets` - Like `spa` but ignores requests with file extensions
+
+## 🔌 Proxy Configuration
+
+Proxy API requests during development:
+
+```bash
+gib-runs --proxy=/api:http://localhost:3000
+```
+
+Multiple proxies:
+```bash
+gib-runs --proxy=/api:http://localhost:3000 --proxy=/auth:http://localhost:4000
+```
+
+## 🎨 Custom Middleware
+
+Create custom middleware:
+
+```javascript
+// middleware/custom.js
+module.exports = function(req, res, next) {
+  console.log('Request:', req.url);
+  next();
+};
+```
+
+Use it:
+```bash
+gib-runs --middleware=./middleware/custom.js
+```
+
+## 📊 Status Indicator
+
+GIB-RUNS includes a beautiful status indicator that appears in the bottom-right corner of your page:
+
+- 🟢 **Green** - Live reload active
+- 🟡 **Yellow** - Reconnecting/Reloading
+- 🔴 **Red** - Disconnected
+
+The indicator shows:
+- Connection status
+- CSS update notifications
+- Reload notifications
+- Auto-reconnection attempts
+
+## 🎭 Mount Directories
+
+Serve multiple directories:
+
+```bash
+gib-runs --mount=/components:./node_modules --mount=/static:./assets
+```
+
+Access them at:
+- `http://localhost:8080/components/...`
+- `http://localhost:8080/static/...`
+
+## 🔐 HTTP Authentication
+
+Protect your development server:
+
+```bash
+# Create htpasswd file
+htpasswd -c .htpasswd username
+
+# Use it
+gib-runs --htpasswd=.htpasswd
+```
+
+## 🌐 Network Access
+
+Access your server from other devices:
+
+```bash
+gib-runs --verbose
+```
+
+This will show all network interfaces:
+```
+🚀 GIB-RUNS v2.0.0
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+  📁 Root:       /home/user/project
+  🌐 Local:      http://127.0.0.1:8080
+  🔗 Network:
+     http://192.168.1.100:8080
+     http://10.0.0.5:8080
+  🔄 Live Reload: Enabled
+  📦 Compression: Enabled
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+## 🐛 Troubleshooting
+
+### No reload on changes
+1. Check browser console for WebSocket connection
+2. Ensure files are being watched: `gib-runs --verbose`
+3. Try increasing wait time: `gib-runs --wait=500`
+
+### Port already in use
+GIB-RUNS will automatically try another port. Or specify one:
+```bash
+gib-runs --port=3000
+```
+
+### ENOSPC error (Linux)
+Increase file watchers limit:
+```bash
+echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
+sudo sysctl -p
+```
+
+### Changes missing or outdated
+Increase debounce time:
+```bash
+gib-runs --wait=500
+```
+
+## 🎯 Use Cases
+
+### React Development
+```bash
+cd my-react-app
+gib-runs build --spa --port=3000
+```
+
+### Vue.js Development
+```bash
+cd my-vue-app
+gib-runs dist --spa --cors
+```
+
+### Static Website
+```bash
+cd my-website
+gib-runs --open=/index.html
+```
+
+### API Development with Proxy
+```bash
+gib-runs public --proxy=/api:http://localhost:3000
+```
+
+### Multi-Project Setup
+```bash
+gib-runs --mount=/app1:./project1/dist --mount=/app2:./project2/dist
+```
+
+## 📈 Performance
+
+GIB-RUNS includes several performance optimizations (all achieved through actual work, not family connections):
+
+- **Gzip Compression** - Reduces transfer size by up to 70% (real optimization, not just claims)
+- **Smart Caching** - Efficient file serving with proper cache headers
+- **Debounced Reloads** - Prevents reload spam during rapid changes
+- **Efficient File Watching** - Uses native file system events (actually efficient)
+- **Connection Pooling** - Reuses WebSocket connections
+
+> *"Unlike some political careers, these optimizations are based on actual technical merit."*
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📝 License
+
+MIT License - see [LICENSE](LICENSE) file for details
+
+## 👤 Author
+
+**sofinco**
+- GitHub: [@levouinse](https://github.com/levouinse)
+- Repository: [gib-runs](https://github.com/levouinse/gib-runs)
+
+## 🙏 Acknowledgments
+
+Built with inspiration from live-server and enhanced with modern features for today's development needs.
+
+## 📚 Related Projects
+
+- [connect](https://github.com/senchalabs/connect) - Middleware framework
+- [chokidar](https://github.com/paulmillr/chokidar) - File watching
+- [faye-websocket](https://github.com/faye/faye-websocket-node) - WebSocket support
+
+## 🔗 Links
+
+- [npm package](https://www.npmjs.com/package/gib-runs)
+- [GitHub repository](https://github.com/levouinse/gib-runs)
+- [Issue tracker](https://github.com/levouinse/gib-runs/issues)
+- [Changelog](https://github.com/levouinse/gib-runs/releases)
+
+---
+
+<p align="center">Made with ❤️ by <a href="https://github.com/levouinse">sofinco</a></p>