Skip to content

Commit

Permalink
fix: Updated the README to reflect which issues are resolved.
Browse files Browse the repository at this point in the history
  • Loading branch information
ringods committed Mar 22, 2020
1 parent daca95c commit d90c3c4
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions packages/engine-twig/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
## The Twig PatternEngine for Pattern Lab / Node

To install the Twig engine in your edition, `npm install @pattern-lab/engine-twig` should do the trick.
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.

## Supported features

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.
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:

We are looking for help with the following issues:
* relative file paths: standard by `twing` libary
* namespaces: standard by `twing` library, `engine-twig` only passes the configuration from `patternlab-config.json`
* Patternlab pattern names: integration between Patternlab and `twing` implemented by a custom [`loader`](https://nightlycommit.github.io/twing/api.html#create-your-own-loader)

Now that this engine uses a better Twig Javascript library, the following issues are resolved:

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

0 comments on commit d90c3c4

Please sign in to comment.