Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adi518/php-watcher
Watch PHP files and execute a corresponding handler.
https://github.com/adi518/php-watcher
Last synced: 8 days ago
JSON representation
Watch PHP files and execute a corresponding handler.
- Host: GitHub
- URL: https://github.com/adi518/php-watcher
- Owner: adi518
- Created: 2018-06-06T18:51:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-09T15:31:13.000Z (over 6 years ago)
- Last Synced: 2024-11-28T15:08:17.043Z (25 days ago)
- Language: JavaScript
- Homepage:
- Size: 1.95 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PHP-Watcher
Watch PHP files and execute a corresponding handler.
## Prerequisites
Node.js Version >= 8 (might work with older versions, but untested). You can find latest version 8 [here](https://nodejs.org/download/release/v8.11.2/). If you currently use an older version of Node and want to keep it, I recommend using [NVM](https://github.com/coreybutler/nvm-windows) (Node Version Manager), which is a tool for managing multiple Node.js versions. You can grab its Windows version [here](https://github.com/coreybutler/nvm-windows/releases) (recommended: latest **stable** release) and its Mac/Linux version [here](https://github.com/creationix/nvm).
## Install
```
npm install
```
## Usage
```
npm start
```
## Configuration
Create a `js` module and export a config object according to API options below. All options are merged with their defaults, so you can spare an option if its default is already covering your needs. Defaults:
```js
module.exports = {
php: 'C:/php',
command: 'php/deploy.php',
watchDir: 'php/src',
watchOptions: {
ignored: /(^|[/\\])\../,
persistent: true
},
verbose: true
}
```
Then, pass it to `php-watcher`, like so:
```
node ./node_modules/php-watcher/index.js --conf=watch.conf.js
```
Ideally, you can assign this command to `npm` script, like so:
```json
{
"scripts": {
"watch": "node ./node_modules/php-watcher/index.js --conf=watch.conf.js"
}
}
```
Then, use it:
```
npm run watch
```
## Options
#### `php`
* Type: `String`
* Default: `C:/php`
* Description: Absolute path to PHP service.
#### `command`
* Type: `String`
* Default: `php/deploy.php`
* Description: Command to execute on watch callback.
#### `watchDir`
* Type: `String`
* Default: `php/src`
* Description: Relative path to watched files.
#### `watchOptions`
* Type: `Object`
* Default:
```
{
ignored: /(^|[/\\])\../,
persistent: true
}
```
* Description: See options [here](https://github.com/paulmillr/chokidar#api).
#### `verbose`
* Type: `Boolean`
* Default: `true`
* Description: Whether to display handler output or not.
## Preview
