Skip to content

Commit d90c3c4

Browse files
committed
fix: Updated the README to reflect which issues are resolved.
1 parent daca95c commit d90c3c4

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

packages/engine-twig/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
## The Twig PatternEngine for Pattern Lab / Node
22

3-
To install the Twig engine in your edition, `npm install @pattern-lab/engine-twig` should do the trick.
3+
To install the Twig engine in your edition, `npm install @pattern-lab/engine-twig` should do the trick. This pattern engine uses the [`twing`](https://www.npmjs.com/package/twing) library.
44

55
## Supported features
66

7-
Level of support is more or less full. Partial calls and lineage hunting are supported. Twig does not support the mustache-specific syntax extensions, style modifiers and pattern parameters, because their use cases are addressed by the core Twig feature set.
7+
Level of support for Twig constructs is on the level that the `twing` library supports. The following partial resolution schemes (`includes`, `extends`, `import`) are supported:
88

9-
We are looking for help with the following issues:
9+
* relative file paths: standard by `twing` libary
10+
* namespaces: standard by `twing` library, `engine-twig` only passes the configuration from `patternlab-config.json`
11+
* Patternlab pattern names: integration between Patternlab and `twing` implemented by a custom [`loader`](https://nightlycommit.github.io/twing/api.html#create-your-own-loader)
12+
13+
Now that this engine uses a better Twig Javascript library, the following issues are resolved:
1014

1115
* [Pattern Lab does not support twig extends](https://github.com/pattern-lab/patternlab-node/issues/554)
1216
* [Verify maturity of Twig engine](https://github.com/pattern-lab/patternlab-node/issues/285)

0 commit comments

Comments
 (0)