Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mysticatea/warun
CLI tool which does Watch and Run.
https://github.com/mysticatea/warun
Last synced: about 2 months ago
JSON representation
CLI tool which does Watch and Run.
- Host: GitHub
- URL: https://github.com/mysticatea/warun
- Owner: mysticatea
- License: mit
- Created: 2017-07-28T08:47:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-21T12:34:59.000Z (about 4 years ago)
- Last Synced: 2024-07-26T19:00:36.784Z (about 2 months ago)
- Language: JavaScript
- Size: 15.6 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# warun
[](https://www.npmjs.com/package/warun)
[](http://www.npmtrends.com/warun)
[](https://travis-ci.org/mysticatea/warun)
[](https://ci.appveyor.com/project/mysticatea/warun/branch/master)
[](https://codecov.io/gh/mysticatea/warun)
[](https://david-dm.org/mysticatea/warun)
**Wa**tch files and **run** a command when they change.
## ⤴️ Motivation
This is CLI tool similar to [chokidar-cli](https://github.com/kimmobrunfeldt/chokidar-cli).
However, this does not run the command immediately if changes happen while the command is running. In that case, this waits for the finish of the previous command then this runs the command.
This will be useful if the command needs a long time.
## 💿 Installation
Use [npm](https://www.npmjs.com/) to install.
```console
$ npm install -D warun
```
### Requirements
- Node.js 4 or later.
## 📖 Usage
### CLI command
```
Usage: warun [OPTIONS] -- [COMMAND_ARGS]
Watch files and Run a command.
FILES .......... One or more glob patterns to watch files.
OPTIONS ........ Options below.
COMMAND ........ The command name to run.
COMMAND_ARGS ... The arguments of the command.
Options:
--no-initial .......... The flag to prevent the first run at ready.
--debounce ... The debounce wait time in milliseconds.
Examples:
$ warun lib test -- npm test
$ warun src --no-initial -- npm run build
```
### Node.js API
```js
const warun = require("warun")
// Start watching
const watcher = warun.watch(["src"], "npm", ["run", "build"])
// Stop watching
watcher.close()
```
#### watcher = new warun.Watcher(patterns, command, args, options)
The watcher class.
This class inherits [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter).
##### Parameters
- `patterns` (`string | string[]`) ... The glob patterns of target files.
- `command` (`string`) ... The command to run.
- `args` (`string[]`) ... The arguments of the command.
- `options` (`object`) ... The options.
- `options.initial` (`boolean`) ... The flag to run the command at ready. Default is `true`.
- `options.debounce` (`number`) ... The debounce wait time in milliseconds. Default is `250`.
#### watcher.requestCommand()
Request to run the command.
Calls of this method are debounced.
#### watcher.open()
Start to watch files.
#### watcher.close()
Stop watching.
#### watcher.on("ready", () => {})
The ready event.
It emits this event once after the watching of all target files started.
#### watcher.on("change", (event) => {})
The change event of files.
It emits this event on every change of files.
- `event.type` is the type of the change.
- `event.path` is the path to the changed file.
#### watcher.on("error", (error) => {})
The error event of files.
It emits this event on every error of the watcher.
## 📰 Changelog
- [GitHub Releases](https://github.com/mysticatea/warun/releases)
## 🍻 Contributing
Contributing is welcome ❤
Please use GitHub's Issues/PRs.
### Development Tools
- `npm test` runs tests and measures coverage.
- `npm run coverage` shows the coverage result of `npm test` command.
- `npm run lint` runs ESLint.
- `npm run watch` runs `warun` to run tests on every file change.