Skip to content

Commit 5de2529

Browse files
dnwhtebmuenzenmeyer
authored andcommitted
Update comments and readme
1 parent e37b3e5 commit 5de2529

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

packages/patternengine-node-nunjucks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
To install the Nunjucks engine in your edition, `npm install patternengine-node-nunjucks` should do the trick.
66

7-
Level of Support is more or less full. Partial calls and lineage hunting are supported. Nunjucks does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Nunjucks feature set.
7+
Level of Support is more or less full. Partial calls and lineage hunting are supported. Nunjucks does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Nunjucks feature set. Pattern Lab's listitems.json data does not appear to be accessible. However, it's still possible to create custom list style data.
88

99
## Extending the Nunjucks instance
1010

packages/patternengine-node-nunjucks/lib/engine_nunjucks.js

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
/*
2-
TODO
3-
- Make sure regex match Nunjucks features and syntax
4-
- Look into if we need to handle partials in the render method
5-
- Test methods of including files
6-
- Compare features and syntax with the mustache version so we can document
7-
- Document and submit to PatternLab
8-
*/
2+
* Nunjucks pattern engine for patternlab-node
3+
*
4+
* Dan White.
5+
* Licensed under the MIT license.
6+
*
7+
*/
8+
9+
/*
10+
* ENGINE SUPPORT LEVEL:
11+
*
12+
* Mostly full. Partial calls and lineage hunting are supported.
13+
* Nunjucks does not support the mustache-specific syntax
14+
* extensions, style modifiers and pattern parameters, because
15+
* their use cases are addressed by the core Nunjucks feature set.
16+
* Pattern Lab's listitems.json data does not appear to be accessible.
17+
* However, it's still possible to create custom list style data.
18+
*
19+
*/
920

1021
"use strict";
1122

0 commit comments

Comments
 (0)