Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Migrate to "watch" module for new file detection #9

Merged
merged 2 commits into from
Sep 13, 2014
Merged

Migrate to "watch" module for new file detection #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20096be
Use fs.watchFile instead of fs.watch for cross-OS compatibility
paton Sep 10, 2014
d2675fc
Migrate to watch module to support detecting new files
paton Sep 10, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.mkdn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ Compiles all of the Handlebars templates in the specified directory and monitors

* `opts.extensions` An array of extensions of files (eg `['hbs']`) to compile as Handlebars templates (takes precedence over fileRegex) (`string[]`)

* `opts.pollInterval` Interval in milliseconds at which files are polled for changes (default: 500) (`number`)

* `opts.fileRegex` A regular expression of the files to compile as Handlebars templates (instead of using .extensions) (`RegExp`)

* `opts.min` Whether or not to minify the files (default: true) (`boolean`)
Expand All @@ -104,7 +106,8 @@ Compiles all of the Handlebars templates in the specified directory and monitors
* Project created by Joel Wietelmann
* Nic Jansma
* Matt Null
* Brandon Paton

## Version History

* v1.0.4 - [Fixed issue with temp files crashing precompiler](https://github.com/nicjansma/node-handlebars-precompiler/pull/3)
* v1.0.4 - [Fixed issue with temp files crashing precompiler](https://github.com/nicjansma/node-handlebars-precompiler/pull/3)
65 changes: 41 additions & 24 deletions handlebars-precompiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Changed from command-line compiler to node module

var fs = require('fs'),
file = require('file'),
watch = require('watch'),
handlebars = exports.handlebars = require('handlebars'),
basename = require('path').basename,
uglify = require('uglify-js'),
Expand Down Expand Up @@ -158,6 +158,7 @@ exports.watchDir = function(dir, outfile, extensions) {
* @param {string} outfile Output file name
* @param {object} opts Options
* @param {string[]} opts.extensions An array of extensions (eg 'hbs') of files to compile as Handlebars templates (takes precedence over fileRegex)
* @param {number} opts.pollInterval Interval in milliseconds at which files are polled for changes (default: 500)
* @param {RegExp} opts.fileRegex A regular expression of the files to compile as Handlebars templates (instead of using .extensions)
* @param {boolean} opts.min Whether or not to minify the files (default: true)
* @param {boolean} opts.silent Silence console output (default: false)
Expand All @@ -170,6 +171,7 @@ exports.watch = function(dir, outfile, opts) {
// defaults to send to .do()
var defaults = {
extensions: null,
pollInterval: 500,
fileRegex: /\.handlebars$/,
min: true,
silent: false,
Expand All @@ -195,36 +197,51 @@ exports.watch = function(dir, outfile, opts) {
* Compiles all of the Handlebars templates if one of the files changes.
*
* @private
* @param {Event} event File change event
* @param {string} filename File name that changed
* @param {string} File name that changed, or an object of files that are being watched
* @param {object} Current stat object
* @param {object} Previous stat object (null if file is new)
*/
function compileOnChange(event, filename) {
if (!options.silent){
console.log('[' + event + '] detected in ' + (filename ? filename : '[filename not supported]'));
console.log('[compiling] ' + outfile);
}
function compileOnChange(file, current, previous) {
var message;

if (typeof file === 'object' && previous === null && current === null) {
// Finished walking the tree and added listeners
message = 'watching ' + Object.keys(file).length + ' files';
} else {

var relativeFilename = file.replace(dir, '');

// do a full compile
exports.do(options);
if (previous === null) {
message = 'new file detected: ' + relativeFilename;
} else if (current.nlink === 0) {
message = 'file removed: ' + relativeFilename;
} else {
message = 'file changed: ' + relativeFilename;
}

exports.do(options);
}

if (!options.silent) {
console.log('[handlebars-precompiler] ' + message);
}
}

// compile everything before we start watching
exports.do(options);

// find all matching files in the base directory and watch all of them for changes
file.walk(dir, function(_, dirPath, dirs, files) {
if (files) {
for (var i = 0; i < files.length; i++) {
var file = files[i];
if (options.fileRegex.test(file)) {
// watch this file for changes
fs.watch(file, compileOnChange);

if (!options.silent) {
console.log('[watching] ' + file);
}
}
}
watch.watchTree(dir, {
interval: 100,
ignoreDotFiles: true,
persistent: true,
ignoreUnreadableDir: true,
filter: function(file) {
// This returns both files and directoroes
// Always allow directory to pass filter - apply regex to files only
var isDirectory = !/\/[^\/]*\.[^\/]+$/.test(file);
return isDirectory || options.fileRegex.test(file);
}
});
}, compileOnChange);

};
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"dependencies": {
"handlebars": "~1.0",
"uglify-js": "~1.2",
"file": "~0.2",
"watch": "^0.11.0",
"lodash": ">= 0.0.0"
},
"devDependencies": {
Expand Down