Handlebars辅助函数集.md

Handlebars辅助函数集

Handlebars 辅助函数集的 JavaScript 实现文件在这里

有自定义需求的可以在nei平台上在规范中将文件选择为自定义handlebars辅助函数即可。

如何撰写自定义Handlebars辅助函数

Handlerbars通过registerHelper函数向handlerbars注入辅助函数，其代码形式如下所示

Handlebars.registerHelper('JSONStringify', function (obj) {
    return JSON.stringify(obj, null, '\t');
});

可以看到，该辅助函数JSONStringify接收一个参数obj，将该obj序列化为字符串，返回。用户可以通过 将规范中的js文件标记为自定义handlebars辅助函数，从而增强模板的能力。更多的示例可参考nei-toolkit 定义的辅助函数实现文件以及Handlebars官方文档

目前可用的 helper

raw

用它包裹的内容按原样输出

{{{{raw}}}}
  {{name}}
{{{{/raw}}}}

输出为: {{name}}

ifCond

支持的逻辑运算有: '=='、'==='、'<'、'<='、'>'、'>='、'&&'、'||'

模板中的写法:

{{#ifCond var1 '==' var2}}

extname

以点号分隔字符串后的最后一项, 相当于根据路径取文件的扩展名

var data = {
    path: 'a.b.c'
}

var template = `{{extname path}}`;
console.log(Handlebars.compile(template)(data)); // 输出: 'c'

hyphenToCamel

中划线'-'后的字符转大写

var data = {
    "name": "a-b-c"
}
var template = `{{hyphenToCamel name}}`;
console.log(Handlebars.compile(template)(data)); //输出ABC

camelToHyphen

hyphenToCamel的反函数，将大写字符转为小写并以中划线'-'分开

var data = {
    "name": "AbcDefGhi"
}
var template = `{{camelToHyphen name}}`;
console.log(Handlebars.compile(template)(data)); //输出abc-def-ghi

hyphenToUnderline

中划线'-'转下划线'_'

var data = {
    "name": "a-b-c"
}
var template = `{{hyphenToUnderline name}}`;
console.log(Handlebars.compile(template)(data)); //输出a_b_c

iosProperty

帮助ios工程自动生成property声明, 需要在规范中将文件选为数据模型列表填充, 该函数读取该文件的所有property,依据属性的类型生成声明.

var data = {
    "datatype": {
        "fields":[{
                   "name": "foo",
                   "type": "String",
                   "arrDim": 0,
                   "format": 3,
                   "itemIsArray": 0,
                   "defaultValue": "fooDesc",
                   "genExp": "",
                   "description": ""
                  },
                 {
                   "name": "bar",
                   "type": "customType",
                   "arrDim": 0,
                   "format": 1,
                   "itemIsArray": 0,
                   "defaultValue": "",
                   "genExp": "",
                   "description": "customDesc"
        }] 
    }
}
{{iosProperty}}    --> 输出:   /**
                               *  fooDesc
                               */
                               @property (nonatomic, copy) String *foo;
                              /**
                               *  customDesc
                               */
                               @property (nonatomic, strong) customType *bar;

lowerFirst

将首字母小写

var data = {
    "name": "ProjectGroup"
}
var template = `{{lowerFirst name}}`;
console.log(Handlebars.compile(template)(data)); // 输出: projectGroup

noLineBreak

将换行替换为逗号(默认)或者自定义分隔符

var data = {
    comment: 'a\nb\nc'
}

var template = `{{noLineBreak comment}}`;
console.log(Handlebars.compile(template)(data)); // 输出: 'a,b,c'

var template = `{{noLineBreak comment sep="*"}}`;
console.log(Handlebars.compile(template)(data)); // 输出: 'a*b*c'

prettifyComment

格式化注释, 在每一行的前面添加 *

var data = {
    comment: 'a\nb\nc'
}
var template = `{{prettifyComment this}}`;
console.log(Handlebars.compile(template)(data)); // 输出: ' * a\n * b\n * c'

typeName

获取类型名称, 如果它是数组, 则使用 [] 嵌套, 比如二维数组: String[][]。

也可以使用 List 嵌套, 比如二维数组: List<List>

var data = {
    type: 'String',
    arrDim: 2
}

var template = `{{typeName this}}`;
console.log(Handlebars.compile(template)(data)); // 输出: String[][]

template = `{{typeName this useList=true}}`;
console.log(Handlebars.compile(template)(data)); // 输出: List<List<String>>

// 也可以使用下面这种方式传入参数:

var template = `{{typeName type=this.type arrDim=this.arrDim}}`;
console.log(Handlebars.compile(template)(data)); // 输出: String[][]

var template = `{{typeName type=this.type arrDim=this.arrDim useList=true}}`;
console.log(Handlebars.compile(template)(data)); // 输出: List<List<String>>

upperFirst

将首字母大写

var data = {
    "name": "id"
}
var template = `{{upperFirst name}}`;
console.log(Handlebars.compile(template)(data)); // 输出: Id