Skip to content

Latest commit

 

History

History
86 lines (76 loc) · 4.34 KB

README.md

File metadata and controls

86 lines (76 loc) · 4.34 KB
Raw

TODO:

  • Wire up new error struct in lexer2
  • Add insta tests for lexing errors
  • Start writing parser, copying most of parser.rs probably
    • raw
    • block
    • for loop
    • if/elif/else
    • filter section
    • macro definition
    • macro imports
  • Delete logos lexer/tests/parser
  • Adds lots of tests, some with insta some without
    • Make sure the spans are always correct
    • Handle all custom errors from previous parser
    • Handle extends not being the first tag as error
    • Handle nodes not allowed in certain places (eg macro def inside a macro def)
  • Fuzz a lot
  • Polish lexer + parser until it's perfect
  • More fuzzing
  • Generate bytecode
  • Decide where to calculate byte size hint, probably compiler
  • Fix blocks/macros AST -> bytecode generation
  • Fix macro call weird instruction (idx, idx).
  • Have a reasonable Template object (eg macro imports, extend)
  • Add support for block assignment in lexer/parser/compiler
  • Handle map literals (only allow string as keys for now?)
  • More fuzzing
  • Add a Context object that holds values like the one in Tera
  • Add an escape_html fn with benchmarks and a faster one featured gated
  • Add a Tera object that holds all the templates
  • Do the equivalent of build_inheritance_chains from v1. Maybe create a new VerifiedTemplate or whatever?
  • Implement basic VM without filters/functions/tests
    • Port all the corresponding tests from Tera v1 + some more
    • Ensure variables used in {{ }} are defined (vs if/tests where undefined are just falsy?)
    • Fix bytecode generation when it's wrong
    • Allow anything that can be converted to a key as a key for inline maps (eg add bool/integers)
    • Make sure strings are escaped automatically (Value::String could be an enum with safe/unsafe string like markupsafe in python?) when printing
    • Fix/remove all the TODOs
    • Improve perf till it's better than Tera v1
    • Iterating on strings should require an optional unic_segment feature for unicode
    • Ensure that errors point to the right thing (<--- that's the long one, but done after perf work)
    • Finish VM
  • Design filters/functions/tests types
  • Implement basic builtin filters/functions/tests
  • Add filters/functions/tests to VM
  • Uncomment all tests using filters/functions/tests
  • Parsing errors should report with the source context like Rust errors with the right spans
  • Add more helpful errors when loading templates (eg a forloop with for key, key in value/missing includes etc)
  • Allow escape chars (eg \n) in strings concat, there was an issue about that in Zola
  • Feature to load templates from a glob with optional dep
  • MAYBE: add a way to add global context to the Tera struct that are passed on every render automatically
  • Shitload of tests
  • More fuzzing

Ideas:

  • Collect all functions/filters/macro call/includes/tests and make sure it's all available at compile time
  • Pre-compute hashes for all keys used in the templates somehow? runtime phf? https://crates.io/crates/ph ?
  • string interning for Key/Value?
  • Pre-render macro calls without arguments?
  • Check whether blocks have super() and if they don't just skip them when rendering and they are in the middle of the ancestry
  • Have a way to merge chunks when handling inheritance, issue is macros since you need to refer to the right imports
  • Collect include templates so we know whether we have all of them or not and error otherwise
  • Make raw template keep spans rather String to avoid cloning it?
  • Use Arc in Value
  • Mark literal strings in templates as safe?

Thoughts on making LoadName error, we can change the semantics from v1 a bit eg:

  • {{ hey }} should error if hey is undefined
  • {{ existing.hey }} should error if hey is undefined but existing is
  • {{ hey or 1 }} should print 1
  • {% if hey or true %} should be truthy
  • {% if hey.other or true %} should error if hey is not defined (currently truthy)
  • {{ hey.other or 1 }} should error if hey is not defined (currently prints "true")

Breaking changes

  • {{ falsy or "hello" }} prints "hello" instead of "true"
  • {% if not_existing.field %} errors if not_existing is undefined, we only allow one level of undefinedness (hello undefined is not an object)
  • include ignore missing has been removed