|
|
|
|
@@ -1,6 +1,6 @@
|
|
|
|
|
# @push.rocks/smartwatch
|
|
|
|
|
|
|
|
|
|
A smart wrapper for chokidar 5.x with glob pattern support, RxJS observable integration, and enhanced file watching features.
|
|
|
|
|
A lightweight, cross-runtime file watcher with glob pattern support for **Node.js**, **Deno**, and **Bun**. Zero heavyweight dependencies — just native file watching APIs for maximum performance. 🚀
|
|
|
|
|
|
|
|
|
|
## Issue Reporting and Security
|
|
|
|
|
|
|
|
|
|
@@ -16,11 +16,14 @@ pnpm add @push.rocks/smartwatch
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
🔍 **Glob Pattern Support** - Watch files using glob patterns like `**/*.ts` or `src/**/*.js`
|
|
|
|
|
📡 **RxJS Observables** - Subscribe to file system events using reactive streams
|
|
|
|
|
🔄 **Dynamic Watching** - Add or remove watch patterns at runtime
|
|
|
|
|
⚡ **Chokidar 5.x** - Built on the latest chokidar with improved performance
|
|
|
|
|
🎯 **TypeScript First** - Full TypeScript support with comprehensive type definitions
|
|
|
|
|
🌐 **Cross-Runtime** — Works seamlessly on Node.js 20+, Deno, and Bun
|
|
|
|
|
🔍 **Glob Pattern Support** — Watch files using familiar patterns like `**/*.ts` and `src/**/*.{js,jsx}`
|
|
|
|
|
📡 **RxJS Observables** — Subscribe to file system events using reactive streams
|
|
|
|
|
🔄 **Dynamic Watching** — Add or remove watch patterns at runtime
|
|
|
|
|
⚡ **Native Performance** — Uses `fs.watch()` on Node.js/Bun and `Deno.watchFs()` on Deno
|
|
|
|
|
✨ **Write Stabilization** — Built-in debouncing prevents duplicate events during file writes
|
|
|
|
|
🎯 **TypeScript First** — Full TypeScript support with comprehensive type definitions
|
|
|
|
|
📦 **Minimal Footprint** — No chokidar, no FSEvents bindings — just ~500 lines of focused code
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
@@ -50,6 +53,7 @@ const changeObservable = await watcher.getObservableFor('change');
|
|
|
|
|
changeObservable.subscribe({
|
|
|
|
|
next: ([path, stats]) => {
|
|
|
|
|
console.log(`File changed: ${path}`);
|
|
|
|
|
console.log(`New size: ${stats?.size} bytes`);
|
|
|
|
|
},
|
|
|
|
|
error: (err) => {
|
|
|
|
|
console.error(`Error: ${err}`);
|
|
|
|
|
@@ -71,16 +75,15 @@ unlinkObservable.subscribe(([path]) => {
|
|
|
|
|
|
|
|
|
|
### Supported Events
|
|
|
|
|
|
|
|
|
|
| Event | Description |
|
|
|
|
|
|-------|-------------|
|
|
|
|
|
| `add` | File has been added |
|
|
|
|
|
| `addDir` | Directory has been added |
|
|
|
|
|
| `change` | File has been changed |
|
|
|
|
|
| `unlink` | File has been removed |
|
|
|
|
|
| `unlinkDir` | Directory has been removed |
|
|
|
|
|
| `error` | Error occurred |
|
|
|
|
|
| `ready` | Initial scan complete |
|
|
|
|
|
| `raw` | Raw event from the underlying watcher |
|
|
|
|
|
| Event | Description |
|
|
|
|
|
|-------------|--------------------------------|
|
|
|
|
|
| `add` | File has been added |
|
|
|
|
|
| `addDir` | Directory has been added |
|
|
|
|
|
| `change` | File has been modified |
|
|
|
|
|
| `unlink` | File has been removed |
|
|
|
|
|
| `unlinkDir` | Directory has been removed |
|
|
|
|
|
| `error` | Error occurred |
|
|
|
|
|
| `ready` | Initial scan complete |
|
|
|
|
|
|
|
|
|
|
### Dynamic Watch Management
|
|
|
|
|
|
|
|
|
|
@@ -152,12 +155,38 @@ watchProject();
|
|
|
|
|
|
|
|
|
|
## How It Works
|
|
|
|
|
|
|
|
|
|
Since chokidar 4.x+ no longer supports glob patterns natively, smartwatch handles glob pattern matching internally using [picomatch](https://github.com/micromatch/picomatch). This means you get the familiar glob syntax while benefiting from chokidar's efficient file watching capabilities.
|
|
|
|
|
smartwatch uses native file watching APIs for each runtime:
|
|
|
|
|
|
|
|
|
|
When you provide glob patterns:
|
|
|
|
|
1. **Base path extraction** - smartwatch extracts the static base path from each pattern
|
|
|
|
|
2. **Efficient watching** - chokidar watches the base directories
|
|
|
|
|
3. **Pattern filtering** - Events are filtered through picomatch matchers before being emitted
|
|
|
|
|
| Runtime | API Used |
|
|
|
|
|
|-----------------|----------------------------------|
|
|
|
|
|
| **Node.js 20+** | `fs.watch({ recursive: true })` |
|
|
|
|
|
| **Deno** | `Deno.watchFs()` |
|
|
|
|
|
| **Bun** | Node.js compatibility layer |
|
|
|
|
|
|
|
|
|
|
### Under the Hood
|
|
|
|
|
|
|
|
|
|
Native file watching APIs don't support glob patterns directly, so smartwatch handles pattern matching internally:
|
|
|
|
|
|
|
|
|
|
1. **Base path extraction** — Extracts the static portion from each glob pattern (e.g., `./src/` from `./src/**/*.ts`)
|
|
|
|
|
2. **Efficient watching** — Native watchers monitor only the base directories
|
|
|
|
|
3. **Pattern filtering** — Events are filtered through [picomatch](https://github.com/micromatch/picomatch) matchers before emission
|
|
|
|
|
4. **Event deduplication** — Built-in throttling prevents duplicate events from rapid file operations
|
|
|
|
|
|
|
|
|
|
### Write Stabilization
|
|
|
|
|
|
|
|
|
|
smartwatch includes built-in write stabilization (similar to chokidar's `awaitWriteFinish`). When a file is being written, events are held until the file size stabilizes, preventing multiple events for a single write operation.
|
|
|
|
|
|
|
|
|
|
Default settings:
|
|
|
|
|
- **Stability threshold**: 300ms
|
|
|
|
|
- **Poll interval**: 100ms
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
| Runtime | Version |
|
|
|
|
|
|-----------------|----------------------------------------|
|
|
|
|
|
| **Node.js** | 20+ (required for native recursive watching) |
|
|
|
|
|
| **Deno** | Any version with `Deno.watchFs()` support |
|
|
|
|
|
| **Bun** | Uses Node.js compatibility |
|
|
|
|
|
|
|
|
|
|
## API Reference
|
|
|
|
|
|
|
|
|
|
@@ -171,37 +200,62 @@ new Smartwatch(patterns: string[])
|
|
|
|
|
|
|
|
|
|
Creates a new Smartwatch instance with the given glob patterns.
|
|
|
|
|
|
|
|
|
|
**Parameters:**
|
|
|
|
|
- `patterns` — Array of glob patterns to watch (e.g., `['./src/**/*.ts', './config/*.json']`)
|
|
|
|
|
|
|
|
|
|
#### Methods
|
|
|
|
|
|
|
|
|
|
| Method | Returns | Description |
|
|
|
|
|
|--------|---------|-------------|
|
|
|
|
|
| `start()` | `Promise<void>` | Starts watching for file changes |
|
|
|
|
|
| `stop()` | `Promise<void>` | Stops the file watcher |
|
|
|
|
|
| `add(patterns: string[])` | `void` | Adds patterns to watch |
|
|
|
|
|
| `remove(pattern: string)` | `void` | Removes a pattern from watching |
|
|
|
|
|
| `getObservableFor(event: TFsEvent)` | `Promise<Observable<[string, Stats]>>` | Returns an RxJS observable for the specified event |
|
|
|
|
|
| Method | Returns | Description |
|
|
|
|
|
|----------------------------------------|------------------------------------------------|------------------------------------------------|
|
|
|
|
|
| `start()` | `Promise<void>` | Starts watching for file changes |
|
|
|
|
|
| `stop()` | `Promise<void>` | Stops the file watcher and cleans up resources |
|
|
|
|
|
| `add(patterns: string[])` | `void` | Adds additional patterns to watch |
|
|
|
|
|
| `remove(pattern: string)` | `void` | Removes a pattern from the watch list |
|
|
|
|
|
| `getObservableFor(event: TFsEvent)` | `Promise<Observable<[string, Stats]>>` | Returns an RxJS observable for the specified event |
|
|
|
|
|
|
|
|
|
|
#### Properties
|
|
|
|
|
|
|
|
|
|
| Property | Type | Description |
|
|
|
|
|
|----------|------|-------------|
|
|
|
|
|
| `status` | `'idle' \| 'starting' \| 'watching'` | Current watcher status |
|
|
|
|
|
| Property | Type | Description |
|
|
|
|
|
|----------|-------------------------------------------|--------------------------|
|
|
|
|
|
| `status` | `'idle' \| 'starting' \| 'watching'` | Current watcher status |
|
|
|
|
|
|
|
|
|
|
### Types
|
|
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
|
type TFsEvent = 'add' | 'addDir' | 'change' | 'error' | 'unlink' | 'unlinkDir' | 'ready' | 'raw';
|
|
|
|
|
type TSmartwatchStatus = 'idle' | 'starting' | 'watching';
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Why smartwatch?
|
|
|
|
|
|
|
|
|
|
| Feature | smartwatch | chokidar |
|
|
|
|
|
|-------------------------|----------------------|--------------------|
|
|
|
|
|
| Native API | ✅ Direct `fs.watch` | ❌ FSEvents bindings |
|
|
|
|
|
| Cross-runtime | ✅ Node, Deno, Bun | ❌ Node only |
|
|
|
|
|
| Dependencies | 4 small packages | ~20 packages |
|
|
|
|
|
| Write stabilization | ✅ Built-in | ✅ Built-in |
|
|
|
|
|
| Glob support | ✅ picomatch | ✅ anymatch |
|
|
|
|
|
| Bundle size | ~15KB | ~200KB+ |
|
|
|
|
|
|
|
|
|
|
If you need a lightweight file watcher without native compilation headaches, smartwatch has you covered.
|
|
|
|
|
|
|
|
|
|
## License and Legal Information
|
|
|
|
|
|
|
|
|
|
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
|
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
|
|
|
|
|
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
|
|
|
|
|
|
### Trademarks
|
|
|
|
|
|
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
|
|
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
|
|
|
|
|
|
### Company Information
|
|
|
|
|
|
|
|
|
|
Task Venture Capital GmbH
|
|
|
|
|
Registered at District court Bremen HRB 35230 HB, Germany
|
|
|
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
|
|
|
|
|
|
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
|
|
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
|
|
|
|
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
|
|
|
|
|
