# slim-demon

> 😈 Slim Demon is a micro library that detects changes in the files of your NodeJS application and restart it quickly and automatically.

Latest version **1.0.1** (published 2020-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install slim-demon
pnpm add slim-demon
yarn add slim-demon
bun add slim-demon
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-09-29 |
| First published | 2020-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 52.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | José J. Pérez Rivas |
| Maintainers | josejpr |
| Keywords | Node, Restart, Demon, Watcher, File, JavaScript |

## Links

- npm: https://www.npmjs.com/package/slim-demon
- Repository: https://github.com/JoseJPR/slim-demon
- Homepage: https://github.com/JoseJPR/slim-demon#readme
- Issues: https://github.com/JoseJPR/slim-demon/issues
- npm.io page: https://npm.io/package/slim-demon

## Dependencies (2)

- [pino](https://npm.io/package/pino.md) ^6.6.0
- [pino-pretty](https://npm.io/package/pino-pretty.md) ^4.2.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-09-29
- 1.0.0 — 2020-09-28

## README

<p align="center">
  <img src="./assets/banner.jpg" />
</p>

<h1 align="center">Slim Demon</h1>

<p align="center">😈 Slim Demon is a micro library that detects changes in the files of your NodeJS application and restart it quickly and automatically.</p>

<p align="center">
  <a title="MIT License" href="LICENSE.md">
    <img src="https://img.shields.io/github/license/gridsome/gridsome.svg?style=flat-square&label=License&colorB=6cc24a">
  </a>
  <a title="Twitter: JoseJ_PR" href="https://twitter.com/JoseJ_PR">
    <img src="https://img.shields.io/twitter/url?color=1991DA&label=Twitter%20%40JoseJ_PR&logo=twitter&logoColor=FFFFFF&style=flat-square&url=https%3A%2F%2Ftwitter.com%2FJoseJ_PR">
  </a>  
  <a title="Github: Sponsors" href="https://github.com/sponsors/JoseJPR">
    <img src="https://img.shields.io/twitter/url?color=032f62&label=Github%20Sponsors%20%40JoseJPR&logo=github&logoColor=FFFFFF&style=flat-square&url=https%3A%2F%2Fgithub.com%2Fsponsors%2FJoseJPR">
  </a>
  <br />
  <br />
</p>

## 🔖 Description
Slim Demon is a micro library based on the native NodeJS API using the core and the native libraries.

You can define a directory and one or more types of files that will be listened to, if any of these files change the application will be restarted quickly and automatically.

## 📐 How to work with this project

### 1️⃣ Install this module into your project.

```bash
npm i slim-demon --save-dev
```

### 2️⃣ Configure the demon

Include the demon configuration in your main package.json file.

Property | Type | Description
-------- | ---- | -------
rootDirectory | string | The main folder of your NodeJS Application.
extensionsFile | Array<string> | File extensions to review.
mainApplication | string |Command to execute when a change is detected in the files.

#### Example

```json
"demon": {
  "rootDirectory": "./src",
  "extensionsFile": [
    "js"
  ],
  "mainApplication": "npm run start"
}
```

### 3️⃣ Add a custom script

Include the following sentence into your scripts of your packate.json file:

```json
"scripts": {
  "start:watch": "node node_modules/slim-demon"
}
```

### 4️⃣ Run

Run this command in your terminal.

```bash
$npm run start:watch
```

## 📂 Code Scaffolding

```any
/
├── assets 🌈                   # Images Sources.
├── doc                         # QAC Documentation.
├── example                     # Local example.
├── src 📦                      # Main file library.
└── ...
```

## ⛽️ Review and Update Sependencies

For review and update all npm dependencies of this project you need install in global npm package "npm-check-updates" npm module.

```bash
# Install and Run
$npm i -g npm-check-updates
$ncu
```

## License

[MIT](LICENSE.md)

## Happy Code

Created with JavaScript, lot of ❤️ and a few ☕️

## This README.md file has been written keeping in mind

[GitHub Markdown](https://guides.github.com/features/mastering-markdown/) \
[Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)

---
_Source: https://npm.io/package/slim-demon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._