src/node/utils/TidyHtml.js


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

/**
 * Tidy up the HTML in a given file
 */

var log4js = require('log4js');
var settings = require('./Settings');
var spawn = require('child_process').spawn;

exports.tidy = function(srcFile, callback) {
  var logger = log4js.getLogger('TidyHtml');

  // Don't do anything if Tidy hasn't been enabled
  if (!settings.tidyHtml) {
    logger.debug('tidyHtml has not been configured yet, ignoring tidy request');
    return callback(null);
  }

  var errMessage = '';

  // Spawn a new tidy instance that cleans up the file inline
  logger.debug('Tidying ' + srcFile);
  var tidy = spawn(settings.tidyHtml, ['-modify', srcFile]);

  // Keep track of any error messages
  tidy.stderr.on('data', function (data) {
    errMessage += data.toString();
  });

  // Wait until Tidy is done
  tidy.on('close', function(code) {
    // Tidy returns a 0 when no errors occur and a 1 exit code when
    // the file could be tidied but a few warnings were generated
    if (code === 0 || code === 1) {
      logger.debug('Tidied ' + srcFile + ' successfully');
      return callback(null);
    } else {
      logger.error('Failed to tidy ' + srcFile + '\n' + errMessage);
      return callback('Tidy died with exit code ' + code);
    }
  });
};