feat: renderSync, parseAndRenderSync and renderFileSync, see #48

Author: harttle

.eslintrc.json

@@ -18,6 +18,7 @@
     "prefer-const": 2,
     "no-unused-vars": "off",
     "indent": "off",
+    "no-dupe-class-members": "off",
     "@typescript-eslint/indent": ["error", 2],
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/no-explicit-any": "off",

demo/nodejs/index.js

@@ -10,9 +10,9 @@ engine.registerTag('header', {
     const [key, val] = token.args.split(':')
     this[key] = val
   },
-  render: function (scope, hash) {
-    const title = this.liquid.evalValue(this.content, scope)
-    return `<h1>${title}</h1>`
+  render: async function (scope, hash, emitter) {
+    const title = await this.liquid.evalValue(this.content, scope)
+    emitter.write(`<h1>${title}</h1>`)
   }
 })
 

demo/typescript/index.ts

@@ -1,4 +1,4 @@
-import { Liquid, TagToken, Hash, Context } from 'liquidjs'
+import { Liquid, TagToken, Hash, Context, Emitter } from 'liquidjs'
 
 const engine = new Liquid({
   root: __dirname,
@@ -10,9 +10,9 @@ engine.registerTag('header', {
     const [key, val] = token.args.split(':')
     this[key] = val
   },
-  render: function (context: Context, hash: Hash) {
-    const title = this.liquid.evalValue(this['content'], context)
-    return `<h1>${title}</h1>`
+  render: async function (context: Context, hash: Hash, emitter: Emitter) {
+    const title = await this.liquid.evalValue(this['content'], context)
+    emitter.write(`<h1>${title}</h1>`)
   }
 })
 

src/builtin/tags/assign.ts

@@ -12,6 +12,8 @@ export default {
     this.value = match[2]
   },
   render: async function (ctx: Context) {
-    ctx.front()[this.key] = await this.liquid.evalValue(this.value, ctx)
+    ctx.front()[this.key] = ctx.sync
+      ? this.liquid.evalValueSync(this.value, ctx)
+      : await this.liquid.evalValue(this.value, ctx)
   }
 } as ITagImplOptions

src/builtin/tags/block.ts

@@ -17,9 +17,13 @@ export default {
   render: async function (ctx: Context, hash: Hash, emitter: Emitter) {
     const blocks = ctx.getRegister('blocks')
     const childDefined = blocks[this.block]
+    const r = this.liquid.renderer
     const html = childDefined !== undefined
       ? childDefined
-      : await this.liquid.renderer.renderTemplates(this.tpls, ctx)
+      : (ctx.sync
+        ? r.renderTemplatesSync(this.tpls, ctx)
+        : await r.renderTemplates(this.tpls, ctx)
+      )
 
     if (ctx.getRegister('blockMode', BlockMode.OUTPUT) === BlockMode.STORE) {
       blocks[this.block] = html

src/builtin/tags/break.ts

@@ -1,7 +1,7 @@
-import { RenderBreakError } from '../../util/error'
+import { Emitter, Context, Hash } from '../../types'
 
 export default {
-  render: async function () {
-    throw new RenderBreakError('break')
+  render: async function (ctx: Context, hash: Hash, emitter: Emitter) {
+    emitter.break = true
   }
 }

src/builtin/tags/capture.ts

@@ -21,7 +21,10 @@ export default {
     stream.start()
   },
   render: async function (ctx: Context) {
-    const html = await this.liquid.renderer.renderTemplates(this.templates, ctx)
+    const r = this.liquid.renderer
+    const html = ctx.sync
+      ? r.renderTemplatesSync(this.templates, ctx)
+      : await r.renderTemplates(this.templates, ctx)
     ctx.front()[this.variable] = html
   }
 } as ITagImplOptions

src/builtin/tags/case.ts

@@ -25,15 +25,30 @@ export default {
   },
 
   render: async function (ctx: Context, hash: Hash, emitter: Emitter) {
+    const r = this.liquid.renderer
     for (let i = 0; i < this.cases.length; i++) {
       const branch = this.cases[i]
-      const val = new Expression(branch.val).value(ctx)
-      const cond = new Expression(this.cond).value(ctx)
+      const val = await new Expression(branch.val).value(ctx)
+      const cond = await new Expression(this.cond).value(ctx)
       if (val === cond) {
-        this.liquid.renderer.renderTemplates(branch.templates, ctx, emitter)
+        await r.renderTemplates(branch.templates, ctx, emitter)
         return
       }
     }
-    this.liquid.renderer.renderTemplates(this.elseTemplates, ctx, emitter)
+    await r.renderTemplates(this.elseTemplates, ctx, emitter)
+  },
+
+  renderSync: function (ctx: Context, hash: Hash, emitter: Emitter) {
+    const r = this.liquid.renderer
+    for (let i = 0; i < this.cases.length; i++) {
+      const branch = this.cases[i]
+      const val = new Expression(branch.val).valueSync(ctx)
+      const cond = new Expression(this.cond).valueSync(ctx)
+      if (val === cond) {
+        r.renderTemplatesSync(branch.templates, ctx, emitter)
+        return
+      }
+    }
+    r.renderTemplatesSync(this.elseTemplates, ctx, emitter)
   }
 } as ITagImplOptions

src/builtin/tags/continue.ts

@@ -1,7 +1,7 @@
-import { RenderBreakError } from '../../util/error'
+import { Emitter, Context, Hash } from '../../types'
 
 export default {
-  render: async function () {
-    throw new RenderBreakError('continue')
+  render: async function (ctx: Context, hash: Hash, emitter: Emitter) {
+    emitter.continue = true
   }
 }

src/builtin/tags/cycle.ts

@@ -22,7 +22,9 @@ export default {
   },
 
   render: async function (ctx: Context, hash: Hash, emitter: Emitter) {
-    const group = this.group.value(ctx)
+    const group = ctx.sync
+      ? this.group.valueSync(ctx)
+      : await this.group.value(ctx)
     const fingerprint = `cycle:${group}:` + this.candidates.join(',')
     const groups = ctx.getRegister('cycle')
     let idx = groups[fingerprint]
@@ -34,6 +36,9 @@ export default {
     const candidate = this.candidates[idx]
     idx = (idx + 1) % this.candidates.length
     groups[fingerprint] = idx
-    emitter.write(new Expression(candidate).value(ctx))
+    const html = ctx.sync
+      ? new Expression(candidate).valueSync(ctx)
+      : await new Expression(candidate).value(ctx)
+    emitter.write(html)
   }
 } as ITagImplOptions