https://github.com/shinnn/watchexec-bin

An npm package to install a watchexec prebuilt binary
https://github.com/shinnn/watchexec-bin

binary command-line-tool cross-platform downloader file-watcher installer javascript nodejs rust watchexec

Last synced: 27 days ago
JSON representation

An npm package to install a watchexec prebuilt binary

• Host: GitHub
• URL: https://github.com/shinnn/watchexec-bin
• Owner: shinnn
• License: other
• Created: 2018-11-16T14:58:52.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-06T07:24:32.000Z (almost 6 years ago)
• Last Synced: 2024-10-11T01:35:45.382Z (about 1 month ago)
• Topics: binary, command-line-tool, cross-platform, downloader, file-watcher, installer, javascript, nodejs, rust, watchexec
• Language: JavaScript
• Size: 28.3 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# watchexec-bin

[![npm version](https://img.shields.io/npm/v/watchexec-bin.svg)](https://www.npmjs.com/package/watchexec-bin)

[![Build Status](https://travis-ci.com/shinnn/watchexec-bin.svg?branch=master)](https://travis-ci.com/shinnn/watchexec-bin)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/watchexec-bin.svg)](https://coveralls.io/github/shinnn/watchexec-bin?branch=master)

An [npm package](https://docs.npmjs.com/about-packages-and-modules#about-packages) to install a [watchexec](https://github.com/watchexec/watchexec) prebuilt binary

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).

```

npm install watchexec-bin

```

As this package makes use of `install` [npm script](https://docs.npmjs.com/misc/scripts) in order to download a binary for the current platform, [`ignore-scripts` npm-config](https://docs.npmjs.com/misc/config#ignore-scripts) cannot be enabled while executing the command above.

## API

### `require('watchexec-bin')`

Type: `string`

An absolute path to the installed watchexec binary, which can be used with [`child_process`](https://nodejs.org/api/child_process.html) functions.

```javascript

const {spawn} = require('child_process');

const watchexec = require('watchexec');

spawn(watchexec, ['--', 'ls', '-la']);

```

## CLI

Once this package is installed to the project directory, users can execute `watchexec` command inside [npm scripts](https://docs.npmjs.com/misc/scripts#description) of the project.

```json

"watch-js": "watchexec --ext js eslint ."

```

```console

$ npm run-script watch-js

```

## License

[ISC License](./LICENSE.md) © 2018 Shinnosuke Watanabe

### watchexec

[Apache License 2.0](./LICENSE.md#watchexec) © 2016 Matt Green