https://github.com/kuzzleio/ergol
Meant to run on top of another script during development, reload the app after every change in the codebase
https://github.com/kuzzleio/ergol
cli command-line-interface
Last synced: 9 months ago
JSON representation
Meant to run on top of another script during development, reload the app after every change in the codebase
- Host: GitHub
- URL: https://github.com/kuzzleio/ergol
- Owner: kuzzleio
- License: apache-2.0
- Created: 2021-04-28T08:28:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-08T19:03:29.000Z (almost 4 years ago)
- Last Synced: 2025-04-25T08:45:11.489Z (9 months ago)
- Topics: cli, command-line-interface
- Language: JavaScript
- Homepage:
- Size: 64.5 KB
- Stars: 2
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ergol
__For development purposes only__
This script is meant to run on top of another process while watching source files. If any change occurs, it automatically shuts the process down, __WAIT__ until it has correctly been stopped (or kills it after some delay), and only then restarts it.
This script is meant to replace solutions like nodemon, which have a few cumbersome caveats.
## Usage
`$ npx ergol -c <config> -d <cwd>`
| Options | Alias | Required | Description |
|-----------------|-------|----------|-------------------------------------------------------------------------|
| No flag needed | - | yes | Script that runs under this process and that is reloaded when necessary |
| `--config` | `-c` | no | JSON file containing configuration variables intended to override default ones |
| `--cwd` | `-d` | no | Current Working Directory (if different from your actual cwd) |
| `--script-args` | - | no | Arguments to pass to the script |
| `--node-args` | - | no | Arguments to pass to the node interpreter |
| `--watch` | `-w` | no | Array of cwd relative path/to/directories or files to watch |
| `--kill-delay` | `-k` | no | Kill the process if it did not stop after this delay |
## Configuration
Ergol allows you to customize its behavior when necessary. If its a ponctual setting you can use one of the command argument listed before but we recommend using a config file when using recurrent options.
If you choose to use both methods, beware of which setting will be selected. Ergol will resolve each parameter by looking for command options first, config file then and default config otherwise.
### Default Config
```json
{
"killDelay": "5000",
"nodeArgs": [],
"scriptArgs": [],
"watch": [
"lib",
"src",
"index.*s",
"nodes_modules"
]
}
```
## Example
```sh-session
$ npx ergol scripts/start-app.js -c config/ergol.config.json --script-args=--option my-option-1
```
### ergol.config.json
```json
{
"killDelay": "10000",
"watch": [
"index.ts",
"src",
"package-lock.json"
]
}
```
### Final Ergol Configuration
```json
{
"killDelay": "10000",
"nodeArgs": [],
"scriptArgs": [
"--option my-option-1"
],
"watch": [
"index.ts",
"src",
"package-lock.json"
]
}
```