https://github.com/hirasso/parcel-plugin-watch-reload

Parcel plugin to watch files not included in the bundles and reload browser if they change
https://github.com/hirasso/parcel-plugin-watch-reload

Last synced: 2 months ago
JSON representation

Parcel plugin to watch files not included in the bundles and reload browser if they change

• Host: GitHub
• URL: https://github.com/hirasso/parcel-plugin-watch-reload
• Owner: hirasso
• License: mit
• Archived: true
• Created: 2018-09-03T14:44:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-08T14:42:35.000Z (almost 3 years ago)
• Last Synced: 2024-11-08T20:48:46.798Z (3 months ago)
• Language: JavaScript
• Size: 2.04 MB
• Stars: 24
• Watchers: 4
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-parcel - Watch Reload - Watches files outside of parcel bundles and sends a reload request to parcel if they change (Plugins / Other)

README

        
![Node.js CI](https://github.com/hirasso/parcel-plugin-watch-reload/workflows/Node.js%20CI/badge.svg) 

[![Build Status](https://travis-ci.com/hirasso/parcel-plugin-watch-reload.svg?branch=master)](https://travis-ci.com/hirasso/parcel-plugin-watch-reload) 

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B17638%2Fgit%40github.com%3Ahirasso%2Fparcel-plugin-watch-reload.git.svg?type=shield)](https://app.fossa.com/projects/custom%2B17638%2Fgit%40github.com%3Ahirasso%2Fparcel-plugin-watch-reload.git?ref=badge_shield)

# parcel-plugin-watch-reload 

📦🔌🗂👀 A [Parcel](https://github.com/parcel-bundler/parcel) plugin that watches files not included in your bundles (e.g. `**/*.php`) and reloads your browser if they change (great for CMS theme development like e.g. WordPress). Also, has emojis in readme 👾

## Installation

```

$ npm install parcel-plugin-watch-reload -D

```

...or

```

$ yarn add parcel-plugin-watch-reload -D

```

## Setup

Specify which file types should trigger a browser reload in your `package.json`:

```json

{

  "watchreload": {

    "files": "**/*.php"

  }

}

```

Arrays of globs are also supported:

```json

{

  "watchreload": {

    "files": ["**/*.php", "**/*.svg"]

  }

}

```

Without the `files` setting in your `package.json`, the plugin will do nothing.

## Optional settings

- Set a reload delay:

  ```json

  {

    "watchreload": {

      "files": "**/*.php",

      "reloadDelay": 200

    }

  }

  ```

- Overwrite the plugin's settings for [Chokidar](https://github.com/paulmillr/chokidar#api). The defaults are:

  ```json

  {

    "watchreload": {

      "files": "**/*.php",

      "chokidarOptions": {

        "ignored": ["node_modules", "bower_components", ".cache"],

        "ignoreInitial": true

      }

    }

  }

  ```

That's it! If you start parcel in `watch` mode with the `hmr` option set to true (it's the default), each change to a file matching your rules will trigger a browser reload. ✨

## License

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B17638%2Fgit%40github.com%3Ahirasso%2Fparcel-plugin-watch-reload.git.svg?type=large)](https://app.fossa.com/projects/custom%2B17638%2Fgit%40github.com%3Ahirasso%2Fparcel-plugin-watch-reload.git?ref=badge_large)