htmlcs/index.js

html hint tool, focused on semantic code style.

/**
 * @file main file
 * @author nighca<nighca@live.cn>
 */

var fs = require('fs');

var config = require('./lib/config');
var htmlcs = require('./lib/htmlcs');

/**
 * Do hint with given filePath & option for readFile.
 *
 * @param {string} filePath - path of the target file
 * @param {Object=} options - option for readFile
 * @return {Report[]} the hint result, list of reports
 */
var hintFile = function (filePath, options) {
    options = options || {
        encoding: 'utf-8'
    };

    var cnt = fs.readFileSync(filePath, options);
    var cfg = config.load(filePath);

    return htmlcs.hint(cnt, cfg);
};

/**
 * Do format with given filePath & option for readFile
 *
 * @param {string} filePath - path of the target file
 * @param {Object=} options - option for readFile
 * @return {string} the formatted code
 */
var formatFile = function (filePath, options) {
    options = options || {
        encoding: 'utf-8'
    };

    var cnt = fs.readFileSync(filePath, options);
    var cfg = config.load(filePath);

    return htmlcs.format(cnt, cfg);
};

module.exports = {
    addRule: htmlcs.addRule,

    hint: htmlcs.hint,
    hintAsync: htmlcs.hintAsync,
    format: htmlcs.format,
    formatAsync: htmlcs.formatAsync,

    hintFile: hintFile,
    formatFile: formatFile
};