# grunt-file-watch > Run predefined tasks whenever watched file changes. Latest version **1.0.8** (published 2015-08-01) · BSD-2-Clause license · 0 weekly downloads ## Install ```sh npm install grunt-file-watch pnpm add grunt-file-watch yarn add grunt-file-watch bun add grunt-file-watch ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.8 | | Published | 2015-08-01 | | First published | 2015-05-14 | | Weekly downloads | 0 | | License | BSD-2-Clause | | TypeScript types | none | | Module format | CommonJS | | Node | >= 0.9.2 | | Dependencies | 3 | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | Author | Daniel Steigerwald | | Maintainers | cedricve | | Keywords | Node, Watch, gruntplugin | ## Links - npm: https://www.npmjs.com/package/grunt-file-watch - Repository: https://github.com/cedricve/grunt-file-watch - Issues: https://github.com/cedricve/grunt-file-watch/issues - npm.io page: https://npm.io/package/grunt-file-watch ## Dependencies (3) - [semver](https://npm.io/package/semver.md) ^3.0.1 - [chokidar](https://npm.io/package/chokidar.md) ^0.8.2 - [tiny-lr-fork](https://npm.io/package/tiny-lr-fork.md) 0.0.5 ## Alternatives - [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads - [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads - [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads - [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads - [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads ## Recent versions - 1.0.8 (latest) — 2015-08-01 - 1.0.7 — 2015-08-01 - 1.0.6 — 2015-08-01 - 1.0.5 — 2015-08-01 - 1.0.4 — 2015-08-01 - 1.0.3 — 2015-05-14 - 1.0.2 — 2015-05-14 - 1.0.1 — 2015-05-14 - 1.0.0 — 2015-05-14 - 0.1.19 — 2015-05-14 - 0.1.18 — 2015-05-14 ## README # grunt-file-watch This a fork of the original grunt-este-watch repository, and is created for the Kerberos.io repository. Source code have been minified: removed support for livereload, only rely on file changes, don't check if file is locked anymore, update styling. ## Getting Started This plugin requires Grunt `~0.4.0` If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command: ```shell npm install grunt-file-watch --save-dev ``` Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: ```js grunt.loadNpmTasks('grunt-file-watch'); ``` ## Watch task _Run this task with the `grunt esteWatch` command._ ### Settings #### options.dirs Note you have to specify only directory ('dir'), or directory recursively ('dir/**/') with all its subdirectories. Type: `Array.` Default: ```js [ 'bower_components/closure-library/**/', 'bower_components/este-library/**/', '!bower_components/este-library/node_modules/**/', 'client/**/{js,css}/**/' ] ``` List of watched directories ### Examples Watch and compile CoffeeScript. ```coffee esteWatch: options: # just a dirs, no file paths dirs: ['dirOne/**/', 'dirTwo/**/'] 'coffee': (filepath) -> files = [ expand: true src: filepath ext: '.js' ]; grunt.config ['coffee', 'app', 'files'], files ['coffee:app'] # to define all '*': (filepath) -> return ['urequire:uberscoreUMD'] ``` ```js grunt.initConfig({ esteWatch: { options: { dirs: ['bower_components/closure-library/**/', 'bower_components/este-library/**/', '!bower_components/este-library/node_modules/**/', 'client/**/{js,css}/**/'] }, coffee: function(filepath) { var files = [{ expand: true, src: filepath, ext: '.js' }]; grunt.config(['coffee', 'app', 'files'], files); grunt.config(['coffee2closure', 'app', 'files'], files); return ['coffee:app', 'coffee2closure:app']; }, soy: function(filepath) { grunt.config(['esteTemplates', 'app'], filepath); return ['esteTemplates:app']; }, js: function(filepath) { grunt.config(['esteUnitTests', 'app', 'src'], filepath); var tasks = ['esteDeps:all', 'esteUnitTests:app']; if (grunt.option('stage')) { tasks.push('esteBuilder:app'); } return tasks; }, styl: function(filepath) { grunt.config(['stylus', 'all', 'files'], [{ expand: true, src: filepath, ext: '.css' }]); return ['stylus:all', 'stylus:app']; }, css: function(filepath) { if (grunt.option('stage')) { return 'cssmin:app'; } } } }); ``` ### FAQs #### What's wrong with official grunt-contrib-watch? It's slow and buggy, because it uses combination fs.fileWatch and fs.watch, for historical reason. From Node 0.9.2+, fs.watch is ok. [github.com/steida/este](http://github.com/steida/este) needs maximum performance and stability, so that's why I had to create yet another Node.js file watcher. This watcher is continuously tested on Mac, Linux, Win platforms. #### grunt-contrib-watch Issues - Strange "Abort trap: 6" exceptions. - File added in new directory isn't detected. - LiveReload console.log mess during livereloading. - Polling to much files. Etc. #### Note about editors atomic save Node.js fs.watch sometimes does not work with editors atomic save. For example, Node.js v0.10.17 works while v0.10.18 doesn't. Fix for SublimeText is easy, just disable it via ```"atomic_save": false```. ## License Copyright (c) 2013 Daniel Steigerwald Licensed under the MIT license. --- _Source: https://npm.io/package/grunt-file-watch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._