document todos

Author: theodorejb

todo.md

@@ -0,0 +1,77 @@
+Double-check every LightnCandy issue where I left a comment, to see if any need to be updated following the helpers changes.
+
+- [x] https://github.com/zordius/lightncandy/issues/371
+- [x] https://github.com/zordius/lightncandy/issues/360
+- [x] https://github.com/zordius/lightncandy/issues/356
+- [x] https://github.com/zordius/lightncandy/issues/350
+- [x] https://github.com/zordius/lightncandy/issues/347
+- [x] https://github.com/zordius/lightncandy/issues/346
+- [x] https://github.com/zordius/lightncandy/issues/345
+- [x] https://github.com/zordius/lightncandy/issues/341
+
+
+Comment with fixed after release:
+- https://github.com/zordius/lightncandy/issues/292
+
+Nested partials are fully supported, both at compile and render time in [PHP Handlebars](https://github.com/devtheorem/php-handlebars):
+
+```php
+use DevTheorem\Handlebars\{Handlebars, Options};
+
+require 'vendor/autoload.php';
+
+$templateString = '{{#>outer}} {{#>compiledBlock}} real inner compiledBlock {{/compiledBlock}} {{>normalTemplate}} {{/outer}}';
+
+$template = Handlebars::compile($templateString, new Options(
+    partials: [
+        'outer' => 'outer+{{#>nested}}~{{>@partial-block}}~{{/nested}}+outer-end',
+        'nested' => 'nested={{>@partial-block}}=nested-end',
+    ],
+));
+
+echo $template(null, [
+    'partials' => [
+        'compiledBlock' => Handlebars::compile('compiledBlock !!! {{>@partial-block}} !!! compiledBlock'),
+        'normalTemplate' => Handlebars::compile('normalTemplate'),
+    ],
+]);
+```
+
+Output (matching Handlebars.js):
+> outer+nested=~ compiledBlock !!!  real inner compiledBlock  !!! compiledBlock normalTemplate ~=nested-end+outer-end
+
+The second example also works correctly in PHP Handlebars, with both compile-time and runtime partials:
+
+```php
+use DevTheorem\Handlebars\{Handlebars, Options};
+
+require 'vendor/autoload.php';
+
+$templateString = '{ {{#>outer}} {{#>innerBlock}} Hello {{/innerBlock}} {{>simple}} {{/outer}} }';
+
+$partials = [
+    'outer' => '( {{#>nested}} « {{>@partial-block}} » {{/nested}} )',
+    'nested' => '[ {{>@partial-block}} ]',
+    'innerBlock' => '< {{>@partial-block}} >',
+    'simple' => 'World!',
+];
+
+$templateWithPartials = Handlebars::compile($templateString, new Options(partials: $partials));
+echo $templateWithPartials() . " (compile time)\n";
+
+$templateWithoutPartials = Handlebars::compile($templateString);
+$compiledPartials = array_map(fn($p) => Handlebars::compile($p), $partials);
+
+echo $templateWithPartials(null, ['partials' => $compiledPartials]) . " (runtime)\n";
+```
+
+Output:
+> { ( [  «  <  Hello  > World!  »  ] ) } (compile time)  
+> { ( [  «  <  Hello  > World!  »  ] ) } (runtime)
+
+
+- Support callable for helper functions: https://github.com/zordius/lightncandy/issues/228
+
+
+[Unable to resolve partial when using sub-expression and partial resolver](https://github.com/devtheorem/php-handlebars/issues/5)
+- Maybe comment with approach using helper rather than partial?