canner-core

Description

Core components of the Canner, including init, build, watch, allin and read API.

About Canner

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

We isolate all the text from files so people can maintain their websites more easily, we also work hard on lower the barriers for different fields of people to collaborate with ease.

API

Env

if you want to send request to localhost, run export CANNER_ENV='dev'

require

var canner= require('canner');

Init

Create initial files and folders, under a directory.

return a promise

canner.init(dir, generator)
      .then(function(){
          // do your stuff
      })
      .catch(function(err){
          // deal with error
      });

parameters

• {string} dir - directory install canner
• {string} generator - Inital generate the generator that you are finding

Build

Build a canner from a canner.json

return a promise

canner.build(dir, options)
      .then(function(){
          // do your stuff
      })
      .catch(function(err){
          // deal with error
      });;

parameters

• {string} dir - source to canner.json, default ./canner.json
• {object} options
  • output- output dir
  • engine- Your template engine
  • data- if you want to put your own object intead of data in canner.json, and return html back, instead of write to file

watch

Watching any changes in a canner and recompiled

return a promise

usage

canner.watch(posts, {
    cwd: __dirname ,
    serve: __dirname + '/blog',
    returnContent: true,
    watchCallback: function (html) {
      console.log(html)
    },
    reloader: function () {
      return loadJson();
    }, 
    changeFilter: function (row, f, curr, prev) {
      // if md equals, return true
      if(path.extname(f)=='.md'){
        return (f==path.resolve(__dirname, row.data.content))
      }
    }
  })

parameters

serve

the directory you want to watch

watchCallback

everytime we call build in watch, we'll call watchCallback after build finish

reloader

if you give us object in canner.watch parameters, we'll need a reloader to reload the object

reloader example

function loadJson () {
  var obj = JSON.parse(fs.readFileSync(__dirname + '/blog/blog-multi.json', 'utf8'));
  var posts = obj.posts;
  var post_layout = obj.post_settings.layout;
  var post_root_path = obj.post_settings.path;
 
  if(!_.isArray(posts))
      posts = [posts];
 
  posts = _.map(posts, function(post) {
      var post_date = post.date;
      var post_url = post.url_name + '.html';
      var file_path = generatePath(post_root_path, post_date, post_url);
 
      var canner_obj = {
        layout: post_layout,
        filename: file_path,
        data: post
      };
 
      return canner_obj;
    })
  return posts
}

file operation filters

file operation filters are called after we reload the settings, and we'll filter the datas using the filter. we keep the data row if filter return true, else we delete the row

how filter work

for example, this function first see if the extenstion of changed file is .md

if true, it will compare changed file path with the markdown file in row.data

function (row, f, curr, prev) {
  // if md equals, return true
  if(path.extname(f)=='.md'){
    return (f==path.resolve(__dirname, row.data.content))
  }
}

createFilter(row, f, stat)

called when a file is created

parameters

• row means the data row you currenly compared with
• f is the filename of file created
• stat is stat of file created

changeFilter(row, f, curr, prev)

called when a file is created

parameters

• curr is the current file stat
• prev is the previous file stat

removeFilter(row, f, stat)

called when a file is removed

allin

Make html include files all warp allin

canner.allin(htmlfile, options);

parameters

• {string} htmlfile - source to your html, default ./index.html
• {object} options
  • filename {String} Output html file name, default to output.html
  • output {String} Path to output directory, defaults to current directory
  • minifyall {Boolean}- minify css, html, js, images or not

Create

Create a canner.json from hbs_file

return a promise

usage

canner.create(dir, options)
   .then(function(){
     // do your stuff
   })
   .catch(function(err){
      // deal with error
   });;

parameters

• {string} dir - source to hbs_file, default ./index.hbs
• {object} options