jstransformers / jstransformer-nunjucks

Nunjucks support for JSTransformers.

http://npm.im/jstransformer-nunjucks

MIT License

6 stars 6 forks source link

Add description of options to Readme #24

Closed AmeliaBR closed 6 years ago

AmeliaBR commented 6 years ago

Also adds a short example of using the options object to pass in a custom Nunjucks filter function.

Closes #10 by documenting the solution given in the comments to that issue.

codecov[bot] commented 6 years ago

Codecov Report

Merging #24 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #24   +/-   ##
=======================================
  Coverage   93.33%   93.33%           
=======================================
  Files           1        1           
  Lines          30       30           
  Branches       10       10           
=======================================
  Hits           28       28           
  Misses          2        2

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 58e1341...83df53a. Read the comment docs.

RobLoach commented 6 years ago

Looks great! Thanks a lot.

RobLoach commented 6 years ago

Would love to see more of these documented across the engines.

AmeliaBR commented 6 years ago

Would love to see more of these documented across the engines.

Indeed! It can get a little confusing tracing the options from a build tool to JS transformers to the individual transformer wrapper to the underlying template system.

I was poking through the source code a few weeks ago to figure out how to set the root path, and then today I was doing the same to figure out how to add custom filters, so I decided I could help future me & everyone else by writing them down.