README.md

gulp-xtemplate

compile .xtpl file to modulex module

usage

var XTemplate = require('xtemplate');
XTemplate=XTemplate.default||XTemplate;
var gulpXTemplate = require('gulp-xtemplate');

gulp.src('lib/**/*')
    .pipe(gulpXTemplate({
        // esmodule: true, // defaults to commonjs
        // wrap: 'define', // defaults to commonjs. set to define compiled to define().
        compileConfig: {
            isModule:1, // defaults to 1. use native template require
            catchError:false // defaults to false. whether to point to line of xtpl when exception occurs(impact performance)
        },
        // runtime:'', defaults to xtemplate/lib/xtemplate/runtime, if use kissy gallery u need to set to kg/xtemplate/require('xtemplate/package.json').version/runtime
        suffix:'.xtpl', // defaults to .xtpl. transform xx.xtpl -> xx.js
        truncatePrefixLen: 0,//optional, remove the first length string of file path from generate code
        XTemplate, // required. xtemplate module,
        renderJs:'-render.js'// render xtpl file suffix.set to 'none' don't create render file
    }))
    .pipe(uglify())
    .pipe(gulp.dest('build'))

xtpl file example

source

a.xtpl

{{include('./b')}}{{x}}

after compile

a.js

modulex.add(function(require, exports, module){
  function compiled(){
     require('./b');
     // ....
  }
  compiled.TPL_NAME = module.name;
  module.exports = compiled;

a-render.js

  // x.y.z is extracted from xtemplate.version
  var runtime = require('kg/xtemplate-runtime/x.y.z/');
  var compiled = require('./a');
  var instance = new XTemplate(compiled);
  module.exports = function(){
    return instance.render.apply(instance, arguments);
  }

user call:

require('xx/a-render', function(aRender){
    console.log(aRender({
        x:1
    },{
        commands: {
            //
        }
    }));
});