From d90c3c4605f9a5bcd1153996e3f4d1a17d58bd92 Mon Sep 17 00:00:00 2001 From: Ringo De Smet Date: Sun, 22 Mar 2020 20:09:32 +0100 Subject: [PATCH] fix: Updated the README to reflect which issues are resolved. --- packages/engine-twig/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/engine-twig/README.md b/packages/engine-twig/README.md index 194f92e49..9d45fca95 100644 --- a/packages/engine-twig/README.md +++ b/packages/engine-twig/README.md @@ -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)