feat: support custom key-value separator, #752

Author: Yang Jun

src/liquid-options.ts

@@ -68,6 +68,8 @@ export interface LiquidOptions {
   greedy?: boolean;
   /** `fs` is used to override the default file-system module with a custom implementation. */
   fs?: FS;
+  /** keyValue separator */
+  keyValueSeparator?: string;
   /** Render from in-memory `templates` mapping instead of file system. File system related options like `fs`, 'root', and `relativeReference` will be ignored when `templates` is specified. */
   templates?: {[key: string]: string};
   /** the global scope passed down to all partial and layout templates, i.e. templates included by `include`, `layout` and `render` tags. */
@@ -166,6 +168,7 @@ export const defaultOptions: NormalizedFullOptions = {
   partials: ['.'],
   relativeReference: true,
   jekyllInclude: false,
+  keyValueSeparator: ':',
   cache: undefined,
   extname: '',
   fs: fs,

src/parser/tokenizer.ts

@@ -1,6 +1,6 @@
 import { FilteredValueToken, TagToken, HTMLToken, HashToken, QuotedToken, LiquidTagToken, OutputToken, ValueToken, Token, RangeToken, FilterToken, TopLevelToken, PropertyAccessToken, OperatorToken, LiteralToken, IdentifierToken, NumberToken } from '../tokens'
 import { OperatorHandler } from '../render/operator'
-import { TrieNode, LiteralValue, Trie, createTrie, ellipsis, literalValues, TokenizationError, TYPES, QUOTE, BLANK, NUMBER, SIGN, isWord } from '../util'
+import { TrieNode, LiteralValue, Trie, createTrie, ellipsis, literalValues, TokenizationError, TYPES, QUOTE, BLANK, NUMBER, SIGN, isWord, isString } from '../util'
 import { Operators, Expression } from '../render'
 import { NormalizedFullOptions, defaultOptions } from '../liquid-options'
 import { FilterArg } from './filter-arg'
@@ -261,7 +261,7 @@ export class Tokenizer {
     return this.readIdentifier().getText()
   }
 
-  readHashes (jekyllStyle?: boolean) {
+  readHashes (jekyllStyle?: boolean | string) {
     const hashes = []
     while (true) {
       const hash = this.readHash(jekyllStyle)
@@ -270,7 +270,7 @@ export class Tokenizer {
     }
   }
 
-  readHash (jekyllStyle?: boolean): HashToken | undefined {
+  readHash (jekyllStyle?: boolean | string): HashToken | undefined {
     this.skipBlank()
     if (this.peek() === ',') ++this.p
     const begin = this.p
@@ -279,7 +279,7 @@ export class Tokenizer {
     let value
 
     this.skipBlank()
-    const sep = jekyllStyle ? '=' : ':'
+    const sep = isString(jekyllStyle) ? jekyllStyle : (jekyllStyle ? '=' : ':')
     if (this.peek() === sep) {
       ++this.p
       value = this.readValue()

src/tags/for.ts

@@ -25,7 +25,7 @@ export default class extends Tag {
 
     this.variable = variable.content
     this.collection = collection
-    this.hash = new Hash(this.tokenizer.remaining())
+    this.hash = new Hash(this.tokenizer.remaining(), liquid.options.keyValueSeparator)
     this.templates = []
     this.elseTemplates = []
 

src/tags/include.ts

@@ -21,7 +21,7 @@ export default class extends Tag {
       } else tokenizer.p = begin
     } else tokenizer.p = begin
 
-    this.hash = new Hash(tokenizer.remaining(), this.liquid.options.jekyllInclude)
+    this.hash = new Hash(tokenizer.remaining(), liquid.options.jekyllInclude || liquid.options.keyValueSeparator)
   }
   * render (ctx: Context, emitter: Emitter): Generator<unknown, void, unknown> {
     const { liquid, hash, withVar } = this

src/tags/layout.ts

@@ -12,7 +12,7 @@ export default class extends Tag {
     super(token, remainTokens, liquid)
     this.file = parseFilePath(this.tokenizer, this.liquid, parser)
     this['currentFile'] = token.file
-    this.args = new Hash(this.tokenizer.remaining())
+    this.args = new Hash(this.tokenizer.remaining(), liquid.options.keyValueSeparator)
     this.templates = parser.parseTokens(remainTokens)
   }
   * render (ctx: Context, emitter: Emitter): Generator<unknown, unknown, unknown> {

src/tags/render.ts

@@ -45,7 +45,7 @@ export default class extends Tag {
       tokenizer.p = begin
       break
     }
-    this.hash = new Hash(tokenizer.remaining())
+    this.hash = new Hash(tokenizer.remaining(), liquid.options.keyValueSeparator)
   }
   * render (ctx: Context, emitter: Emitter): Generator<unknown, void, unknown> {
     const { liquid, hash } = this

src/tags/tablerow.ts

@@ -21,7 +21,7 @@ export default class extends Tag {
 
     this.variable = variable.content
     this.collection = collectionToken
-    this.args = new Hash(this.tokenizer.remaining())
+    this.args = new Hash(this.tokenizer.remaining(), liquid.options.keyValueSeparator)
     this.templates = []
 
     let p

src/template/hash.spec.ts

@@ -39,4 +39,8 @@ describe('Hash', function () {
       num3: 4
     })
   })
+  it('should support custom separator', async function () {
+    const hash = await toPromise(new Hash('num=2.3', '=').render(new Context()))
+    expect(hash.num).toBe(2.3)
+  })
 })

src/template/hash.ts

@@ -15,7 +15,7 @@ type HashValueTokens = Record<string, Token | undefined>
  */
 export class Hash {
   hash: HashValueTokens = {}
-  constructor (markup: string, jekyllStyle?: boolean) {
+  constructor (markup: string, jekyllStyle?: boolean | string) {
     const tokenizer = new Tokenizer(markup, {})
     for (const hash of tokenizer.readHashes(jekyllStyle)) {
       this.hash[hash.name.content] = hash.value

src/template/tag-options-adapter.ts

@@ -21,7 +21,7 @@ export function createTagClass (options: TagImplOptions): TagClass {
       }
     }
     * render (ctx: Context, emitter: Emitter): TagRenderReturn {
-      const hash = (yield new Hash(this.token.args).render(ctx)) as Record<string, any>
+      const hash = (yield new Hash(this.token.args, ctx.opts.keyValueSeparator).render(ctx)) as Record<string, any>
       return yield options.render.call(this, ctx, emitter, hash)
     }
   }