There's a built-in development mode 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:
// {plugin_root}/lib/custom_event_source.jsconst Base = require('sdk-base');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'
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.
Choose to use your custom watching mode in your desired env.
// config.${env}.jsexports.watcher = { type: 'custom',};// this will pass to your CustomEventSource constructor as optsexports.watcherCustom = { // foo: 'bar',};
If possible, plugins named like egg-watcher-${customName}(egg-watcher-vagrant eg.) are recommended.