2.2.0

Handlebars.Net 2.2.0

⚠️ Behavior & compatibility changes — please read before upgrading

• Dropped end-of-life target frameworks. Removed netstandard1.3, net451, and net6. The package now targets netstandard2.0, netstandard2.1, and net8.0. Modern consumers (.NET Framework 4.6.1+, .NET Core 2.0+, .NET 5/8+) are unaffected via netstandard2.0; only consumers on the removed legacy frameworks need to stay on 2.1.x.
• Single quote (') is now HTML-encoded by default (#546), matching Handlebars.js behavior. This is invisible when rendering HTML, but changes raw output bytes — review any exact-string or snapshot assertions on rendered output.

Bug fixes

• Case-sensitive resolution of same-spelling path variables, resolved independently in PathBinder (#434)
• Case-sensitive key lookup for IDictionary/Hashtable (#521) and DictionaryMemberAccessor (#466)
• @partial-block now usable inside #if and as a block partial (#519)
• #if with includeZero=true now supported; includeZero honored in built-in conditional blocks (#285)
• Parent context traversal inside custom block helpers within #each (#539)
• Safe-string flag preserved when helper output crosses a subexpression boundary (#543)
• WriteSafeString encoding consistent regardless of helper registration order (#559)
• Preserve backslashes in template literal text (#462) and double backslashes in static text (#349)
• Preserve partial indentation (#614)
• Handle escaped double-quotes in delimited string literal arguments (#584)
• Allow Unicode letters as first character in identifiers (#416); strip invisible Unicode chars (BOM, etc.) from identifiers (#605)
• Clearer error when a partial is registered on the wrong Handlebars instance (#545)
• Removed byref/in delegate parameters incompatible with Mono/Xamarin (#458)
• Prevent unbounded DictionarySlim growth when replacing existing keys (#541)
• Normalize CRLF to LF in StaticConverter for platform-independent output

Maintenance

• CI moved to windows-latest; bumped deprecated GitHub Actions and SDK versions; pinned third-party actions to commit SHAs
• Resolved SonarCloud security/quality findings; dev environment updated to .NET 10
• Added render-time/compile-scaling benchmark suite and Handlebars.js regression coverage

2.1.6

Changes

Maintenance 🧰

• Added in missing SDK's for release @thompson-tomo (#579)

  Added in required sdk's for the release build which was missed in #578

• Update of TFM & dependency optimisation @thompson-tomo (#578)

  By adjusting the TFM'S we have been able to produce a package with no dependencies on the latest frameworks hence an optimised dependency graph.

  The following frameworks have been added:

  • Net 6

  The following frameworks even though requested was not added:

  • Net 5

  The following frameworks were removed:

  • Net 4.5.2
  • Net 4.6

  Closes: #573
  Closes: #415

Contributors

@oformaniuk and @thompson-tomo

2.1.5

Changes

• #574 Repo readme is mirrored into nuget package @thompson-tomo (#575)

  Closes #574

Features 🚀

• Add EmbedUntrackedSources @lahma (#570)

  • added EmbedUntrackedSources to remove one warning, see https://nuget.info/packages/Handlebars.Net/2.1.4

  I would also suggest changing to use newer GH Actions images for building so that other warnings would go away (old SDK in use). Maybe another modernization step could be removing old unsupported full framework targets and only support oldest supported net462. Adding net6.0 target would allow one target without dependency on Microsoft.Csharp.

• Use PackageLicenseExpression in NuGet package @StefH (#564)

Bug Fixes 🐛

• Introduce PartialRecursionDepthLimit @RoosterDragon (#552)

  When evaluating templates with partials, it is possible to recurse in the evaluation of those partials. This can be useful for dealing with tree like data, such as rendering a list of friends-of-friends-of-friends-of-etc....

  The ability to recurse can lead to stack overflows. For example if a sufficiently deep tree is provided as input data, or more simply if the partial calls itself in an infinite loop. As a stack overflow terminates the process, this is not desirable behaviour as it is an unavoidable crash.

  To resolve this a configurable PartialRecursionDepthLimit is introduced, defaulting to 100. Now when a template is evaluated a HandlebarsRuntimeException will be thrown if this limit is reached. This allows the caller to catch the exception and recover gracefully, rather than terminating the process.

• Allow slashes properly within escape blocks @Hoeksema (#567)

  closes #566

  The path parsing currently doesn't work properly when there are embedded slashes within an ignore block.

  This PR fixes this issue:

  • No more exceptions thrown when using // within an escaped block
  • Allowing multiple / to occur within an escape block without breakage

  Before, the individual segments between slashes in addition to the entire escaped block were returned by PathInfo. Now, it returns just the latter, which is correct. All existing unit tests still pass and new tests were added to exercise the failing cases in #566.

• Throw properly on open ignore block instead of crashing @Hoeksema (#569)

  Closes #568

  Resolve the hang on compile when there is an open ignore block

  Reshuffle the logic so that the throw check for end of template is done before trying to process the char

• Fix LiteralConverter to support long @StefH (#562)

Maintenance 🧰

• Fix/ci @oformaniuk (#576)

Contributors

@Hoeksema, @RoosterDragon, @StefH, @lahma, @oformaniuk and @thompson-tomo

2.1.4

Features 🚀

• Add optional 3rd argument to lookup helper @StefH (#542)

Contributors

@StefH

2.1.3

Changes

• Fix 535 OutOfMemoryException @anth12 (#536)

  #535

  The following line currently throws an OutOfMemoryException for unrecognised expressions:
  https://github.com/Handlebars-Net/Handlebars.Net/blob/01ad0e69e56331371f85a1c59c008d7ecfd06f78/source/Handlebars/Compiler/Lexer/Parsers/BlockParamsParser.cs#L28

  This PR exits the while loop when reaching the end of the end of the string reader.

• Rendering inline blocks are incorrectly escaped @Nisden (#538)

  This pull request demonstrates the the issue experienced in #524

Contributors

@Nisden, @anth12, @rexm, @zjklee and Anthony Halliday

2.1.2

Changes

Bug Fixes 🐛

• Nested partial block receives correct context @zjklee (#516)

  Nested partial block receives correct context

  Issues:

  • closes #515

Contributors

@zjklee

2.1.1

Changes

• Update readme.md to include extra projects @StefH (#509)

Features 🚀

• Introduce SharedEnvironment @zjklee (#514)

  Introduces SharedEnvironment to deal with big memory footprint when runtime has a lot of compiled templates.
  See SharedEnvironment documentation for more details

  Issues:

  • closes #513

Bug Fixes 🐛

• Fix collision handling in FixedSizeDictionary @zjklee (#512)

  In rare cases (depended on hashcode) as part of searching for a suitable place in the array search started from index greater than array length.

  Issues:

  • closes #498

• Fix for string object property access @Dragwar (#510)

  Removed if condition in ObjectDescriptor that checked whether the type is string

  Issues:

  • closes #457

• Last letter cut off when the string starts with the separator @periklis92 (#504)

  Split Enumerator strings would have the wrong length if the string started with the separator.

  Issues:

  • closes #500

Contributors

@Dragwar, @StefH, @periklis92 and @zjklee

2.1.1-beta-1

Changes

• An attempt to fix #498

  This beta release contains object pooling safety improvements

Contributors

@zjklee

2.1.0

Changes

• Remove duplicate AliasProviders initialization @RomainHautefeuille (#486)

Features 🚀

• Decorators implementation @zjklee (#489)

  Issues:

  • closes #137

• Deprecate SupportLastInObjectIterations @orgads (#482)

Bug Fixes 🐛

• Decorators implementation @zjklee (#489)

  Issues:

  • closes #380
  • closes #306
  • closes #300

• Enable support for chained path iterators @abraham-fox (#488)

  Issues:

  • closes #442

• Add checks for loose closing blocks @abraham-fox (#485)

  Check loose closing blocks on compile time - fixes #484.

Contributors

@RomainHautefeuille, @abraham-fox, @orgads, @zjklee

2.0.10

Changes

Features 🚀

• HtmlEncoding consistent with rules in handlebars.js @tommysor (#473)

  The original issue this PR was intended to solve have been fixed in PR #477.
  This PR now deals with general rules for encoding in Handlebars.Net vs handlebars.js.

• Support @last by default. @orgads (#481)

  Fixes #480

Bug Fixes 🐛

• Fix path parsing when contains [a/b] @zjklee (#478)

  Fixes #470

• UnencodedStatementVisitor resets value to previously existing value when done @tommysor (#477)

  Fix #468 HandlebarsDotNet.Handlebars.Configuration.NoEscape Applied Inconsistently
  This PR does not deal with the question of general rules for encoding that was brought up in #473.

• Issue #469 @jamesfarrugia96 (#474)

  Exposed additional helper registration overloads via static methods

Contributors

@jamesfarrugia96, @orgads, @tommysor, @zjklee