docs: state differences regarding inspect array/hash, #852, #853

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

.all-contributorsrc

@@ -766,6 +766,24 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "immerrr",
+      "name": "immerrr again",
+      "avatar_url": "https://avatars.githubusercontent.com/u/579798?v=4",
+      "profile": "https://github.com/immerrr",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "rongjiecomputer",
+      "name": "Loo Rong Jie",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13115060?v=4",
+      "profile": "https://github.com/rongjiecomputer",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -213,6 +213,10 @@ Want to contribute? see [Contribution Guidelines][contribution]. Thanks goes to
       <td align="center" valign="top" width="14.28%"><a href="https://www.streakingman.com"><img src="https://avatars.githubusercontent.com/u/30397306?v=4?s=100" width="100px;" alt="裸奔狂甩丁丁"/><br /><sub><b>裸奔狂甩丁丁</b></sub></a><br /><a href="https://github.com/harttle/liquidjs/commits?author=StreakingMan" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/skynetigor"><img src="https://avatars.githubusercontent.com/u/20903171?v=4?s=100" width="100px;" alt="Ihor Panasiuk"/><br /><sub><b>Ihor Panasiuk</b></sub></a><br /><a href="https://github.com/harttle/liquidjs/commits?author=skynetigor" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/rosomri"><img src="https://avatars.githubusercontent.com/u/68001413?v=4?s=100" width="100px;" alt="Omri Rosner"/><br /><sub><b>Omri Rosner</b></sub></a><br /><a href="https://github.com/harttle/liquidjs/commits?author=rosomri" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/immerrr"><img src="https://avatars.githubusercontent.com/u/579798?v=4?s=100" width="100px;" alt="immerrr again"/><br /><sub><b>immerrr again</b></sub></a><br /><a href="https://github.com/harttle/liquidjs/commits?author=immerrr" title="Documentation">📖</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rongjiecomputer"><img src="https://avatars.githubusercontent.com/u/13115060?v=4?s=100" width="100px;" alt="Loo Rong Jie"/><br /><sub><b>Loo Rong Jie</b></sub></a><br /><a href="https://github.com/harttle/liquidjs/commits?author=rongjiecomputer" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

docs/source/tutorials/differences.md

@@ -24,6 +24,7 @@ Though we're trying to be compatible with the Ruby version, there are still some
 
 * Truthy and Falsy. All values except `undefined`, `null`, `false` are truthy, whereas in Ruby Liquid all except `nil` and `false` are truthy. See [#26][#26].
 * Number. In JavaScript we cannot distinguish or convert between `float` and `integer`, see [#59][#59]. And when applied `size` filter, numbers always return 0, which is 8 for integer in ruby, cause they do not have a `length` property.
+* Stringify: We've aligned string coercion for primitive types. While some differences remain; for example, in Shopify/liquid, `strip` returns the "inspected" string of an input array, whereas in LiquidJS, the `strip` filter simply stringifies the input array [#852][#852].
 * [.to_liquid()](https://github.com/Shopify/liquid/wiki/Introduction-to-Drops) is replaced by `.toLiquid()`
 * [.to_s()](https://www.rubydoc.info/gems/liquid/Liquid/Drop) is replaced by JavaScript `.toString()`
 * Iteration order for objects. The iteration order of JavaScript objects, and thus LiquidJS objects, is a combination of the insertion order for string keys, and ascending order for number-like keys, while the iteration order of Ruby Hash is simply the insertion order.
@@ -47,6 +48,7 @@ Though we're trying to be compatible with the Ruby version, there are still some
 [#236]: https://github.com/harttle/liquidjs/issues/236
 [#414]: https://github.com/harttle/liquidjs/discussions/414
 [#485]: https://github.com/harttle/liquidjs/discussions/485
+[#852]: https://github.com/harttle/liquidjs/discussions/852
 [sort]: https://liquidjs.com/filters/sort.html
 [stable-sort]: https://v8.dev/features/stable-sort
 [plugins]: ./plugins.html#Plugin-List

docs/source/tutorials/operators.md

@@ -5,17 +5,64 @@ title: Operators
 LiquidJS operators are very simple and different. There're 2 types of operators supported:
 
 * Comparison operators: `==`, `!=`, `>`, `<`, `>=`, `<=`
-* Logic operators: `or`, `and`, `contains`
+* Logic operators: `not`, `or`, `and`, `contains`
 
 Thus numerical operators are not supported and you cannot even plus two numbers like this `{% raw %}{{a + b}}{% endraw %}`, instead we need a filter `{% raw %}{{ a | plus: b}}{% endraw %}`. Actually `+` is a valid variable name in LiquidJS.
 
+## Logic Operators
+
+### not
+
+Negates a condition. Returns `true` if the condition is false, and `false` if the condition is true.
+
+Input
+```liquid
+{% if not user.active %}
+  User is inactive
+{% endif %}
+```
+
+### and
+
+Returns `true` if both conditions are true.
+
+Input
+```liquid
+{% if user.age >= 18 and user.verified %}
+  Access granted
+{% endif %}
+```
+
+### or
+
+Returns `true` if at least one condition is true.
+
+Input
+```liquid
+{% if user.isAdmin or user.isModerator %}
+  You have elevated privileges
+{% endif %}
+```
+
+### contains
+
+Checks if a string contains a substring, or if an array contains an element.
+
+Input
+```liquid
+{% if product.title contains "Pack" %}
+  This is a pack
+{% endif %}
+```
+
 ## Precedence
 
-1. Comparison operators. All comparison operations have the same precedence and higher than logic operators.
-2. Logic operators. All logic operators have the same precedence.
+1. Comparison operators, and `contains`. All comparison operators alongside `contains` have the same (highest) precedence.
+2. `not` operator. It has slightly more precedence than `or` and `and`.
+3. `or` and `and` operators. These logic operators have the same (lowest) precedence.
 
 ## Associativity
 
 Logic operators are evaluated from right to left, see [shopify docs][operator-order].
 
-[operator-order]: https://help.shopify.com/en/themes/liquid/basics/operators#order-of-operations
+[operator-order]: https://shopify.dev/docs/api/liquid/basics#order-of-operations

docs/source/zh-cn/tutorials/differences.md

@@ -24,6 +24,7 @@ LiquidJS 一直很重视兼容于 Ruby 版本的 Liquid。Liquid 模板语言最
 
 * 真和假。在 LiquidJS 中 `undefined`, `null`, `false` 是假，之外的都是真；在 Ruby 中 `nil` 和 `false` 是假，其他都是真。见 [#26][#26]。
 * 数字。JavaScript 不区分浮点数和整数，因此缺失一部分整数算术，见 [#59][#59]。此外 `size` 过滤器作用于数字时总是返回零，而不是 Ruby 中的浮点数或整数的内存大小。
+* 输出字符串。基本类型的输出已经和 Shopify/liquid 对齐，但是仍然存在一些区别。比如在 Shopify/liquid 中 `strip` 会返回 inspect 字符串，但 LiquidJS `strip` 只是简单地把输入转换为字符串 [#852][#852]。
 * Drop 中的 [.to_liquid()](https://github.com/Shopify/liquid/wiki/Introduction-to-Drops) 替换为 `.toLiquid()`。
 * 数据的 [.to_s()](https://www.rubydoc.info/gems/liquid/Liquid/Drop) 替换为 `.toString()`。
 * 对象的迭代顺序。JavaScript 对象的迭代顺序是插入顺序和数字键递增顺序的组合，但 Ruby Hash 中只是插入顺序（JavaScript 字面量 Object 和 Ruby 字面量 Hash 的插入顺序解释也不同）。
@@ -46,6 +47,7 @@ LiquidJS 一直很重视兼容于 Ruby 版本的 Liquid。Liquid 模板语言最
 [#236]: https://github.com/harttle/liquidjs/issues/236
 [#414]: https://github.com/harttle/liquidjs/discussions/414
 [#485]: https://github.com/harttle/liquidjs/discussions/485
+[#852]: https://github.com/harttle/liquidjs/discussions/852
 [sort]: https://liquidjs.com/filters/sort.html
 [stable-sort]: https://v8.dev/features/stable-sort
 [plugins]: ./plugins.html#插件列表

docs/source/zh-cn/tutorials/operators.md

@@ -5,14 +5,61 @@ title: 运算符
 LiquidJS 运算符非常简单也很特别，只支持两类运算符：
 
 * 比较运算符：`==`, `!=`, `>`, `<`, `>=`, `<=`
-* 逻辑运算符：`or`, `and`, `contains`
+* 逻辑运算符：`not`, `or`, `and`, `contains`
 
 因此普通的数学运算是不支持的，比如 `{% raw %}{{a + b}}{% endraw %}`。它的替代方案是过滤器 `{% raw %}{{ a | plus: b}}{% endraw %}`。事实上 `+` 在 LiquidJS 中是一个合法的变量名。
 
+## 逻辑运算符
+
+### not
+
+对条件取反。如果条件为假则返回 `true`，如果条件为真则返回 `false`。
+
+输入
+```liquid
+{% if not user.active %}
+  用户未激活
+{% endif %}
+```
+
+### and
+
+当两个条件都为真时返回 `true`。
+
+输入
+```liquid
+{% if user.age >= 18 and user.verified %}
+  允许访问
+{% endif %}
+```
+
+### or
+
+当至少一个条件为真时返回 `true`。
+
+输入
+```liquid
+{% if user.isAdmin or user.isModerator %}
+  您拥有提升的权限
+{% endif %}
+```
+
+### contains
+
+检查字符串是否包含子字符串，或数组是否包含元素。
+
+输入
+```liquid
+{% if product.title contains "Pack" %}
+  这是一个套装
+{% endif %}
+```
+
 ## 优先级
 
-1. 比较运算符。所有比较运算符具有同样的优先级，且高于逻辑运算符。
-2. 逻辑运算符。所有逻辑运算符具有同样的有衔接。
+1. 比较运算符和 `contains`。所有比较运算符和 `contains` 具有同样的（最高）优先级。
+2. `not` 运算符。它的优先级略高于 `or` 和 `and`。
+3. `or` 和 `and` 运算符。这些逻辑运算符具有同样的（最低）优先级。
 
 ## 结合性
 

src/index.ts

@@ -2,16 +2,20 @@
 export const version = '[VI]{version}[/VI]'
 export * as TypeGuards from './util/type-guards'
 export { toValue, createTrie, Trie, toPromise, toValueSync, assert, LiquidError, ParseError, RenderError, UndefinedVariableError, TokenizationError, AssertionError } from './util'
+export type { LiquidErrors } from './util/error'
 export { Drop } from './drop'
+export type { Comparable } from './drop'
 export { Emitter } from './emitters'
 export { defaultOperators, Operators, evalToken, evalQuotedToken, Expression, isFalsy, isTruthy } from './render'
 export { Context, Scope } from './context'
 export { Value, Hash, Template, FilterImplOptions, Tag, Filter, Output, Variable, VariableLocation, VariableSegments, Variables, StaticAnalysis, StaticAnalysisOptions, analyze, analyzeSync, Arguments, PartialScope } from './template'
+export type { TagRenderReturn } from './template'
 export { Token, TopLevelToken, TagToken, ValueToken } from './tokens'
 export type { RangeToken, LiteralToken, QuotedToken, PropertyAccessToken, NumberToken } from './tokens'
 export { TokenKind, Tokenizer, ParseStream, Parser } from './parser'
 export { filters } from './filters'
 export * from './tags'
-export { defaultOptions, LiquidOptions } from './liquid-options'
-export { FS } from './fs'
+export { defaultOptions } from './liquid-options'
+export type { LiquidOptions, RenderOptions, RenderFileOptions } from './liquid-options'
+export { FS, LookupType } from './fs'
 export { Liquid } from './liquid'

src/parser/tokenizer.ts

@@ -422,7 +422,7 @@ export class Tokenizer {
 
   * readFileNameTemplate (options: NormalizedFullOptions): IterableIterator<TopLevelToken> {
     const { outputDelimiterLeft } = options
-    const htmlStopStrings = [',', ' ', outputDelimiterLeft]
+    const htmlStopStrings = [',', ' ', '\r', '\n', '\t', outputDelimiterLeft]
     const htmlStopStringSet = new Set(htmlStopStrings)
     // break on ',' and ' ', outputDelimiterLeft only stops HTML token
     while (this.p < this.N && !htmlStopStringSet.has(this.peek())) {

test/integration/tags/include.spec.ts

@@ -265,6 +265,14 @@ describe('tags/include', function () {
       const html = liquid.renderFileSync('/current.html')
       return expect(html).toBe('FOO-')
     })
+    it('should support Jekyll style include with other whitespace before filename', function () {
+      mock({
+        '/current.html': '{% include bar/foo.html\r\n\ntitle="TITLE"\tcontent="FOO" %}',
+        '/bar/foo.html': '{{include.title}}={{include.content}}-{{content}}'
+      })
+      const html = liquid.renderFileSync('/current.html')
+      return expect(html).toBe('TITLE=FOO-')
+    })
     it('should support multiple parameters', function () {
       mock({
         '/current.html': '{% include bar/foo.html header="HEADER" content="CONTENT" %}',