kerria 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,17 @@
+# Kerria
+
+[![version](https://img.shields.io/npm/v/kerria?color=FFEF78&labelColor=E48748&label=npm)](https://www.npmjs.com/package/kerria)
+[![downloads](https://img.shields.io/npm/dm/kerria?color=FFEF78&labelColor=E48748&label=downloads)](https://www.npmjs.com/package/kerria)
+[![license](https://img.shields.io/npm/l/kerria?color=FFEF78&labelColor=E48748&label=license)](/LICENSE)
+
+这是一个渲染无关的文件处理管线。核心思路是将数据分为源数据（Source）与负载数据（Load）两类，源拥有以文件为单位的构建与监听生命周期，负载从源中派生，并在每一次源（或本身所依赖的初始状态）文件发生变化时输出。
+
+## 安装
+
+```shell
+pnpm i kerria
+```
+
+## 使用方式
+
+请参考[示例文件](playground/kerria.config.ts)。

package/dist/index.cjs

@@ -48,6 +48,9 @@ var import_tinyglobby = require("tinyglobby");
 
 // src/utils.ts
 var isDev = process.env.NODE_ENV === "development";
+function capitalize(str) {
+  return str[0].toUpperCase() + str.slice(1);
+}
 
 // src/core/processor.ts
 var currentContext = null;
@@ -101,7 +104,7 @@ function createProcessor(sign, setup) {
           return false;
         }
         outputLoads();
-        import_consola.default.success(`[${sign}] ${event} "${path}"`);
+        import_consola.default.success(`[${sign}] ${capitalize(event)} "${path}"`);
       });
     }
     for (const info of ctx.loadInfos) {
@@ -112,7 +115,7 @@ function createProcessor(sign, setup) {
         ignoreInitial: true
       }).on("change", async () => {
         const newVal = await import_fs_extra.default.readJson(info.src);
-        info.value = info.onUpdate(newVal, info.value);
+        info.value = info.onUpdate?.(newVal, info.value) ?? newVal;
         info.output();
         import_consola.default.success(`[${sign}] Change "${info.src}"`);
       });
@@ -176,7 +179,7 @@ function useLoad(name, options) {
   const src = options.src ? (0, import_pathe2.resolve)(options.src) : void 0;
   const out = (0, import_pathe2.resolve)(options.out);
   const {
-    defaultValue,
+    defaultValue = {},
     onUpdate,
     beforeOutput
   } = options;
@@ -184,15 +187,15 @@ function useLoad(name, options) {
     name,
     src,
     out,
-    value: src ? import_fs_extra2.default.readJsonSync(src) : defaultValue ?? {},
+    value: src ? import_fs_extra2.default.readJsonSync(src) : defaultValue,
+    onUpdate,
     output() {
       const data = beforeOutput?.(info.value) ?? info.value;
-      import_fs_extra2.default.outputJsonSync(info.out, data);
-    },
-    onUpdate
+      import_fs_extra2.default.outputJsonSync(out, data);
+    }
   };
   ctx.loadInfos.push(info);
-  onUpdate(info.value, void 0);
+  onUpdate?.(info.value, void 0);
   return info;
 }
 

package/dist/index.d.cts

@@ -7,7 +7,7 @@ interface UseLoadOptions {
     src?: string;
     out: string;
     defaultValue?: unknown;
-    onUpdate: (newVal: any, oldVal: any) => any;
+    onUpdate?: (newVal: any, oldVal: any) => any;
     beforeOutput?: (val: any) => any;
 }
 declare function useLoad(name: string, options: UseLoadOptions): LoadInfo;

package/dist/index.d.ts

@@ -7,7 +7,7 @@ interface UseLoadOptions {
     src?: string;
     out: string;
     defaultValue?: unknown;
-    onUpdate: (newVal: any, oldVal: any) => any;
+    onUpdate?: (newVal: any, oldVal: any) => any;
     beforeOutput?: (val: any) => any;
 }
 declare function useLoad(name: string, options: UseLoadOptions): LoadInfo;

package/dist/index.js

@@ -9,6 +9,9 @@ import { glob } from "tinyglobby";
 
 // src/utils.ts
 var isDev = process.env.NODE_ENV === "development";
+function capitalize(str) {
+  return str[0].toUpperCase() + str.slice(1);
+}
 
 // src/core/processor.ts
 var currentContext = null;
@@ -62,7 +65,7 @@ function createProcessor(sign, setup) {
           return false;
         }
         outputLoads();
-        consola.success(`[${sign}] ${event} "${path}"`);
+        consola.success(`[${sign}] ${capitalize(event)} "${path}"`);
       });
     }
     for (const info of ctx.loadInfos) {
@@ -73,7 +76,7 @@ function createProcessor(sign, setup) {
         ignoreInitial: true
       }).on("change", async () => {
         const newVal = await fs.readJson(info.src);
-        info.value = info.onUpdate(newVal, info.value);
+        info.value = info.onUpdate?.(newVal, info.value) ?? newVal;
         info.output();
         consola.success(`[${sign}] Change "${info.src}"`);
       });
@@ -137,7 +140,7 @@ function useLoad(name, options) {
   const src = options.src ? resolve(options.src) : void 0;
   const out = resolve(options.out);
   const {
-    defaultValue,
+    defaultValue = {},
     onUpdate,
     beforeOutput
   } = options;
@@ -145,15 +148,15 @@ function useLoad(name, options) {
     name,
     src,
     out,
-    value: src ? fs2.readJsonSync(src) : defaultValue ?? {},
+    value: src ? fs2.readJsonSync(src) : defaultValue,
+    onUpdate,
     output() {
       const data = beforeOutput?.(info.value) ?? info.value;
-      fs2.outputJsonSync(info.out, data);
-    },
-    onUpdate
+      fs2.outputJsonSync(out, data);
+    }
   };
   ctx.loadInfos.push(info);
-  onUpdate(info.value, void 0);
+  onUpdate?.(info.value, void 0);
   return info;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kerria",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "",
   "author": "KazariEX",
   "license": "MIT",
@@ -35,7 +35,6 @@
   "scripts": {
     "build": "tsup-node",
     "dev": "tsup-node --watch",
-    "release": "bumpp --no-push -c \"release: v%s\"",
-    "test": "vitest"
+    "release": "bumpp --no-push -c \"release: v%s\""
   }
 }