v5.0.0

changelog.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 2025-11-30 - 5.0.0 - BREAKING CHANGE(@push.rocks/smartwatch)
+Rename package and update branding/docs: switch from @push.rocks/smartchok to @push.rocks/smartwatch, update repository/homepage/bugs URLs and author, and refresh README examples and install instructions.
+
+- Package name changed from @push.rocks/smartchok to @push.rocks/smartwatch in package.json
+- Repository, homepage and issue URLs updated to point to the new smartwatch repository
+- Author changed to Task Venture Capital GmbH in package metadata
+- README updated: install commands, import examples and references now use @push.rocks/smartwatch
+- Documentation text and branding updated throughout README (project name, internal references)
+
+## 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
 

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@push.rocks/smartchok",
-  "version": "4.0.0",
+  "name": "@push.rocks/smartwatch",
+  "version": "5.0.0",
   "private": false,
   "description": "A cross-runtime file watcher with glob pattern support for Node.js, Deno, and Bun.",
   "main": "dist_ts/index.js",
@@ -13,14 +13,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://code.foss.global/push.rocks/smartchok.git"
+    "url": "https://code.foss.global/push.rocks/smartwatch.git"
   },
-  "author": "Lossless GmbH",
+  "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/push.rocks/smartchok/issues"
+    "url": "https://gitlab.com/push.rocks/smartwatch/issues"
   },
-  "homepage": "https://code.foss.global/push.rocks/smartchok",
+  "homepage": "https://code.foss.global/push.rocks/smartwatch",
   "engines": {
     "node": ">=20.0.0"
   },

readme.md

@@ -1,6 +1,6 @@
-# @push.rocks/smartchok
+# @push.rocks/smartwatch
 
-A cross-runtime file watcher with glob pattern support for **Node.js**, **Deno**, and **Bun**. Built with native file watching APIs for maximum performance and zero heavyweight dependencies.
+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,27 +9,28 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
 ## Install
 
 ```sh
-npm install @push.rocks/smartchok
+npm install @push.rocks/smartwatch
 # or
-pnpm add @push.rocks/smartchok
+pnpm add @push.rocks/smartwatch
 ```
 
 ## Features
 
-🌐 **Cross-Runtime** - Works on Node.js 20+, Deno, and Bun
-🔍 **Glob Pattern Support** - Watch files using familiar patterns like `**/*.ts`
-📡 **RxJS Observables** - Subscribe to file system events using reactive streams
-🔄 **Dynamic Watching** - Add or remove watch patterns at runtime
-⚡ **Native Performance** - Uses `fs.watch()` and `Deno.watchFs()` directly
-🎯 **TypeScript First** - Full TypeScript support with comprehensive type definitions
-📦 **Minimal Dependencies** - No heavyweight watcher libraries required
+🌐 **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
 
 ### Basic Setup
 
 ```typescript
-import { Smartwatch } from '@push.rocks/smartchok';
+import { Smartwatch } from '@push.rocks/smartwatch';
 
 // Create a watcher with glob patterns
 const watcher = new Smartwatch([
@@ -52,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}`);
@@ -73,15 +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 |
+| 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
 
@@ -108,7 +110,7 @@ await watcher.stop();
 ### Complete Example
 
 ```typescript
-import { Smartwatch } from '@push.rocks/smartchok';
+import { Smartwatch } from '@push.rocks/smartwatch';
 
 async function watchProject() {
   // Initialize with patterns
@@ -153,29 +155,38 @@ watchProject();
 
 ## How It Works
 
-smartchok uses native file watching APIs for each runtime:
+smartwatch uses native file watching APIs for each runtime:
 
-| Runtime | API Used |
-|---------|----------|
-| **Node.js 20+** | `fs.watch({ recursive: true })` |
-| **Deno** | `Deno.watchFs()` |
-| **Bun** | Node.js compatibility layer |
+| Runtime         | API Used                         |
+|-----------------|----------------------------------|
+| **Node.js 20+** | `fs.watch({ recursive: true })`  |
+| **Deno**        | `Deno.watchFs()`                 |
+| **Bun**         | Node.js compatibility layer      |
 
-Since native APIs don't support glob patterns, smartchok handles pattern matching internally using [picomatch](https://github.com/micromatch/picomatch):
+### Under the Hood
 
-1. **Base path extraction** - Extracts the static base path from each glob pattern
-2. **Efficient watching** - Native watchers monitor the base directories
-3. **Pattern filtering** - Events are filtered through picomatch matchers before being emitted
+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
 
-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.
+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
 
-- **Node.js 20+** - Required for native recursive watching
-- **Deno** - Any version with `Deno.watchFs()` support
-- **Bun** - Uses Node.js compatibility
+| Runtime         | Version                                |
+|-----------------|----------------------------------------|
+| **Node.js**     | 20+ (required for native recursive watching) |
+| **Deno**        | Any version with `Deno.watchFs()` support |
+| **Bun**         | Uses Node.js compatibility             |
 
 ## API Reference
 
@@ -189,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.

ts/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
-  name: '@push.rocks/smartchok',
-  version: '4.0.0',
+  name: '@push.rocks/smartwatch',
+  version: '5.0.0',
   description: 'A cross-runtime file watcher with glob pattern support for Node.js, Deno, and Bun.'
 }