askama

This new release increases compatibility with jinja language, add support for more rust expressions in the templates. Take a look at the book for the migration guide.

(❗ = breaking change)

New features

• ❗Add support for let blocks by @GuillaumeGomez in #697

• Implement compound assignments (e.g. {% mut a += 1 %}) by @Kijewski in #685

• Add support for tuple, array and slice in type generics by @GuillaumeGomez in #721

• Add support for macro args type annotations by @GuillaumeGomez in #722

• Add support for caller() in variable declaration by @GuillaumeGomez in #724

• Add glob support for dirs in config file by @GuillaumeGomez in #731

Bugfixes

• Fix jinja macro arguments handling by @GuillaumeGomez in #709
• parser: reject non-ASCII characters in byte literals by @Kijewski in #694
• parser: reject syntaxes that could cause catastrophic backtracking by @Kijewski in #695
• derive: make sure the size_hint is collected by @Kijewski in #700
• Fix build determinism and macro path management by @GuillaumeGomez in #710
• Correctly handle non-ident item in block error by @GuillaumeGomez in #717
• Fix compiler error with recursive types on recursive templates by using dyn instead of plain generic bounds by @GuillaumeGomez in #726
• Fix print = "code" by @GuillaumeGomez in #729
• Switch to std::path::absolute to avoid symlinking template paths by @kaepr in #720
• Fix askama template when called from within a macro in a different crate by @GuillaumeGomez in #728

Other

• ❗Turn duplicated block warning into an error by @GuillaumeGomez in #711

Performance

• Greatly speed up nested array parsing by @GuillaumeGomez in #702

Documentation

• Add custom escaper example by @GuillaumeGomez in #725
• Improve documentation for config by @GuillaumeGomez in #732
• Document when Template trait methods can return Err by @GuillaumeGomez in #730

Internal changes

• Limit recursions for Ty generics by @GuillaumeGomez in #723
• Add regression test for temporary refs for #661 by @GuillaumeGomez in #688
• Add complex-expression benchmark by @Kijewski in #691
• Simplify Cargo.toml files by @GuillaumeGomez in #696
• Clean compound implementation by @GuillaumeGomez in #699
• Update rand+rand_xoshiro dev-dependencies by @Kijewski in #701
• Upgrade winnow to 1.0 by @jplatte in #715
• Remove unnecessary .clone() by @jplatte in #716
• Remove unused lifetime parameter on SyntaxAndCache by @jplatte in #714
• Correctly handle non-ident item in block error by @GuillaumeGomez in #717
• Update trybuild version to 1.0.116 to enforce diagnostics width by @GuillaumeGomez in #718

New Contributors

• @jplatte made their first contribution in #715
• @kaepr made their first contribution in #720

Full Changelog: v0.15.4...v0.16.0

What's Changed

• Correctly handle non-ident item in block error by @GuillaumeGomez in #717
• Remove unnecessary .clone() by @jplatte in #716
• Remove unused lifetime parameter on SyntaxAndCache by @jplatte in #714
• Upgrade winnow to 1.0 by @jplatte in #715

Full Changelog: v0.15.5...v0.15.6

What's Changed

• parser: reject non-ASCII characters in byte literals by @Kijewski in #694
• parser: reject syntaxes that could cause catastrophic backtracking by @Kijewski in #695
• Fix jinja macro arguments handling by @GuillaumeGomez in #709
• Fix build determinism and macro path management by @GuillaumeGomez and @cgundy in #710

Full Changelog: v0.15.4...v0.15.5

What's Changed

• Improve function call handling by @Kijewski in #684
• Correctly handle temporary references by @GuillaumeGomez in #686

Full Changelog: v0.15.3...v0.15.4

What's Changed

• Update book links (askama.rs) by @Kijewski in #678
• Fix invalid variable parsing by @GuillaumeGomez in #680

Full Changelog: v0.15.2...v0.15.3

What's Changed

• Correctly handle local variables in extends blocks by @GuillaumeGomez in #670
• Better spans for #[filter_fn] by @Kijewski in #655
• Remove mentions of salvo by @Kijewski in #659
• Add missing information in the Upgrading to new versions chapter in the askama book by @GuillaumeGomez in #665
• Fix invalid block call warnings coming from extends by @GuillaumeGomez in #666
• Update duplicated blocks warning message and add warning about not compiling starting next version by @GuillaumeGomez in #669
• derive: allow where bounds in #[filter_fn] by @Kijewski in #672
• [Book] Improve filters chapter by @Tirka in #673
• [Book] Use more current markdown syntax for fragment links by @Kijewski in #658
• [Book] Improve filters chapter examples (by making us of defined_or filter) by @Tirka in #675

New Contributors

• @Tirka made their first contribution in #673

Full Changelog: v0.15.1...v0.15.2

What's Changed

• Fix broken intra-doc links by @GuillaumeGomez in #645
• Fix missing mutability information in generated filters by @GuillaumeGomez in #646
• Fix clippy false positives by using call_site for code generated by the derive proc-macro by @sehnryr in #647
• Add support for lifetimes in filters by @GuillaumeGomez in #649

New Contributors

• @sehnryr made their first contribution in #647

Full Changelog: v0.15.0...v0.15.1

The main breaking change is about custom filters, they now require the filter_fn attribute. More information about it in the askama book.

(❗ = breaking change)

New features

• ❗ add caller pattern from jinja❗ by @pollend in #422
• ❗Add new reject filter❗ by @GuillaumeGomez in #430
• ❗Treat caller() as variable with support for aliasing❗ by @seijikun in #510
• ❗Add filters |default, |assigned_or and |defined_or❗ by @Kijewski in #425
• ❗Update minimum supported rust version to 1.88❗ by @GuillaumeGomez in #523
• ❗Add askama::filter_fn proc-macro for custom filters with named/optional arg support❗ by @seijikun in #545
• Implement enum variants by @Kijewski in #255
• Allow filters with explicit path by @Kijewski in #435
• Add support for mutable variables by @GuillaumeGomez in #462
• Add support for macro default value generics by @GuillaumeGomez in #522
• Add support for expression-call syntax for macros by @seijikun in #518
• Implement #531: Allow named arguments in call expr macro invocations by @seijikun in #533
• Add support for array repeat syntax: [<element_expr>; <cnt_expr>] by @seijikun in #626
• Add support for struct expressions by @VojtaStanek in #602
• format non base 10 numbers at compile time by @tdelabro in #620
• Add new tag to declare variable without value by @GuillaumeGomez in #613

Major internal changes

Improve error location to give better errors:

• Greatly improve error messages on nightly by @GuillaumeGomez in #525
• Generate a TokenStream rather than a String by @GuillaumeGomez in #558
• parser: use LocatingSlice<&str> instead of &str by @Kijewski in #560
• Use Parser::[with_]span() to get byte range and use byte range for proc_macro::Span by @Kijewski in #571

Other

• ❗ filesizeformat with proper accuracy❗ by @seijikun in #568
• Filters linebreaks, paragraphbreaks and linebreaksbr only need core by @Kijewski in #486
• Emit an error if an extends block doesn't come first in a template by @GuillaumeGomez in #584

Book/documentation

• Fix tiny wording error in "Calling functions" docs by @m4tx in #423
• book: complete note about filter change by @martinetd in #453
• Update ref documentation by @sinder38 in #456
• Update performance.md by @zamazan4ik in #188
• book: document all crates on readthedocs by @Kijewski in #473
• Fixed typos in template syntax book docs in #494
• book: update mdbook version and highlight jinja blocks by @Kijewski in #544
• Improve documentation by @seijikun in #554
• Minor documentation fixes by @seijikun in #555
• Fix some code examples annotations by @GuillaumeGomez in #577
• Add missing documentation about for loop features by @GuillaumeGomez in #576
• book: add question mark operator by @VojtaStanek in #601
• book: add syntax summary by @VojtaStanek in #603
• book: fix rust-docs on readthedocs by @Kijewski in #528

Internal changes

• Add tests for jinja examples in our book by @GuillaumeGomez in #574
• Make code generator re-usable for other projects by @Kijewski in #434
• parser: simplify {# comment #} parsing by @Kijewski in #488
• Rename Expr::Attr into Expr::AssociatedItem by @GuillaumeGomez in #499
• parser: introduce more types for Expr variants by @Kijewski in #498
• parser: refactor |filter and {% filter %} parsing by @Kijewski in #500
• Use if-let-chains by @Kijewski in #527
• derive: more if-let by @Kijewski in #532
• derive: dedupe visit custom filters code by @Kijewski in #470

Performance

• Add missing #[inline] annotations by @Kijewski in #421
• parser: un-inline error message generation by @Kijewski in #501
• Refactor indent Filter Implementation by @strickczq in #466
• Make wordcount filter work with core only by @GuillaumeGomez in #480
• derive: un-inline Expr::Call handling for {{ expressions }} and remove parentheses by @Kijewski in #540
• parser/derive: replaces usages of Expr/Node with Box<Expr>/Box<Node> by @Kijewski in #542
• parser: remove one indirection in punction() finding by @Kijewski in #543
• filter_fn: Aggressive inlining for builder invocation methods by @seijikun in #616
• loop.first is known by being at index == 0 by @Kijewski in #436

Bugfixes

• generator: remove invisible group from output by @Kijewski in #419
• Relax Sized constraint on impl FastWritable for Cow by @C0D3-M4513R in #432
• Ignore fuzzing corpus from source line count by @Kijewski in #433
• Use unicode-ident to determine what is an identifier by @Kijewski in #443
• derive: prefix more generated variables with __askama by @Kijewski in #444
• derive: don't suppress fatal errors in integer parsing by @Kijewski in #448
• Print invalid generated code during panic by @Kijewski in #446
• Prevent crate to be used as identifier by @GuillaumeGomez in #450
• Comparison operators cannot be chained by @Kijewski in #457
• Correctly escape and reject macro names by @Kijewski in #460
• parser: macro calls need proper tokens by @Kijewski in #468
• Resolve with macro with call after caller by @pollend in #469
• parser: recognize/reject prefixed ids and lits in macro calls by @Kijewski in #476
• parser: reject illegal string literals by @Kijewski in #479
• Rename LoopItem::index to LoopItem::index0 by @Kijewski in #481
• parser: reject isolated CRs in string literals by @Kijewski in #483
• parser: better error message for bare CRs by @Kijewski in #485
• parser: U+10FFFF is the highest Unicode codepoint by @Kijewski in #484
• parser: recognize comments in macro calls by @Kijewski in #487
• parser: implement {% raw %} and Lit::parse() without skip_till by @Kijewski in #489
• parser: fix {% raw %} for delimiters starting with - by @Kijewski in #491
• parser: string literal must not be immediately followed by suffix# by @Kijewski in #496
• parser: reject illegal raw identifiers in attribute access & ensure valid paths in generics by @Kijewski in #497
• parser: understand nested block comments in macro calls by @Kijewski in #504
• Fix panic when using include in call block by @seijikun in #516
• parser: fix check_expr() recursion by @Kijewski in #519
• parser: reject isolated CR in macro inputs, too by @Kijewski in #524
• parser: reject bare CR in doc comments by @Kijewski in #526
• Fix fuzzing macro argument parsing bug by @GuillaumeGomez in #530
• derive: make EvaluatedResult know its unknown result by @Kijewski in #538
• parser: un-inline more error messages by @Kijewski in #539
• parser: fail on unterminated byte literal by @Kijewski in #547
• derive: track included files with relative path by @Kijewski in #546
• parser: r#self is not a valid raw identifier in macro calls by @Kijewski in #553
• parser/derive: use only one hasher throughout the proc_macro by @Kijewski in #557
• Fix wrong span context for askama variables by @GuillaumeGomez in #565
• Fix invalid handling of paths starting with :: by @GuillaumeGomez in #569
• README: fix a link, include readmes in lib.rs by @Kijewski in #573
• Fix wrong macro argument parsing by @GuillaumeGomez in #570
• parser: r#_ is not a valid identifier by @Kijewski in #579
• parser: reject unclosed prefixed string by @Kijewski in #582
• Emit warnings if duplicated block calls are done by @GuillaumeGomez in #580
• Fix block duplication warning by @GuillaumeGomez in #586
• Fix wrong parsing of number if digit does not match base by @GuillaumeGomez in #600
• Fix formatting of safe filter in template_syntax.md by @FalkWoldmann in #587
• Limit maximum number of references in generics to prevent syn stack overflow by @GuillaumeGomez in #611
• Fix nested includes not handled properly by @fbilhaut in #619
• filter_fn: Further improve invalid invocation compile error messages by @seijikun in #614
• Fix method call on enum variant templates by @GuillaumeGomez in #635

New Contributors

• @C0D3-M4513R made their first contribution in #432
• @martinetd made their first contribution in #453
• @pollend made their first contribution in #422
• @sinder38 made their first contribution in #456
• @zamazan4ik made their first contribution in #188
• @seijikun made their first contribution in #516
• @VojtaStanek made their first contribution in #601
• @FalkWoldmann made their first contribution in #587
• @fbilhaut made their first contribution in #619
• @tdelabro made their first contribution in #620
• @bwcii made their first contribution in #630

Full Changelog: v0.14.0...v0.15.0

Added Features

• Implement Values on tuple by @GuillaumeGomez in #391
• Pass variables to sub-templates more reliably even if indirectly by @Kijewski in #397
• Implement first and blank arguments for |indent by @Kijewski in #401
• Add named arguments for builtin filters by @Kijewski in #403
• Add unique filter by @GuillaumeGomez in #405

Bug Fixes And Consistency

• askama_derive accidentally exposed as a feature by @Kijewski in #384
• Track config files by @GuillaumeGomez in #385
• If using local variable as value when creating a new variable, do not put it behind a reference by @GuillaumeGomez in #392
• generator: make CARGO_MANIFEST_DIR part of ConfigKey by @strickczq in #395
• Do not put question mark initialization expressions behind a reference by @GuillaumeGomez in #400
• Update to more current rust version on readthedocs by @Kijewski in #410
• Fix unique filter implementation by @GuillaumeGomez in #417
• Add |titlecase as alias for |title by @Kijewski in #416

Further Changes

• book: add page about FastWritable by @Kijewski in #407
• Add throughput to derive benchmark by @Kijewski in #413
• Move FastWritable into askama root by @GuillaumeGomez in #411

New Contributors

• @strickczq made their first contribution in #395

Full Changelog: v0.13.0...v0.14.0