@eggjs/watcher 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,147 @@
+# @eggjs/watcher
+
+[![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/eggjs/egg-watcher/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-watcher/actions/workflows/nodejs.yml)
+[![Test coverage][codecov-image]][codecov-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/watcher.svg?style=flat)](https://nodejs.org/en/download/)
+
+[npm-image]: https://img.shields.io/npm/v/egg-watcher.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-watcher
+[codecov-image]: https://codecov.io/github/eggjs/egg-watcher/coverage.svg?branch=master
+[codecov-url]: https://codecov.io/github/eggjs/egg-watcher?branch=master
+[snyk-image]: https://snyk.io/test/npm/egg-watcher/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-watcher
+[download-image]: https://img.shields.io/npm/dm/egg-watcher.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-watcher
+
+File watcher plugin for egg
+
+## Usage
+
+In worker process:
+
+### app.watcher.watch(path, listener)
+
+Start watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+### app.watcher.unwatch(path[, listener])
+
+Stop watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+In agent process:
+
+### agent.watcher.watch(path, listener)
+
+Start watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+### agent.watcher.unwatch(path[, listener])
+
+Stop watching file(s).
+
+- path(String|Array): file path(s)
+- listener(Function): file change callback
+
+## Watching mode
+
+### `development` Mode
+
+There's a built-in [development mode](https://github.com/eggjs/egg-watcher/blob/master/src/lib/event-sources/development.ts) which works in local(env is `local`). Once files on disk is modified it will emit a `change` event immediately.
+
+### Customize Watching Mode
+
+Say we want to build a custom event source plugin (package name: `egg-watcher-custom`, eggPlugin.name: `watcherCustom`).
+
+Firstly define our custom event source like this:
+
+```ts
+// {plugin_root}/lib/custom_event_source.js
+import { Base } from 'sdk-base';
+
+export default class CustomEventSource extends Base {
+  // `opts` comes from app.config[${eventSourceName}]
+  // `eventSourceName` will be registered later in
+  // `config.watcher.eventSources` as the key shown below
+  constructor(opts) {
+    super(opts);
+    this.ready(true);
+  }
+
+  watch(path) {
+    // replace this with your desired way of watching,
+    // when aware of any change, emit a `change` event
+    // with an info object containing `path` property
+    // specifying the changed directory or file.
+    this._h = setInterval(() => {
+      this.emit('change', { path });
+    }, 1000);
+  }
+
+  unwatch() {
+    // replace this with your implementation
+    if (this._h) {
+      clearInterval(this._h);
+    }
+  }
+}
+```
+
+Event source implementations varies according to your running environment. When working with vagrant, docker, samba or such other non-standard way of development, you should use a different watch API specific to what you are working with.
+
+Then add your custom event source to config:
+
+```js
+// config/config.default.js
+import CustomEventSource from '../lib/custom_event_source';
+
+export default {
+  watcher: {
+    eventSources: {
+      custom: CustomEventSource,
+    },
+  },
+};
+```
+
+Choose to use your custom watching mode in your desired env.
+
+```js
+// config/config.${env}.js
+
+export default {
+  watcher: {
+    type: 'custom',
+  },
+
+  // this will pass to your CustomEventSource constructor as opts
+  watcherCustom: {
+    // foo: 'bar',
+  },
+};
+```
+
+If possible, plugins named like `egg-watcher-${customName}`(`egg-watcher-vagrant` eg.) are recommended.
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-watcher)](https://github.com/eggjs/egg-watcher/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/agent.d.ts

@@ -0,0 +1,2 @@
+import { Boot } from './lib/boot.js';
+export default Boot;

package/dist/commonjs/agent.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const boot_js_1 = require("./lib/boot.js");
+exports.default = boot_js_1.Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSwyQ0FBcUM7QUFFckMsa0JBQWUsY0FBSSxDQUFDIn0=

package/dist/commonjs/app.d.ts

@@ -0,0 +1,2 @@
+import { Boot } from './lib/boot.js';
+export default Boot;

package/dist/commonjs/app.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const boot_js_1 = require("./lib/boot.js");
+exports.default = boot_js_1.Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJDQUFxQztBQUVyQyxrQkFBZSxjQUFJLENBQUMifQ==

package/dist/commonjs/config/config.default.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    /**
+     * watcher options
+     * @member Config#watcher
+     * @property {string} type - event source type
+     */
+    watcher: {
+        type: string;
+        eventSources: {
+            default: string;
+            development: string;
+        };
+    };
+};
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+const utils_js_1 = require("../lib/utils.js");
+exports.default = {
+    /**
+     * watcher options
+     * @member Config#watcher
+     * @property {string} type - event source type
+     */
+    watcher: {
+        type: 'default', // default event source
+        eventSources: {
+            default: node_path_1.default.join((0, utils_js_1.getSourceDirname)(), 'lib', 'event-sources', 'default'),
+            development: node_path_1.default.join((0, utils_js_1.getSourceDirname)(), 'lib', 'event-sources', 'development'),
+        },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsMERBQTZCO0FBQzdCLDhDQUFtRDtBQUVuRCxrQkFBZTtJQUNiOzs7O09BSUc7SUFDSCxPQUFPLEVBQUU7UUFDUCxJQUFJLEVBQUUsU0FBUyxFQUFFLHVCQUF1QjtRQUN4QyxZQUFZLEVBQUU7WUFDWixPQUFPLEVBQUUsbUJBQUksQ0FBQyxJQUFJLENBQUMsSUFBQSwyQkFBZ0IsR0FBRSxFQUFFLEtBQUssRUFBRSxlQUFlLEVBQUUsU0FBUyxDQUFDO1lBQ3pFLFdBQVcsRUFBRSxtQkFBSSxDQUFDLElBQUksQ0FBQyxJQUFBLDJCQUFnQixHQUFFLEVBQUUsS0FBSyxFQUFFLGVBQWUsRUFBRSxhQUFhLENBQUM7U0FDbEY7S0FDRjtDQUNGLENBQUMifQ==

package/dist/commonjs/config/config.local.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    watcher: {
+        type: string;
+    };
+};
+export default _default;

package/dist/commonjs/config/config.local.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    watcher: {
+        type: 'development',
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmxvY2FsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcubG9jYWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxrQkFBZTtJQUNiLE9BQU8sRUFBRTtRQUNQLElBQUksRUFBRSxhQUFhO0tBQ3BCO0NBQ0YsQ0FBQyJ9

package/dist/commonjs/config/config.unittest.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    watcher: {
+        type: string;
+    };
+};
+export default _default;

package/dist/commonjs/config/config.unittest.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    watcher: {
+        type: 'development',
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLnVuaXR0ZXN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcudW5pdHRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxrQkFBZTtJQUNiLE9BQU8sRUFBRTtRQUNQLElBQUksRUFBRSxhQUFhO0tBQ3BCO0NBQ0YsQ0FBQyJ9

package/dist/commonjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/types.js';
+export * from './lib/watcher.js';
+export * from './lib/event-sources/index.js';

package/dist/commonjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./lib/types.js"), exports);
+__exportStar(require("./lib/watcher.js"), exports);
+__exportStar(require("./lib/event-sources/index.js"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlEQUErQjtBQUMvQixtREFBaUM7QUFDakMsK0RBQTZDIn0=

package/dist/commonjs/lib/boot.d.ts

@@ -0,0 +1,6 @@
+import type { Application, Agent, ILifecycleBoot } from 'egg';
+export declare class Boot implements ILifecycleBoot {
+    #private;
+    constructor(appOrAgent: Application | Agent);
+    didLoad(): Promise<void>;
+}

package/dist/commonjs/lib/boot.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Boot = void 0;
+const watcher_js_1 = require("./watcher.js");
+class Boot {
+    #app;
+    #watcher;
+    constructor(appOrAgent) {
+        this.#app = appOrAgent;
+        this.#watcher = this.#app.watcher = this.#app.cluster(watcher_js_1.Watcher, {})
+            .delegate('watch', 'subscribe')
+            .create(appOrAgent.config)
+            .on('info', (msg, ...args) => this.#app.coreLogger.info(msg, ...args))
+            .on('warn', (msg, ...args) => this.#app.coreLogger.warn(msg, ...args))
+            .on('error', (msg, ...args) => this.#app.coreLogger.error(msg, ...args));
+    }
+    async didLoad() {
+        await this.#watcher.ready();
+        this.#app.coreLogger.info('[@eggjs/watcher:%s] watcher start success', this.#app.type);
+    }
+}
+exports.Boot = Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYm9vdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvYm9vdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSw2Q0FBdUM7QUFFdkMsTUFBYSxJQUFJO0lBQ2YsSUFBSSxDQUFzQjtJQUMxQixRQUFRLENBQVU7SUFFbEIsWUFBWSxVQUErQjtRQUN6QyxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQztRQUN2QixJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLG9CQUFPLEVBQUUsRUFBRSxDQUFDO2FBQy9ELFFBQVEsQ0FBQyxPQUFPLEVBQUUsV0FBVyxDQUFDO2FBQzlCLE1BQU0sQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDO2FBQ3pCLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxHQUFXLEVBQUUsR0FBRyxJQUFXLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQzthQUNwRixFQUFFLENBQUMsTUFBTSxFQUFFLENBQUMsR0FBVyxFQUFFLEdBQUcsSUFBVyxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7YUFDcEYsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLEdBQVcsRUFBRSxHQUFHLElBQVcsRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDLENBQUM7SUFDNUYsQ0FBQztJQUVELEtBQUssQ0FBQyxPQUFPO1FBQ1gsTUFBTSxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzVCLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQywyQ0FBMkMsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3pGLENBQUM7Q0FDRjtBQWxCRCxvQkFrQkMifQ==

package/dist/commonjs/lib/event-sources/base.d.ts

@@ -0,0 +1,5 @@
+import { Base } from 'sdk-base';
+export declare abstract class BaseEventSource extends Base {
+    abstract watch(file: string): void;
+    abstract unwatch(file: string): void;
+}

package/dist/commonjs/lib/event-sources/base.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEventSource = void 0;
+const sdk_base_1 = require("sdk-base");
+class BaseEventSource extends sdk_base_1.Base {
+}
+exports.BaseEventSource = BaseEventSource;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvZXZlbnQtc291cmNlcy9iYXNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHVDQUFnQztBQUVoQyxNQUFzQixlQUFnQixTQUFRLGVBQUk7Q0FHakQ7QUFIRCwwQ0FHQyJ9

package/dist/commonjs/lib/event-sources/default.d.ts

@@ -0,0 +1,6 @@
+import { BaseEventSource } from './base.js';
+export default class DefaultEventSource extends BaseEventSource {
+    constructor();
+    watch(): void;
+    unwatch(): void;
+}

package/dist/commonjs/lib/event-sources/default.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const base_js_1 = require("./base.js");
+class DefaultEventSource extends base_js_1.BaseEventSource {
+    constructor() {
+        super();
+        // delay emit so that can be listened
+        setImmediate(() => this.emit('info', '[@eggjs/watcher] defaultEventSource watcher will NOT take effect'));
+        this.ready(true);
+    }
+    watch() {
+        this.emit('info', '[@eggjs/watcher] using defaultEventSource watcher.watch() does NOTHING');
+    }
+    unwatch() {
+        this.emit('info', '[@eggjs/watcher] using defaultEventSource watcher.unwatch() does NOTHING');
+    }
+}
+exports.default = DefaultEventSource;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVmYXVsdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvZXZlbnQtc291cmNlcy9kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsdUNBQTRDO0FBRTVDLE1BQXFCLGtCQUFtQixTQUFRLHlCQUFlO0lBQzdEO1FBQ0UsS0FBSyxFQUFFLENBQUM7UUFDUixxQ0FBcUM7UUFDckMsWUFBWSxDQUFDLEdBQUcsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLGtFQUFrRSxDQUFDLENBQUMsQ0FBQztRQUMxRyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ25CLENBQUM7SUFFRCxLQUFLO1FBQ0gsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsd0VBQXdFLENBQUMsQ0FBQztJQUM5RixDQUFDO0lBRUQsT0FBTztRQUNMLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLDBFQUEwRSxDQUFDLENBQUM7SUFDaEcsQ0FBQztDQUNGO0FBZkQscUNBZUMifQ==

package/dist/commonjs/lib/event-sources/development.d.ts

@@ -0,0 +1,7 @@
+import { BaseEventSource } from './base.js';
+export default class DevelopmentEventSource extends BaseEventSource {
+    #private;
+    constructor();
+    watch(file: string): void;
+    unwatch(file: string): void;
+}

package/dist/commonjs/lib/event-sources/development.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_util_1 = require("node:util");
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const base_js_1 = require("./base.js");
+const debug = (0, node_util_1.debuglog)('@eggjs/watcher/lib/event-sources/development');
+// only used by local dev environment
+class DevelopmentEventSource extends base_js_1.BaseEventSource {
+    #fileWatching = new Map();
+    constructor() {
+        super();
+        this.ready(true);
+    }
+    watch(file) {
+        try {
+            const stat = node_fs_1.default.statSync(file, { throwIfNoEntry: false });
+            if (!stat) {
+                debug('watch %o ignore, file not exists', file);
+                return;
+            }
+            debug('watch %o, isFile: %o', file, stat.isFile());
+            // https://nodejs.org/docs/latest/api/fs.html#fswatchfilename-options-listener
+            let recursive = true;
+            if (process.platform === 'linux' && process.version.startsWith('v18.')) {
+                // https://github.com/fgnass/filewatcher/pull/6
+                // disable recursive on linux + Node.js <= 18
+                recursive = false;
+            }
+            const handler = node_fs_1.default.watch(file, {
+                persistent: true,
+                recursive,
+            }, (event, filename) => {
+                debug('watch %o => event: %o, filename: %o', file, event, filename);
+                let changePath = file;
+                if (stat.isFile()) {
+                    this.#onFsWatchChange(event, changePath);
+                }
+                else {
+                    // dir
+                    if (filename) {
+                        changePath = node_path_1.default.join(file, filename);
+                    }
+                    this.#onFsWatchChange(event, changePath);
+                }
+            });
+            // 保存 handler，用于解除监听
+            this.#fileWatching.set(file, handler);
+        }
+        catch (e) {
+            // file not exist, do nothing
+            // do not emit error, in case of too many logs
+            this.emit('warn', '[@eggjs/watcher:DevelopmentEventSource] watch %o error: %s', file, e);
+        }
+    }
+    unwatch(file) {
+        if (!file)
+            return;
+        const h = this.#fileWatching.get(file);
+        if (!h)
+            return;
+        // fs.watch 文件监听
+        h.removeAllListeners();
+        h.close();
+        this.#fileWatching.delete(file);
+    }
+    #onFsWatchChange(event, file) {
+        if (!file) {
+            this.emit('warn', '[@eggjs/watcher:DevelopmentEventSource] event: %o', event);
+            return;
+        }
+        // { event: 'change',
+        // path: '/Users/mk2/git/changing/test/fixtures/foo.js',
+        // stat:
+        //  { dev: 16777220,
+        //    mode: 33188,
+        //    nlink: 1,
+        //    uid: 501,
+        //    gid: 20,
+        //    rdev: 0,
+        //    blksize: 4096,
+        //    ino: 72656587,
+        //    size: 11,
+        //    blocks: 8,
+        //    atime: Wed Jun 17 2015 00:08:11 GMT+0800 (CST),
+        //    mtime: Wed Jun 17 2015 00:08:38 GMT+0800 (CST),
+        //    ctime: Wed Jun 17 2015 00:08:38 GMT+0800 (CST),
+        //    birthtime: Tue Jun 16 2015 23:19:13 GMT+0800 (CST) } }
+        const info = {
+            path: file,
+            event,
+            stat: node_fs_1.default.statSync(file, { throwIfNoEntry: false }),
+        };
+        this.emit('change', info);
+    }
+}
+exports.default = DevelopmentEventSource;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGV2ZWxvcG1lbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50LXNvdXJjZXMvZGV2ZWxvcG1lbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSx5Q0FBcUM7QUFDckMsMERBQTZCO0FBQzdCLHNEQUF3RDtBQUN4RCx1Q0FBNEM7QUFHNUMsTUFBTSxLQUFLLEdBQUcsSUFBQSxvQkFBUSxFQUFDLDhDQUE4QyxDQUFDLENBQUM7QUFFdkUscUNBQXFDO0FBQ3JDLE1BQXFCLHNCQUF1QixTQUFRLHlCQUFlO0lBQ2pFLGFBQWEsR0FBRyxJQUFJLEdBQUcsRUFBcUIsQ0FBQztJQUU3QztRQUNFLEtBQUssRUFBRSxDQUFDO1FBQ1IsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNuQixDQUFDO0lBRUQsS0FBSyxDQUFDLElBQVk7UUFDaEIsSUFBSSxDQUFDO1lBQ0gsTUFBTSxJQUFJLEdBQUcsaUJBQUUsQ0FBQyxRQUFRLENBQUMsSUFBSSxFQUFFLEVBQUUsY0FBYyxFQUFFLEtBQUssRUFBRSxDQUFDLENBQUM7WUFDMUQsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO2dCQUNWLEtBQUssQ0FBQyxrQ0FBa0MsRUFBRSxJQUFJLENBQUMsQ0FBQztnQkFDaEQsT0FBTztZQUNULENBQUM7WUFDRCxLQUFLLENBQUMsc0JBQXNCLEVBQUUsSUFBSSxFQUFFLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDO1lBQ25ELDhFQUE4RTtZQUM5RSxJQUFJLFNBQVMsR0FBRyxJQUFJLENBQUM7WUFDckIsSUFBSSxPQUFPLENBQUMsUUFBUSxLQUFLLE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO2dCQUN2RSwrQ0FBK0M7Z0JBQy9DLDZDQUE2QztnQkFDN0MsU0FBUyxHQUFHLEtBQUssQ0FBQztZQUNwQixDQUFDO1lBQ0QsTUFBTSxPQUFPLEdBQUcsaUJBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFO2dCQUM3QixVQUFVLEVBQUUsSUFBSTtnQkFDaEIsU0FBUzthQUNWLEVBQUUsQ0FBQyxLQUFLLEVBQUUsUUFBUSxFQUFFLEVBQUU7Z0JBQ3JCLEtBQUssQ0FBQyxxQ0FBcUMsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLFFBQVEsQ0FBQyxDQUFDO2dCQUNwRSxJQUFJLFVBQVUsR0FBRyxJQUFJLENBQUM7Z0JBQ3RCLElBQUksSUFBSSxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUM7b0JBQ2xCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLENBQUM7Z0JBQzNDLENBQUM7cUJBQU0sQ0FBQztvQkFDTixNQUFNO29CQUNOLElBQUksUUFBUSxFQUFFLENBQUM7d0JBQ2IsVUFBVSxHQUFHLG1CQUFJLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxRQUFRLENBQUMsQ0FBQztvQkFDekMsQ0FBQztvQkFDRCxJQUFJLENBQUMsZ0JBQWdCLENBQUMsS0FBSyxFQUFFLFVBQVUsQ0FBQyxDQUFDO2dCQUMzQyxDQUFDO1lBQ0gsQ0FBQyxDQUFDLENBQUM7WUFDSCxvQkFBb0I7WUFDcEIsSUFBSSxDQUFDLGFBQWEsQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBQ3hDLENBQUM7UUFBQyxPQUFPLENBQUMsRUFBRSxDQUFDO1lBQ1gsNkJBQTZCO1lBQzdCLDhDQUE4QztZQUM5QyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSw0REFBNEQsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDM0YsQ0FBQztJQUNILENBQUM7SUFFRCxPQUFPLENBQUMsSUFBWTtRQUNsQixJQUFJLENBQUMsSUFBSTtZQUFFLE9BQU87UUFFbEIsTUFBTSxDQUFDLEdBQUcsSUFBSSxDQUFDLGFBQWEsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDdkMsSUFBSSxDQUFDLENBQUM7WUFBRSxPQUFPO1FBRWYsZ0JBQWdCO1FBQ2hCLENBQUMsQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3ZCLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUNWLElBQUksQ0FBQyxhQUFhLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2xDLENBQUM7SUFFRCxnQkFBZ0IsQ0FBQyxLQUFxQixFQUFFLElBQVk7UUFDbEQsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO1lBQ1YsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsbURBQW1ELEVBQUUsS0FBSyxDQUFDLENBQUM7WUFDOUUsT0FBTztRQUNULENBQUM7UUFDRCxxQkFBcUI7UUFDckIsd0RBQXdEO1FBQ3hELFFBQVE7UUFDUixvQkFBb0I7UUFDcEIsa0JBQWtCO1FBQ2xCLGVBQWU7UUFDZixlQUFlO1FBQ2YsY0FBYztRQUNkLGNBQWM7UUFDZCxvQkFBb0I7UUFDcEIsb0JBQW9CO1FBQ3BCLGVBQWU7UUFDZixnQkFBZ0I7UUFDaEIscURBQXFEO1FBQ3JELHFEQUFxRDtRQUNyRCxxREFBcUQ7UUFDckQsNERBQTREO1FBQzVELE1BQU0sSUFBSSxHQUFHO1lBQ1gsSUFBSSxFQUFFLElBQUk7WUFDVixLQUFLO1lBQ0wsSUFBSSxFQUFFLGlCQUFFLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxFQUFFLGNBQWMsRUFBRSxLQUFLLEVBQUUsQ0FBQztTQUNyQyxDQUFDO1FBQ2hCLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzVCLENBQUM7Q0FDRjtBQXpGRCx5Q0F5RkMifQ==

package/dist/commonjs/lib/event-sources/index.d.ts

@@ -0,0 +1,3 @@
+export * from './base.js';
+export * from './default.js';
+export * from './development.js';

package/dist/commonjs/lib/event-sources/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base.js"), exports);
+__exportStar(require("./default.js"), exports);
+__exportStar(require("./development.js"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50LXNvdXJjZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLDRDQUEwQjtBQUMxQiwrQ0FBNkI7QUFDN0IsbURBQWlDIn0=

package/dist/commonjs/lib/types.d.ts

@@ -0,0 +1,33 @@
+import type { WatchEventType, Stats } from 'node:fs';
+import type { Watcher } from './watcher.js';
+export interface WatcherConfig {
+    watcher: {
+        type: string;
+        eventSources: Record<string, string>;
+    };
+    [key: string]: Record<string, any>;
+}
+export interface ChangeInfo {
+    event: WatchEventType;
+    /**
+     * file stat if path exists
+     */
+    stat?: Stats;
+    path: string;
+}
+declare module 'egg' {
+    interface EggWatcherAgent {
+        watcher: Watcher;
+    }
+    interface Agent extends EggWatcherAgent {
+    }
+    interface EggWatcherApplication {
+        watcher: Watcher;
+    }
+    interface Application extends EggWatcherApplication {
+    }
+    interface EggWatcherAppConfig extends WatcherConfig {
+    }
+    interface EggAppConfig extends EggWatcherAppConfig {
+    }
+}

package/dist/commonjs/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/dist/commonjs/lib/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function isEqualOrParentPath(parent: string, child: string): boolean;
+export declare function getSourceDirname(): string;

package/dist/commonjs/lib/utils.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEqualOrParentPath = isEqualOrParentPath;
+exports.getSourceDirname = getSourceDirname;
+const node_path_1 = __importDefault(require("node:path"));
+const node_url_1 = require("node:url");
+// judge if parent is child's parent path
+// isEqualOrParentPath('/foo', '/foo/bar') => true
+// isEqualOrParentPath('/foo/bar', '/foo') => false
+function isEqualOrParentPath(parent, child) {
+    return !node_path_1.default.relative(parent, child).startsWith('..');
+}
+function getSourceDirname() {
+    if (typeof __dirname === 'string') {
+        return node_path_1.default.dirname(__dirname);
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    const __filename = (0, node_url_1.fileURLToPath)('import_meta_url_placeholder_by_tshy_after');
+    return node_path_1.default.dirname(node_path_1.default.dirname(__filename));
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBTUEsa0RBRUM7QUFFRCw0Q0FTQztBQW5CRCwwREFBNkI7QUFDN0IsdUNBQXlDO0FBRXpDLHlDQUF5QztBQUN6QyxrREFBa0Q7QUFDbEQsbURBQW1EO0FBQ25ELFNBQWdCLG1CQUFtQixDQUFDLE1BQWMsRUFBRSxLQUFhO0lBQy9ELE9BQU8sQ0FBQyxtQkFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEVBQUUsS0FBSyxDQUFDLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDO0FBQ3hELENBQUM7QUFFRCxTQUFnQixnQkFBZ0I7SUFDOUIsSUFBSSxPQUFPLFNBQVMsS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUNsQyxPQUFPLG1CQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFFRCw2REFBNkQ7SUFDN0QsYUFBYTtJQUNiLE1BQU0sVUFBVSxHQUFHLElBQUEsd0JBQWEsRUFBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2xELE9BQU8sbUJBQUksQ0FBQyxPQUFPLENBQUMsbUJBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztBQUNoRCxDQUFDIn0=

package/dist/commonjs/lib/watcher.d.ts

@@ -0,0 +1,9 @@
+import { Base } from 'sdk-base';
+import type { ChangeInfo, WatcherConfig } from './types.js';
+export type WatchListener = (info: ChangeInfo) => void;
+export declare class Watcher extends Base {
+    #private;
+    constructor(config: WatcherConfig);
+    protected _init(): Promise<void>;
+    watch(path: string | string[], listener: WatchListener): void;
+}