Scriban 5.10.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package Scriban --version 5.10.0
NuGet\Install-Package Scriban -Version 5.10.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Scriban" Version="5.10.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Scriban --version 5.10.0
#r "nuget: Scriban, 5.10.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Scriban as a Cake Addin
#addin nuget:?package=Scriban&version=5.10.0

// Install Scriban as a Cake Tool
#tool nuget:?package=Scriban&version=5.10.0

scriban Build Status Coverage Status NuGet

<img align="right" width="160px" height="160px" src="img/scriban.png">

Scriban is a fast, powerful, safe and lightweight scripting language and engine for .NET, which was primarily developed for text templating with a compatibility mode for parsing liquid templates.

Today, not only Scriban can be used in text templating scenarios, but also can be integrated as a general scripting engine: For example, Scriban is at the core of the scripting engine for kalk, a command line calculator application for developers.

// Parse a scriban template
var template = Template.Parse("Hello {{name}}!");
var result = template.Render(new { Name = "World" }); // => "Hello World!" 

Parse a Liquid template using the Liquid language:

// Parse a liquid template
var template = Template.ParseLiquid("Hello {{name}}!");
var result = template.Render(new { Name = "World" }); // => "Hello World!" 

The language is very versatile, easy to read and use, similar to liquid templates:

var template = Template.Parse(@"
<ul id='products'>
  {{ for product in products }}
    <li>
      <h2>{{ product.name }}</h2>
           Price: {{ product.price }}
           {{ product.description | string.truncate 15 }}
    </li>
  {{ end }}
</ul>
");
var result = template.Render(new { Products = this.ProductList });

Scriban can also be used in pure scripting context without templating ({{ and }}) and can help you to create your own small DSL.

NOTICE

By default, Properties and methods of .NET objects are automatically exposed with lowercase and _ names. It means that a property like MyMethodIsNice will be exposed as my_method_is_nice. This is the default convention, originally to match the behavior of liquid templates. If you want to change this behavior, you need to use a MemberRenamer delegate

New in 3.0+

  • AST is now fully visitable with ScriptVisitor. You can now access Parent on any ScriptNode object and navigate the AST.
    • Improve AST round-trip by preserving whitespaces around template enter{{ and exit}}
  • Several new language features:
    • Hexadecimal/binary numbers: 0x1ef or 0b101010
    • Support for large integers
    • New parametric functions: func sub(x,y = 1, z...); ret x - y - z[0]; end
    • New inline functions: sub(x,y) = x - y
    • Optional member access with ?. instead of regular . (e.g a?.b?.c)
    • Conditional expressions: cond ? a : b
  • Separate language mode (via ScriptLang enum) from template/scripting parsing mode (ScriptMode).
  • New language parsing mode Scientific, in addition to default Scriban and Liquid language mode.
  • More fine-grained options on the TemplateContext to define scripting behaviors (EnableRelaxedTargetAccess, EnableRelaxedMemberAccess, EnableRelaxedFunctionAccess, EnableRelaxedIndexerAccess, EnableNullIndexer)
  • New object.eval and object.eval_template function to evaluate Scriban expressions/templates at runtime.
  • Better support for IFormattable objects.

Features

  • An extensible sandbox execution model: You have the full control about which Scripting objects (and so properties and methods) are accessible from Scriban templates.
  • Very efficient, fast parser and a lightweight runtime. CPU and Garbage Collector friendly.
  • Powered by a Lexer/Parser providing a full Abstract Syntax Tree, fast, versatile and robust, more efficient than regex based parsers.
    • Precise source code location (path, column and line) for error reporting
    • Write an AST to a script textual representation, with Template.ToText, allowing to manipulate scripts in memory and re-save them to the disk, useful for roundtrip script update scenarios
  • Compatible with liquid by using the Template.ParseLiquid method
    • While the liquid language is less powerful than scriban, this mode allows to migrate from liquid to scriban language easily
    • With the AST to text mode, you can convert a liquid script to a scriban script using Template.ToText on a template parsed with Template.ParseLiquid
    • As the liquid language is not strictly defined and there are in fact various versions of liquid syntax, there are restrictions while using liquid templates with scriban, see the document liquid support in scriban for more details.
  • Extensible runtime providing many extensibility points
  • Support for async/await evaluation of scripts (e.g Template.RenderAsync)
  • Precise control of whitespace text output
  • Full featured language including if/else/for/while, expressions (x = 1 + 2), conditions... etc.
  • Function calls and pipes (myvar | string.capitalize)
  • Complex objects (javascript/json like objects x = {mymember: 1}) and arrays (e.g x = [1,2,3,4])
  • Allow to pass a block of statements to a function, typically used by the wrap statement
  • Several built-in functions:
  • Multi-line statements without having to embrace each line by {{...}}
  • Safe parser and safe runtime, allowing you to control what objects and functions are exposed

Syntax Coloring

You can install the Scriban Extension for Visual Studio Code to get syntax coloring for scriban scripts (without HTML) and scriban html files.

Documentation

Binaries

Scriban is available as a NuGet package: NuGet

Compatible with the following .NET Standard 2.0+ (New in 3.0)

For support for older framework (.NET 3.5, 4.0, 4.5, .NET Standard 1.1, 1.3, they are only provided in older Scriban 2.x, which is no longer supported.

Also the Scriban.Signed NuGet package provides signed assemblies.

Source Embedding

Starting with Scriban 3.2.1+, the package comes with source included so that you can internalize your usage of Scriban into your project. This can be useful in an environment where you can't easily consume NuGet references (e.g Roslyn Source Generators).

WARNING: Currently, the Scriban sources are not set as readonly, so you should not modify Scriban sources in that mode as it will modify the sources for other projects using Scriban on your machine. Use this feature at your own risks!

In order to activate this feature you need to:

  • Set the property PackageScribanIncludeSource to true in your project:
    <PropertyGroup>
      <PackageScribanIncludeSource>true</PackageScribanIncludeSource>
    </PropertyGroup>
    
  • Add the IncludeAssets="Build" to the NuGet PackageReference for Scriban:
    <ItemGroup>
      <PackageReference Include="Scriban" Version="3.2.1" IncludeAssets="Build"/>
    </ItemGroup>
    

If you are targeting netstandard2.0 or .NET Framework 4.7.2+, in order to compile Scriban you will need these NuGet package references (that can come from a dependency that you already have):

<ItemGroup>
    <PackageReference Include="Microsoft.CSharp" Version="4.5.0" />
    <PackageReference Include="System.Threading.Tasks.Extensions" Version="4.5.0" />
</ItemGroup>

NOTE: In this mode, all Scriban types are marked as internal.

You should see a Scriban folder and empty subfolders in your project. This is an issue with Visual Studio 2019 16.8.x (and before) and it will be fixed in VS 2019 16.9+

License

This software is released under the BSD-Clause 2 license.

  • dotliquid: .NET port of the liquid templating engine
  • Fluid .NET liquid templating engine
  • Nustache: Logic-less templates for .NET
  • Handlebars.Net: .NET port of handlebars.js
  • Textrude: UI and CLI tools to turn CSV/JSON/YAML models into code using Scriban templates
  • NTypewriter: VS extension to turn C# code into documentation/TypeScript/anything using Scriban templates

Online Demo

Credits

Adapted logo Puzzle by Andrew Doane from the Noun Project

Author

Alexandre Mutel aka xoofx.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (139)

Showing the top 5 NuGet packages that depend on Scriban:

Package Downloads
Volo.Abp.TextTemplating.Scriban The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Package Description

Serenity.CodeGenerator The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Generates server and script side code for Serenity platform applications

Miru.Core

Package Description

Mediator.SourceGenerator

A high performance .NET Mediator pattern implemenation using source generation.

RecommendationsGatewayModule.Data

Package Description

GitHub repositories (35)

Showing the top 5 popular GitHub repositories that depend on Scriban:

Repository Stars
abpframework/abp
Open Source Web Application Framework for ASP.NET Core. Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
spectreconsole/spectre.console
A .NET library that makes it easier to create beautiful console applications.
openiddict/openiddict-core
Flexible and versatile OAuth 2.0/OpenID Connect stack for .NET
TelegramBots/Telegram.Bot
.NET Client for Telegram Bot API
Version Downloads Last updated
5.10.0 442 4/12/2024
5.9.1 237,337 1/9/2024
5.9.0 558,724 9/6/2023
5.8.0 7,366 9/1/2023
5.7.0 1,036,927 2/25/2023
5.6.0 102,066 2/3/2023
5.5.2 238,946 1/4/2023
5.5.1 224,660 11/18/2022
5.5.0 1,100,875 7/11/2022
5.4.6 449,849 5/29/2022
5.4.5 27,668 5/22/2022
5.4.4 1,825,523 4/9/2022
5.4.3 52,684 4/3/2022
5.4.2 9,162 3/31/2022
5.4.1 83,884 3/15/2022
5.4.0 167,253 2/6/2022
5.3.0 2,166 2/6/2022
5.2.0 7,423 2/6/2022
5.1.0 1,941 2/5/2022
5.0.0 772,729 10/20/2021
4.1.0 35,563 10/7/2021
4.0.2 645,177 9/22/2021
4.0.1 800,466 6/3/2021
4.0.0 3,832 6/2/2021
3.9.0 21,991 5/31/2021
3.8.2 24,950 5/27/2021
3.8.1 59,606 5/25/2021
3.8.0 1,723 5/25/2021
3.7.0 117,971 5/1/2021
3.6.0 995,055 3/20/2021
3.5.0 230,837 2/13/2021
3.4.2 41,916 2/1/2021
3.4.1 39,772 1/23/2021
3.4.0 14,544 1/21/2021
3.3.3 72,642 1/14/2021
3.3.2 125,373 12/30/2020
3.3.1 51,174 12/30/2020
3.3.0 2,121 12/29/2020
3.2.2 3,934 12/24/2020
3.2.1 16,465 12/22/2020
3.2.0 1,816 12/22/2020
3.1.0 6,776 12/21/2020
3.0.7 27,118 12/15/2020
3.0.6 120,015 12/6/2020
3.0.5 242,543 12/1/2020
3.0.4 5,145 11/30/2020
3.0.3 3,429 11/29/2020
3.0.2 71,623 11/23/2020
3.0.1 2,019 11/22/2020
3.0.0 17,761 11/15/2020
3.0.0-alpha.9 4,932 8/20/2020
3.0.0-alpha.8 433 8/7/2020
3.0.0-alpha.7 282 7/31/2020
3.0.0-alpha.6 296 7/31/2020
3.0.0-alpha.5 577 7/25/2020
3.0.0-alpha.4 350 7/25/2020
3.0.0-alpha.3 11,200 7/16/2020
3.0.0-alpha.2 326 7/6/2020
3.0.0-alpha.1 409 6/18/2020
2.1.4 487,265 8/16/2020
2.1.3 887,081 6/5/2020
2.1.2 329,051 3/8/2020
2.1.1 361,092 12/6/2019
2.1.0 314,053 6/30/2019
2.0.1 530,369 5/11/2019
2.0.0 172,887 3/8/2019
2.0.0-alpha-006 545 3/7/2019
2.0.0-alpha-005 3,461 1/15/2019
2.0.0-alpha-004 1,338 1/4/2019
2.0.0-alpha-003 578 1/3/2019
2.0.0-alpha-002 666 1/1/2019
2.0.0-alpha-001 596 12/28/2018
1.2.9 112,062 12/21/2018
1.2.8 6,789 12/17/2018
1.2.7 193,634 10/6/2018
1.2.6 8,607 9/26/2018
1.2.5 9,904 8/29/2018
1.2.4 3,366 8/21/2018
1.2.3 106,265 7/20/2018
1.2.2 7,223 7/3/2018
1.2.1 27,080 6/1/2018
1.2.0 26,754 2/10/2018
1.1.1 5,692 1/22/2018
1.1.0 1,078 1/22/2018
1.0.0 124,139 12/24/2017
1.0.0-beta-006 976 12/12/2017
1.0.0-beta-005 801 12/3/2017
1.0.0-beta-004 1,082 11/19/2017
1.0.0-beta-003 1,036 11/19/2017
1.0.0-beta-002 1,011 11/13/2017
1.0.0-beta-001 999 11/12/2017
0.16.0 14,190 11/12/2017
0.15.0 10,366 11/9/2017
0.14.0 1,256 11/7/2017
0.13.0 1,254 11/7/2017
0.12.1 1,264 11/6/2017
0.12.0 1,244 11/6/2017
0.11.0 1,262 11/4/2017
0.10.0 1,219 11/1/2017
0.9.1 1,227 10/27/2017
0.9.0 1,216 10/25/2017
0.9.0-pre100 1,049 10/23/2017
0.7.0 27,306 10/12/2017
0.6.0 1,581 5/16/2017
0.5.0 1,057 5/16/2017
0.4.0 1,059 5/8/2017
0.3.1 1,068 4/4/2017
0.3.1-pre028 846 4/4/2017
0.3.0 1,071 3/9/2017
0.2.2 1,113 2/2/2017
0.2.1 1,141 2/1/2017
0.2.0 1,826 6/27/2016
0.1.0 4,047 5/31/2016