Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/catdad/electronmon

🖥 run, watch, and restart electron apps using magic
https://github.com/catdad/electronmon

cli electron hacktoberfest livereload monitor nodejs npm-package refresh watch watcher

Last synced: 2 months ago
JSON representation

🖥 run, watch, and restart electron apps using magic

Lists

README 

        
# electronmon



[![electronmon logo](https://cdn.jsdelivr.net/gh/catdad-experiments/catdad-experiments-org@c17b82/electronmon/logo.jpg)](https://github.com/catdad/electronmon/)



Watch and reload your electron app the easy way!



[![GitHub Actions CI][github-actions.svg]][github-actions.link]

[![npm-downloads][npm-downloads.svg]][npm.link]

[![npm-version][npm-version.svg]][npm.link]



[github-actions.svg]: https://img.shields.io/github/actions/workflow/status/catdad/electronmon/ci.yml?logo=github&branch=master

[github-actions.link]: https://github.com/catdad/electronmon/actions/workflows/ci.yml

[npm-downloads.svg]: https://img.shields.io/npm/dm/electronmon.svg

[npm.link]: https://www.npmjs.com/package/electronmon

[npm-version.svg]: https://img.shields.io/npm/v/electronmon.svg



This is the simplest way to watch and restart/reload [electron](https://github.com/electron/electron) applications. It requires no quessing, no configuration, and no changing your application or conditionally requiring dependencies. And best of all, it keeps everything in-process, and will not exit on the first application relaunch.



It was inspired by [nodemon](https://github.com/remy/nodemon) and largely works the same way (_by magic_ 🧙).



To use it, you don't have to change your application at all. Just use `electronmon` instead of `electron` to launch your application, using all the same arguments you would pass to the `electron` cli:



```bash

npx electronmon .

```



That's it! Now, all your files are watched. Changes to main process files will cause the application to restart entirely, while changes to any of the renderer process files will simply reload the application browser windows.



All you have to do now is write your application code.



## Configuration



Okay, okay... so it's not exactly magic. While `electronmon` will usually work exactly the way you want it to, you might find a need to contigure it. You can do so by providing extra values in your `package.json` in the an `electronmon` object. The following options are available:



* **`patterns`** _`{Array}`_ - Additional patterns to watch, in glob form. The default patterns are `['**/*', '!node_modules', '!node_modules/**/*', '!.*', '!**/*.map']`, and this property will add to that. If you want to ignore some files, start the glob with `!`.



**Example:**



```json

{

  "electronmon": {

    "patterns": ["!test/**"]

  }

}

```



## Supported environments



This module is tested and supported on Windows, MacOS, and Linux, using node versions 10 - 18 and electron versions 8 - 23. Considering it still works after all these versions, there's a good chance it works with newer versions as well.



## API Usage



You will likely never need to use this, but in case you do, this module can be required and exposes and API for interacting with the monitor process.



```javascript

const electronmon = require('electronmon');



(async () => {

  const options = {...};

  const app = await electronmon(options);

})();

```



All options are optional with reasonable defaults (_again, magic_ 🧙), but the following options are available:



* **`cwd`** _`{String}`_ - The root directory of your application.

* **`args`** _`{Array}`_ - The arguments that you want to pass to `electron`.

* **`env`** _`{Object}`_ - Any additional environment variables you would like to specically provide to your `electron` process.

* **`patterns`** _`{Array}`_ - Additional patterns to watch, in glob form. The default patterns are `['**/*', '!node_modules', '!node_modules/**/*', '!.*', '!**/*.map']`, and this property will add to that. If you want to ignore some files, start the glob with `!`.

* **`logLevel`** _`{String}`_ - The level of logging you would like. Possible values are `verbose`, `info`, ` error`, and `quiet`.

* **`electronPath`** _`{String}`_ - The path to the `electron` binary.



When the monitor is started, it will start your application and the monitoring process. It exposes the following methods for interacting with the monitoring process (all methods are asynchronous and return a Promise):



* **`app.reload()`** → `Promise` - reloads all open web views of your application

* **`app.restart()`** → `Promise` - restarts the entire electron process of your application

* **`app.close()`** → `Promise` - closes the entire electron process of your application and waits for file changes in order to restart it

* **`app.destroy()`** → `Promise` - closes the entire electron process and stops monitoring