art-template 4.12.1 → 4.13.2

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## v4.13.2
+
+1. 修复 npm 包 index.d.ts 丢失的问题
+
+## v4.13.1
+
+1. 修复在某些情况 runtime 提示 window 未定义的问题 [#553](https://github.com/aui/art-template/issues/553)
+
+## v4.13.0
+
+1. 修复超大模板编译性能问题 [#539](https://github.com/aui/art-template/issues/539)、[#4](https://github.com/aui/express-art-template/issues/4)
+2. 支持嵌套 block [#468](https://github.com/aui/art-template/issues/468)
+
+## v4.12.2
+
+1. 修复 [#483](https://github.com/aui/art-template/issues/483)
+
 ## v4.12.1
 
 1. 修复过滤器不能使用包含空的格字符串参数的问题

package/README.md

@@ -6,34 +6,32 @@
 [![Travis-ci](https://travis-ci.org/aui/art-template.svg?branch=master)](https://travis-ci.org/aui/art-template)
 [![Coverage Status](https://coveralls.io/repos/github/aui/art-template/badge.svg?branch=master)](https://coveralls.io/github/aui/art-template?branch=master)
 
-art-template 是一个渲染性能出众模板引擎，无论在 NodeJS 还是在浏览器中都可以运行。
+[English document](https://aui.github.io/art-template/) | [中文文档](https://aui.github.io/art-template/zh-cn/index.html)
 
-文档：<https://aui.github.io/art-template/>
+art-template is a simple and superfast templating engine that optimizes template rendering speed by scope pre-declared technique, hence achieving runtime performance which is close to the limits of JavaScript. At the same time, it supports both NodeJS and browser. [speed test online](https://aui.github.io/art-template/rendering-test/).
 
-## 特性
+art-template 是一个简约、超快的模板引擎。它采用作用域预声明的技术来优化模板渲染速度，从而获得接近 JavaScript 极限的运行性能，并且同时支持 NodeJS 和浏览器。[在线速度测试](https://aui.github.io/art-template/rendering-test/)。
 
 [![chart](https://aui.github.io/art-template/images/chart@2x.png)](https://aui.github.io/art-template/rendering-test/)
 
+## Feature
 
-* 拥有接近 JavaScript 渲染极限的的性能
-* 调试友好：语法、运行时错误日志精确到模板所在行；支持支持在模板文件上打断点（Webpack Loader）
-* 支持压缩输出页面中的 HTML、CSS、JS 代码
-* 支持 Express、Koa、Webpack
-* 支持模板继承与子模板
-* 兼容 [EJS](http://ejs.co)、[Underscore](http://underscorejs.org/#template)、[LoDash](https://lodash.com/docs/#template) 模板语法
-* 模板编译后的代码支持在严格模式下运行
-* 支持 JavaScript 语句与模板语法混合书写
-* 支持自定义模板的语法解析规则
-* 浏览器版本仅 6KB 大小
-
-[art-template@4 新特性介绍](https://github.com/aui/art-template/issues/369)
+1. performance is close to the JavaScript rendering limits
+2. debugging friendly. Syntax errors or runtime errors will be positioned accurately at which line of template. Support setting breakpoint in templating files (Webpack Loader)
+3. support Express, Koa, Webpack
+4. support template inheritance and sub template
+5. browser version is only 6KB
 
-## 授权协议
+## 特性
 
-[MIT](./LICENSE)
+1. 拥有接近 JavaScript 渲染极限的的性能
+2. 调试友好：语法、运行时错误日志精确到模板所在行；支持在模板文件上打断点（Webpack Loader）
+5. 支持 Express、Koa、Webpack
+6. 支持模板继承与子模板
+7. 浏览器版本仅 6KB 大小
 
-------------------
+-----------------
 
-<img width="128" src="https://cloud.githubusercontent.com/assets/1791748/25561320/09c9d6d0-2d9c-11e7-8689-1109f3f88f41.png" alt="微信支付" />
+[捐助我](https://cloud.githubusercontent.com/assets/1791748/25561320/09c9d6d0-2d9c-11e7-8689-1109f3f88f41.png)(微信支付)
 
-赞助 art-template
+[\[AD\] 前端招聘：在海边写代码](https://juejin.im/post/5a2651d06fb9a0451c3a40ad)

package/index.d.ts

@@ -0,0 +1,109 @@
+declare type artTemplateDefaults = {
+  /**
+   * template name
+   */
+  filename?: string;
+  /**
+   * an array of rules of template syntax
+   */
+  rules: any[];
+  /**
+   * whether to automatically encode output statements of template. Setting false will close that functionality
+   * escape can prevent XSS attacks
+   */
+  excape: boolean;
+  /**
+   * enable debug mode. If true: {cache:false, minimize:false, compileDebug:true}
+   */
+  debug: boolean;
+  /**
+   * if bail is set true, compilation errors and runtime errors will throw exception
+   */
+  bail: boolean;
+  /**
+   * whether to enable caching
+   */
+  cache: boolean;
+  /**
+   * whether to enable minimization. It will execute htmlMinifier and minimize HTML, CSS, JS
+   * if template contains unclosing tags, please don't open minimize. Otherwise unclosing tags will be restored or filtered
+   */
+  minimize: boolean;
+
+  /**
+   * whether to compile in debug mode
+   */
+  compileDebug: boolean;
+  /**
+   * resolve template path
+   */
+  resolveFilename: any;
+  /**
+   * sub template compilation adapter
+   */
+  include: any,
+
+  /**
+   *  HTML minifier. Work only in NodeJS environment
+   */
+  htmlMinifier: any;
+
+  /**
+   * HTML minifier configuration. Refer to: https://github.com/kangax/html-minifier
+   */
+  htmlMinifierOptions: {
+    collapseWhitespace: boolean,
+    minifyCSS: boolean,
+    minifyJS: boolean,
+    // automatically merged at runtime: rules.map(rule => rule.test)
+    ignoreCustomFragments: any[]
+  };
+
+  /**
+   * error events. Work only if bail is false
+   */
+  onerror: any,
+
+  /**
+   * template file loader
+   */
+  loader: any,
+
+  /**
+   * cache center adapter (depend on filename field)
+   */
+  caches: any,
+
+  /**
+   * root directory of template. If filename field is not a local path, template will be found in root directory
+   * @default '/'
+   */
+  root: string;
+
+  /**
+   * @default '.art'
+   * default extension. If no extensions, extname will be automatically added
+   */
+  extname: string,
+
+  /**
+   * ignored variables. An array of template variables ignored by template compiler
+   */
+  ignore: any[],
+
+  // imported template variables
+  imports: { [key: string]: Function }
+}
+/**
+ *
+ * @param filenameOrTemplateId  [ for bowser ] id of template      [ for Node ] fileName of template
+ * @param content [ if is Object ] return compile result , [ if is string ] return compile Funtion
+ */
+declare function artTemplate(filenameOrTemplateId: string, content?: string | Object): any;
+declare namespace artTemplate {
+  export const defaults: artTemplateDefaults;
+  export const extension: { [key: string]: Function };
+  function render(source: string, data: any, options?: any): string;
+  function compile(source: string, options?: any): (data: any) => string;
+}
+export = artTemplate;

package/index.js

@@ -4,4 +4,4 @@ const extension = require('./lib/extension');
 template.extension = extension;
 require.extensions[template.defaults.extname] = extension;
 
-module.exports = template;
+module.exports = template;

package/lib/compile/adapter/extend.js

@@ -24,7 +24,7 @@ var extend = function extend(target, defaults) {
 
     if (object) {
         for (var index in target) {
-            if (target.hasOwnProperty(index)) {
+            if (Object.hasOwnProperty.call(target, index)) {
                 object[index] = extend(target[index], object[index]);
             }
         }

package/lib/compile/adapter/html-minifier.js

@@ -1,9 +1,11 @@
 'use strict';
 
-var detectNode = require('detect-node');
+function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } else { return Array.from(arr); } }
+
+var detectNode = typeof window === 'undefined';
 
 /**
- * HTML 压缩器 
+ * HTML 压缩器
  * @param  {string}     source
  * @param  {Object}     options
  * @return {string}
@@ -17,7 +19,7 @@ var htmlMinifier = function htmlMinifier(source, options) {
         var ignoreCustomFragments = options.rules.map(function (rule) {
             return rule.test;
         });
-        (_htmlMinifierOptions$ = htmlMinifierOptions.ignoreCustomFragments).push.apply(_htmlMinifierOptions$, ignoreCustomFragments);
+        (_htmlMinifierOptions$ = htmlMinifierOptions.ignoreCustomFragments).push.apply(_htmlMinifierOptions$, _toConsumableArray(ignoreCustomFragments));
         source = _htmlMinifier(source, htmlMinifierOptions);
     }
 

package/lib/compile/adapter/loader.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var detectNode = require('detect-node');
+var detectNode = typeof window === 'undefined';
 
 /**
  * 读取模板内容（同步方法）

package/lib/compile/adapter/resolve-filename.js

@@ -1,16 +1,15 @@
 'use strict';
 
-var detectNode = require('detect-node');
+var detectNode = typeof window === 'undefined';
 var LOCAL_MODULE = /^\.+\//;
 
 /**
  * 获取模板的绝对路径
- * @param   {string} filename 
- * @param   {Object} options 
+ * @param   {string} filename
+ * @param   {Object} options
  * @return  {string}
  */
 var resolveFilename = function resolveFilename(filename, options) {
-
     /* istanbul ignore else  */
     if (detectNode) {
         var path = require('path');

package/lib/compile/adapter/rule.art.js

@@ -6,7 +6,6 @@
 var artRule = {
     test: /{{([@#]?)[ \t]*(\/?)([\w\W]*?)[ \t]*}}/,
     use: function use(match, raw, close, code) {
-
         var compiler = this;
         var options = compiler.options;
         var esTokens = compiler.getEsTokens(code);
@@ -30,20 +29,16 @@ var artRule = {
         }
 
         switch (key) {
-
             case 'set':
-
                 code = 'var ' + values.join('').trim();
                 break;
 
             case 'if':
-
                 code = 'if(' + values.join('').trim() + '){';
 
                 break;
 
             case 'else':
-
                 var indexIf = values.indexOf('if');
 
                 if (~indexIf) {
@@ -56,12 +51,10 @@ var artRule = {
                 break;
 
             case '/if':
-
                 code = '}';
                 break;
 
             case 'each':
-
                 group = artRule._split(esTokens);
                 group.shift();
 
@@ -80,19 +73,16 @@ var artRule = {
                 break;
 
             case '/each':
-
                 code = '})';
                 break;
 
             case 'block':
-
                 group = artRule._split(esTokens);
                 group.shift();
                 code = 'block(' + group.join(',').trim() + ',function(){';
                 break;
 
             case '/block':
-
                 code = '})';
                 break;
 
@@ -102,7 +92,6 @@ var artRule = {
             case 'print':
             case 'include':
             case 'extend':
-
                 if (values.join('').trim().indexOf('(') !== 0) {
                     // 执行函数省略 `()` 与 `,`
                     group = artRule._split(esTokens);
@@ -112,9 +101,7 @@ var artRule = {
                 }
 
             default:
-
                 if (~values.indexOf('|')) {
-
                     var v3split = ':'; // ... v3 compat ...
 
                     // 将过滤器解析成二维数组
@@ -163,7 +150,6 @@ var artRule = {
     // 支持基本运算、三元表达式、取值、运行函数，不支持 `typeof value` 操作
     // 只支持 string、number、boolean、null、undefined 这几种类型声明，不支持 function、object、array
     _split: function _split(esTokens) {
-
         esTokens = esTokens.filter(function (_ref) {
             var type = _ref.type;
 

package/lib/compile/adapter/rule.native.js

@@ -6,7 +6,6 @@
 var nativeRule = {
     test: /<%(#?)((?:==|=#|[=-])?)[ \t]*([\w\W]*?)[ \t]*(-?)%>/,
     use: function use(match, comment, output, code /*, trimMode*/) {
-
         output = {
             '-': 'raw',
             '=': 'escape',