@1-/scan 0.1.5 → 0.1.6

package/README.md

@@ -9,10 +9,10 @@ Incrementally scans directory files, compares file sizes and modification times
 
 ## Features
 
-- **Incremental Scanning**: Processes only new, modified, or deleted files, avoiding redundant file system operations.
+- **Incremental Scanning**: Compares file sizes and modification times to process only new, modified, or deleted files, avoiding redundant read/write operations.
 - **Key Optimization**: Stores relative paths within 16 bytes directly as raw bytes; hashes longer paths to 16-byte MD5 digests to optimize database index space and query performance.
 - **Metadata Compression**: Compresses file sizes and modification times using Varint (variable-length byte) encoding.
-- **Transactional Integrity**: Packages updates and deletions in database transactions to guarantee consistency.
+- **Transactional Integrity**: Performs updates and deletions within database transactions to guarantee consistency.
 - **File Filtering**: Supports custom ignore callback functions to filter files and directories.
 - **Native Database**: Integrates Bun native `bun:sqlite` module, eliminating external database driver dependencies.
 
@@ -58,6 +58,7 @@ using _upsert = upsert;
 
 console.log("Synced. Updated files:", updated_paths);
 
+// Update scanned file metadata in database
 for (const rel_path of updated_paths) {
   await upsert(rel_path);
 }
@@ -72,15 +73,7 @@ import sqlite from "@1-/scan/sqlite.js";
 const db = sqlite("./scan_record.db");
 
 // Bulk update and delete metadata
-save(
-  db,
-  [
-    ["file.txt", new Uint8Array([1, 2, 3]), 123, 1620000000]
-  ],
-  [
-    new Uint8Array([4, 5, 6])
-  ]
-);
+save(db, [["file.txt", new Uint8Array([1, 2, 3]), 123, 1620000000]], [new Uint8Array([4, 5, 6])]);
 
 db.close();
 ```
@@ -89,16 +82,7 @@ db.close();
 
 The main entry orchestrates independent modules to execute the incremental scanning and synchronization flow.
 
-```mermaid
-graph TD
-    Entry["_.js (Entry Point)"] -->|1. Initialize Connection| Sqlite["sqlite.js"]
-    Entry -->|2. Load Existing Records| Load["load.js"]
-    Entry -->|3. Walk & Compare Files| DirWalk["dirWalk.js"]
-    DirWalk -->|Invoke| Walk["@1-/walk/walkRelIgnore"]
-    DirWalk -->|Process Path Keys| Hash["hash.js"]
-    Entry -->|4. Delete Absent & Return Upsert| Trans["trans.js"]
-    Save["save.js (Independent Sync Helper)"] -->|Transaction Wrapper| Trans
-```
+![](https://i-01.eu.org/KDY9Lax79XwPBKztEqhU5A)
 
 1. **Initialize Connection (`sqlite.js`)**: Opens SQLite database connection and configures automatic connection disposal.
 2. **Load Records (`load.js`)**: Automatically creates `scanMtimeLen` table if missing, retrieves existing file hashes, sizes, and modification times, and reconstructs reference set in memory.
@@ -114,7 +98,7 @@ graph TD
 - **@3-/vb**: Variable-length byte (Varint) encoder and decoder.
 - **@3-/binmap / @3-/binset**: Memory-efficient collections designed for binary keys.
 
-## Directory Structure
+## Code Structure
 
 ```
 .
@@ -134,23 +118,27 @@ graph TD
 SQLite was created by D. Richard Hipp in 2000 while designing board software for US Navy guided-missile destroyers. The system originally depended on a commercial database that required constant database administration; a connection loss could stall the entire damage control application. To resolve this vulnerability, Hipp designed a serverless, zero-configuration embedded database that directly reads and writes local files—marking the birth of SQLite.
 
 To conserve disk space and reduce I/O overhead, SQLite utilizes Varint (variable-length integer) encoding for metadata storage. Under this scheme, small integers consume only 1 byte, while larger numbers scale dynamically. This library inherits that design philosophy, compressing file metadata into varints before storing it, ensuring minimal footprint and high sync performance.
-../doc/en/about.md
+## About
+
+This library is developed by [WebC.site](https://webc.site).
+
+[WebC.site](https://webc.site): A new paradigm of web development for AI
 
 ---
 
 <a id="zh"></a>
 # @1-/scan : 增量扫描目录文件并使用 SQLite 记录元数据
 
-增量扫描目录文件，比对大小与修改时间以检测变更，同步元数据至 SQLite 数据库，返回发生变更之相对路径列表。
+增量扫描目录文件，通过比对大小与修改时间检测变更，同步元数据至 SQLite 数据库，返回发生变更之相对路径列表。
 
 ## 功能介绍
 
-- **增量扫描**：处理新增、修改或删除之文件，避免冗余文件系统读写，提升同步效率。
-- **路径压缩**：相对路径长度不大于 16 字节时保留原始字节；超出 16 字节则转换为 16 字节 MD5 值作为主键，优化索引空间与查询性能。
+- **增量扫描**：比对文件大小与修改时间，仅对新增、修改或删除之文件执行操作，避免冗余读写，提升效率。
+- **路径压缩**：当相对路径长度不大于 16 字节时保留原始字节；超出 16 字节则转换为 16 字节 MD5 值作为主键，优化索引空间与查询性能。
 - **元数据压缩**：使用 Varint（可变字节整型）编码方式压缩存储文件大小与修改时间。
-- **事务安全**：将更新与删除操作合并在数据库事务中执行，确保数据一致性。
-- **文件过滤**：支持自定义过滤函数以排除特定文件与目录。
-- **原生依赖**：基于 Bun 内置 `bun:sqlite` 模块，免去安装与编译数据库驱动步骤。
+- **事务安全**：更新与删除操作合并在数据库事务中执行，确保数据一致性。
+- **过滤规则**：支持传入自定义过滤函数，按需排除特定文件与目录。
+- **原生依赖**：基于 Bun 内置 `bun:sqlite` 模块，无需额外安装或编译数据库驱动。
 
 ## 使用演示
 
@@ -208,15 +196,7 @@ import sqlite from "@1-/scan/sqlite.js";
 const db = sqlite("./scan_record.db");
 
 // 批量更新与删除元数据
-save(
-  db,
-  [
-    ["file.txt", new Uint8Array([1, 2, 3]), 123, 1620000000]
-  ],
-  [
-    new Uint8Array([4, 5, 6])
-  ]
-);
+save(db, [["file.txt", new Uint8Array([1, 2, 3]), 123, 1620000000]], [new Uint8Array([4, 5, 6])]);
 
 db.close();
 ```
@@ -225,16 +205,7 @@ db.close();
 
 系统主入口调度各独立模块完成增量扫描与数据同步。
 
-```mermaid
-graph TD
-    Entry["_.js (主入口)"] -->|1. 初始化连接| Sqlite["sqlite.js"]
-    Entry -->|2. 加载已有记录| Load["load.js"]
-    Entry -->|3. 扫描文件系统并对比| DirWalk["dirWalk.js"]
-    DirWalk -->|调用| Walk["@1-/walk/walkRelIgnore"]
-    DirWalk -->|处理路径键| Hash["hash.js"]
-    Entry -->|4. 删除失效记录并返回更新函数| Trans["trans.js"]
-    Save["save.js (独立批量存储模块)"] -->|事务保障| Trans
-```
+![](https://i-01.eu.org/o9xJHQ8BDxiBtfjhCcTUtQ)
 
 1. **初始化连接 (`sqlite.js`)**：打开 SQLite 数据库，并配置自动释放连接机制。
 2. **加载记录 (`load.js`)**：若数据表 `scanMtimeLen` 不存在则自动创建，读取已记录的文件哈希、大小及修改时间，在内存中还原比对集合。
@@ -250,7 +221,7 @@ graph TD
 - **@3-/vb**：Varint（可变字节）编码与解码器。
 - **@3-/binmap / @3-/binset**：针对二进制键优化的 Map 和 Set 容器。
 
-## 目录结构
+## 代码结构
 
 ```
 .
@@ -270,4 +241,8 @@ graph TD
 SQLite 的诞生源自海军军工项目。2000 年，D. Richard Hipp 为美国海军陆战队设计导弹驱逐舰板载损害控制软件时，遭遇商业数据库因配置复杂、日常维护繁琐且连接丢失即导致系统瘫痪之痛点。Hipp 随后设计出免服务器配置、直接读写本地文件之嵌入式数据库，即 SQLite。
 
 为了节省磁盘空间与降低读写延迟，SQLite 广泛应用了 Varint（可变字节整型）编码。在这种编码下，数值较小的整数仅占用 1 字节，只有大数值才会占用更多字节。本项目中对文件大小和修改时间采用同样的压缩设计，秉承了 SQLite 节省空间与高效之设计哲学。
-../doc/zh/about.md
+## 关于
+
+本库由 [WebC.site](https://webc.site) 开发。
+
+[WebC.site](https://webc.site) : 面向人工智能的网站开发新范式

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@1-/scan",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Incrementally scan directory files and track metadata in SQLite / 增量扫描目录文件并使用 SQLite 记录元数据",
   "keywords": [
-    "scan",
-    "incremental",
-    "sqlite",
     "directory",
-    "metadata"
+    "incremental",
+    "metadata",
+    "scan",
+    "sqlite"
   ],
   "homepage": "https://github.com/webc-site/npm/tree/main/scan",
   "license": "MulanPSL-2.0",
@@ -22,7 +22,7 @@
     "./*": "./*"
   },
   "dependencies": {
-    "@1-/walk": "^0.1.0",
+    "@1-/walk": "^0.1.1",
     "@3-/binmap": "^0.1.20",
     "@3-/binset": "^0.1.6",
     "@3-/int": "^0.1.1",