mikebridge / liquid.net

.Net Port of the Liquid template language

Liquid.NET

Liquid.NET is a C# port of the Liquid templating language.

It can be downloaded via NuGet. There's more information on the Liquid.NET Wiki.

Start from zero with the Quick Start wiki page.

Liquid.NET targets netstandard2.0 and net452.

Liquid.NET is an independent project and I am not affiliated in any way with Shopify.

liquid.net's Issues

Capture does not allow captured template fragment to modify global state

When array is four items, this should return "odd even odd even". However, it returns "odd odd odd odd", because the capture tag does not allow the cycle tag to write to global state.

{% for item in array %}{% capture thecycle %}{% cycle 'odd', 'even' %}{% endcapture %}{{ thecycle }} {% endfor %}

This also affects the "macro" tag.

Document differences from Dotliquid in readme

http://dotliquidmarkup.org/

Add syntactic sugar for initializing constants

... to remove the leaky abstraction of using the internal types for Dictionaries and Lists in DictionaryValue and ArrayValue.

Propagate error-handling changes to test-generation template

Update tests.liquid with the updated error handling code and regenerate the Ruby-compatibility tests.

Pluralize filter should not include the number

{{ 3 | pluralize: 'item', 'items' }} should just print "items", not "3 items", as per https://docs.shopify.com/themes/liquid-documentation/filters/string-filters#pluralize

Liquid Templates do not parse decimals in CultureInvariant

{{ 10.0 | divided_by: 4 }} results in divide by zero error when current culture is e.g. "fr-CA"

Horizontally-nested arrays do not work

This does not currently parse:

a[b][c]

But this does:

a[b[c]]

Ignore static properties in LiquidValueConverter

The current implementation of the LiquidValueConverter includes static properties from classes, which is probably not intended (at least it was not expected behavior when we tried using it).

Example class:

public class ViewModel
{
    public string Title { get; set; }
    public static string OtherData { get; set; }
}

Code sample:

ViewModel.OtherData = "aaa";
var liquid = new ViewModel() { Title = "bbb" }.ToLiquid();

Expected result:

After executing the code sample, the liquid object should only include the Title property.

Observed result:

After executing the code sample, the liquid object includes both the Title property and the OtherData property.

Default filter needs to return default on empty string

The default filter implements the erroneous description in the Shopify documentation, rather than the actual functionality introduced here

Liquid c# context initialize variable with T type

ITemplateContext ctx = new TemplateContext(); List<Orders> ProductList = new List<Orders> { new Orders {OrderId = 1,ProductName="Some name",Quantity =30}, new Orders {OrderId = 1,ProductName="Some name1",Quantity =30}, new Orders {OrderId = 1,ProductName="Some name2",Quantity =30} }; ctx.DefineLocalVariable("context", new LiquidCollection(ProductList));

Define Liquid Collection with List throws error. Is it possible to define T type generic collection as ITemplateContext-> LocalVariable

Add simple POCO-to-LiquidHash translator

It would be nice to have a simple POCO-to-LiquidHash translator that

• works recursively
• takes int, decimals, String, IDictionary, IList/IEnumerable, etc. properties and other POCOs and maps them to the Liquid* classes.
• has attributes to exclude properties and rename them.

TemplateContext.Registers is separate from the stack

The global registers should be in the base of the symboltable stack.

Macros should take part in the caching scheme

Template, include and macro caching should use the same mechanism.

Describe Options, LiquidHash and LiquidCollections in Wiki

Add some options for mapping POCO fields into a LiquidHash via .ToLiquid()

Right now it calls .ToLower on everything.

Create more useful errors for bad syntax in LiquidTests

See: LiquidTests.It_Should_Generate_An_Exception

Fix "Registry" should be "Registers"

Liquid calls the hash of user-defined, internally-available variables Registers.

https://github.com/Shopify/liquid/blob/master/lib/liquid/template.rb#L125

This should be changed in the TemplateContext to keep the terminology consistent.

Json dump of a liquid hash is invalid.

Currently whenever I dump a liquid hash, it serializes empty enumerables into nothing. Also, enumerables aren't wrapped in brackets, and each item in the list isn't being separated from the next with a comma.

Example:
{ facets: , results: { name: 'Test' } { name: 'Test2' } }

Expected value:
{ facets: [], results: [{ name: 'Test' }, { name: 'Test2' }] }

Target netcoreapp1.1 and net462

Move to xunit

Having enough problems with dotnet core and nunit to warrant switching horses.

Upadte Antlr4.Runtime to 4.5

Blank check on LiquidString that wraps null generates null ptr exception

Even though there shouldn't be a LiquidString that wraps a null.

TODO: examine adding a null check in the LiquidString constructor.

Add ability to assign value to hash

{% assign myhash.newvalue = 1 %} should add/update a value in a hash. Similarly,{% assign myhash.mysubhash.newvalue = 1 %} should work as expected.

Assigning to a non-existent value or a non-hash should generate an error.

This should work for capture too.

(Note: This is not a feature of Shopify Liquid)

Errors can be observed, not just caught.

Allow parser errors and rendering errors to be captured with an action.

Whitespace control

Is there a way to suppress line breaks after tags?

Add some syntactic sugar to handle errors less verbosely

e.g. .OnParsingError, .OnRenderingError on LiquidRenderingResult and .OnError on LiquidParsingResult

Can I have template context from POCO?

As in POCO defines top level variables.

Indexing a String by property name should return an error in ErrorWhenMissing mode

A LiquidString should generate a rendering error when ErrorWhenMissing() is on, and the property is not a LiquidNumeric value and it isn't a "special" property like .first, .last or .size.

Should work:

{{ mystring.last }}
{{ mystring[0] }}

Should not work:

{{ mystring.foo }}

Remove IsTrue from Constant values

replace with centralized logic for "is nil or false"

Remove ability to wrap null strings in LiquidString

Now Strings must be created via the factory method LiquidString.Create(String str). This enforces the LiquidString.StringValue to be non-null. The factory method will return null if the string value is null.

This also allows a programmer to take advantage of type-inferencing on methods that accept an Option, because passing null will automatically be promoted to Option.

Upgrade Appveyor

Get Appveyor, OpenCover + XUnit + netcoreapp1.1 + CodeCov working

Rename the types

After reworking the DictionaryValue and ArrayValue types, which subclass IExpressionConstant, they should really be named to correspond more closely with liquid types, e.g. LiquidHash, LiquidCollection, etc.

Liquid template convert to json from object

` List ProductList = new List
{
new Orders {OrderId = 1,ProductName="Some name",Quantity =30},
new Orders {OrderId = 1,ProductName="Some name1",Quantity =30},
new Orders {OrderId = 1,ProductName="Some name2",Quantity =30}
};

        ctx.DefineLocalVariable("content", ProductList.ToLiquid());

        // Note that you will still get a best-guess LiquidTemplate, even if you encounter errors.
        var liquidTemplate = LiquidTemplate.Create(@"[
            {% for sales in content %}
                        {
                            ""SalesId"": ""{{sales.OrderId}}"",
               ""ProductName"": ""{{sales.ProductName}}"",
               ""Quantity"": ""{{sales.Quantity}}""
                        },
            {% endfor %}
            ]").OnParsingError(errors.Add)
            .LiquidTemplate;`

Parsing Liquid object to json . No conversion done.

Add the ability to treat missing variable references as an error

See: Shopify/liquid#490