canner-core/index.js

A static webpage generator based on template engines, which aimed to deal with the maintenance difficulty between data and webpages.

var _ = require('lodash');
var prog = require('commander');
var fileSave = require('file-save');
var path = require('path');
var Q = require('q');

// initialize a canner instance
var CannerInstance= require('./lib/instance');
var canner= new CannerInstance();

/*
 *	Init
 *	Initialize files and folders, under a directory.
 *	@param {string} dir - directory install canner
 *	@param {string} generator - Inital generate the generator that you are finding
 */
exports.init = function(dir, generator) {
  return canner.init(dir, generator);
}

/*
 *	Build
 *	Build a canner from a canner.json
 *	@param {string} dir - source to canner.json, default ./canner.json
 *	@param {object} options - options
 */
exports.build = function(dir, options) {
  return canner.build(dir, options || {}, false);
}

/*
 *	Watch
 *	Watching any changes in a canner and recompiled
 *	@param {string} dir - source to canner.json, default ./canner.json
 *	@param {object} options - options
 */
exports.watch = function(dir, options) {
  return canner.build(dir, options || {}, true);
}


/*
 * read
 * read a file path
 * @param {string} can - can name, e.g., sample-can
 * @param {string} filePath - file path you want to read
 */

exports.read = function(can, filePath) {
  return canner.read(can, filePath);
}

// read stream
exports.createReadStream= function (can, filePath) {
  return canner.createReadStream(can, filePath);
}

/*
 *	Allin
 *	Make html include files all warp allin
 *	@param {string} htmlfile - source to your html, default ./index.html
 *	@param {object} options - options
 */

exports.allin = function(htmlfile, options) {
  var options = {
    "minifyCSS": true,
    "minifyJS": true,
    "removeComments": true,
    "collapseWhitespace": true
  };

  var filename = options.filename || 'output.html';
  var output = options.output || './';
  var minify = options.minifyall || null;

  if (!minify) {
    options = null;
  }

  allin_html(
    path.resolve(process.cwd(), htmlfile),
    options,
    function(all) {
      fileSave(path.resolve(path.join(process.cwd(), output, filename)))
        .write(all);
    });
}

/*
 *	create
 *	Create a canner.json by extracting data from hbs.
 *	@param {string} dir - source to index.hbs, default ./index.hbs
 */

exports.create = function(dir, options) {
  canner.create(dir, options);
}