v4.0.1

changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 2025-11-30 - 4.0.1 - fix(readme)
+Update README: refine description and clarify trademark/legal information
+
+- Refined project description and tagline for clarity and brevity (adds lightweight wording and an emoji).
+- Updated Trademark section to explicitly mention third-party trademarks, add guidance about usage and approval, and clarify that trademarks are not covered by the MIT license.
+- Minor legal/company wording and formatting fixes (e.g. 'District Court' capitalization and contact sentence tweaks).
+- General README wording and formatting improvements for clearer instructions and feature descriptions.
+
+## 2025-11-30 - 4.0.0 - BREAKING CHANGE(watchers)
+Replace chokidar with native platform watchers and add cross-runtime support (Node.js, Deno, Bun); introduce write stabilization and internal glob matching
+
+- Replaced chokidar-based implementation with native file watching APIs (Node.js fs.watch, Deno.watchFs).
+- Added platform-specific watchers: NodeWatcher and DenoWatcher (Bun uses Node compatibility).
+- Implemented polling-based write stabilization (awaitWriteFinish replacement) to avoid duplicate events during writes.
+- Keep glob pattern support by matching events internally using picomatch; base-path extraction used to limit watch scope.
+- API/runtime requirement increased: Node.js >= 20.0.0 is required for native recursive fs.watch.
+- Package/documentation name and examples updated to @push.rocks/smartchok and export the Smartwatch class.
+
 ## 2025-11-30 - 3.0.0 - BREAKING CHANGE(smartwatch)
 Introduce Smartwatch: cross-runtime native file watching for Node.js, Deno and Bun; rename smartchok to smartwatch and bump major version to 2.0.0
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartchok",
-  "version": "3.0.0",
+  "version": "4.0.1",
   "private": false,
   "description": "A cross-runtime file watcher with glob pattern support for Node.js, Deno, and Bun.",
   "main": "dist_ts/index.js",

readme.hints.md

@@ -4,6 +4,13 @@
 
 The module now uses native file watching APIs instead of chokidar, providing cross-runtime support for Node.js, Deno, and Bun.
 
+### Exported Class
+
+The package exports the `Smartwatch` class (not `Smartchok`):
+```typescript
+import { Smartwatch } from '@push.rocks/smartchok';
+```
+
 ### Architecture
 
 ```

readme.md

@@ -1,6 +1,6 @@
-# @push.rocks/smartwatch
+# @push.rocks/smartchok
 
-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
 
@@ -9,25 +9,28 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
 ## Install
 
 ```sh
-npm install @push.rocks/smartwatch
+npm install @push.rocks/smartchok
 # or
-pnpm add @push.rocks/smartwatch
+pnpm add @push.rocks/smartchok
 ```
 
 ## Features
 
-🔍 **Glob Pattern Support** - Watch files using glob patterns like `**/*.ts` or `src/**/*.js`
+🌐 **Cross-Runtime** — Works seamlessly on Node.js 20+, Deno, and Bun
-📡 **RxJS Observables** - Subscribe to file system events using reactive streams
+🔍 **Glob Pattern Support** — Watch files using familiar patterns like `**/*.ts` and `src/**/*.{js,jsx}`
-🔄 **Dynamic Watching** - Add or remove watch patterns at runtime
+📡 **RxJS Observables** — Subscribe to file system events using reactive streams
-⚡ **Chokidar 5.x** - Built on the latest chokidar with improved performance
+🔄 **Dynamic Watching** — Add or remove watch patterns at runtime
-🎯 **TypeScript First** - Full TypeScript support with comprehensive type definitions
+⚡ **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
 
 ### Basic Setup
 
 ```typescript
-import { Smartwatch } from '@push.rocks/smartwatch';
+import { Smartwatch } from '@push.rocks/smartchok';
 
 // Create a watcher with glob patterns
 const watcher = new Smartwatch([
@@ -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 |
+| Event       | Description                    |
-|-------|-------------|
+|-------------|--------------------------------|
-| `add` | File has been added |
+| `add`       | File has been added            |
-| `addDir` | Directory has been added |
+| `addDir`    | Directory has been added       |
-| `change` | File has been changed |
+| `change`    | File has been modified         |
-| `unlink` | File has been removed |
+| `unlink`    | File has been removed          |
-| `unlinkDir` | Directory has been removed |
+| `unlinkDir` | Directory has been removed     |
-| `error` | Error occurred |
+| `error`     | Error occurred                 |
-| `ready` | Initial scan complete |
+| `ready`     | Initial scan complete          |
-| `raw` | Raw event from the underlying watcher |
 
 ### Dynamic Watch Management
 
@@ -107,7 +110,7 @@ await watcher.stop();
 ### Complete Example
 
 ```typescript
-import { Smartwatch } from '@push.rocks/smartwatch';
+import { Smartwatch } from '@push.rocks/smartchok';
 
 async function watchProject() {
   // Initialize with patterns
@@ -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.
+smartchok uses native file watching APIs for each runtime:
 
-When you provide glob patterns:
+| Runtime         | API Used                         |
-1. **Base path extraction** - smartwatch extracts the static base path from each pattern
+|-----------------|----------------------------------|
-2. **Efficient watching** - chokidar watches the base directories
+| **Node.js 20+** | `fs.watch({ recursive: true })`  |
-3. **Pattern filtering** - Events are filtered through picomatch matchers before being emitted
+| **Deno**        | `Deno.watchFs()`                 |
+| **Bun**         | Node.js compatibility layer      |
+
+### Under the Hood
+
+Native file watching APIs don't support glob patterns directly, so smartchok 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
+
+smartchok 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 |
+| Method                                 | Returns                                        | Description                                    |
-|--------|---------|-------------|
+|----------------------------------------|------------------------------------------------|------------------------------------------------|
-| `start()` | `Promise<void>` | Starts watching for file changes |
+| `start()`                              | `Promise<void>`                                | Starts watching for file changes               |
-| `stop()` | `Promise<void>` | Stops the file watcher |
+| `stop()`                               | `Promise<void>`                                | Stops the file watcher and cleans up resources |
-| `add(patterns: string[])` | `void` | Adds patterns to watch |
+| `add(patterns: string[])`              | `void`                                         | Adds additional patterns to watch              |
-| `remove(pattern: string)` | `void` | Removes a pattern from watching |
+| `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 |
+| `getObservableFor(event: TFsEvent)`    | `Promise<Observable<[string, Stats]>>`         | Returns an RxJS observable for the specified event |
 
 #### Properties
 
-| Property | Type | Description |
+| Property | Type                                      | Description              |
-|----------|------|-------------|
+|----------|-------------------------------------------|--------------------------|
-| `status` | `'idle' \| 'starting' \| 'watching'` | Current watcher status |
+| `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 smartchok?
+
+| Feature                 | smartchok            | 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, smartchok 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.

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartchok',
-  version: '3.0.0',
+  version: '4.0.1',
   description: 'A cross-runtime file watcher with glob pattern support for Node.js, Deno, and Bun.'
 }