Merge pull request NightlyCommit#18 from ericmorand/issue_17

Fis issue NightlyCommit#17

Author: ericmorand

.gitignore

@@ -3,4 +3,5 @@
 dist
 coverage
 node_modules
-package-lock.json
+package-lock.json
+tmp

README.md

@@ -1,12 +1,12 @@
 # twing-loader
 [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage percentage][coveralls-image]][coveralls-url]
 
-Webpack loader that compiles Twig templates using [Twing](https://www.npmjs.com/package/twing).
+Webpack loader for Twig templates, based on [Twing](https://www.npmjs.com/package/twing).
 
 ## Prerequisites
 
 * Webpack 4
-* Twing 2.3.3
+* Twing 3.0.1
 
 ## Installation
 

package.json

@@ -33,7 +33,7 @@
   ],
   "license": "ISC",
   "peerDependencies": {
-    "twing": "^2.3.3"
+    "twing": "^3.0.1"
   },
   "repository": {
     "type": "git",
@@ -43,12 +43,11 @@
     "url": "https://github.com/NightlyCommit/twing-loader/issues"
   },
   "homepage": "https://github.com/NightlyCommit/twing-loader#readme",
-  "description": "",
+  "description": "Webpack loader for Twig templates, based on Twing.",
   "dependencies": {
     "crypto-js": "^3.1.9-1",
     "loader-utils": "^1.2.3",
-    "schema-utils": "^2.2.0",
-    "slash": "^3.0.0"
+    "schema-utils": "^2.2.0"
   },
   "devDependencies": {
     "@types/loader-utils": "^1.1.3",
@@ -63,14 +62,14 @@
     "memory-fs": "^0.4.1",
     "module-alias": "^2.2.1",
     "nyc": "^14.1.1",
-    "slash": "^3.0.0",
     "rimraf": "^2.7.1",
     "sinon": "^7.5.0",
+    "slash": "^3.0.0",
     "tap-bail": "^1.0.0",
     "tap-spec": "^5.0.0",
     "tape": "^4.11.0",
     "ts-node": "^8.4.1",
-    "twing": "^2.3.6",
+    "twing": "^3.0.1",
     "typescript": "^3.6.3",
     "webpack": "^4.41.0",
     "webpack-cli": "^3.3.9"

src/index.ts

@@ -1,11 +1,16 @@
 import {getOptions} from 'loader-utils';
 import {loader} from 'webpack';
-import {TwingEnvironment, TwingLoaderArray, TwingLoaderChain, TwingSource} from 'twing';
-import {NodeVisitor} from "./node-visitor";
+import {
+    TwingEnvironment,
+    TwingLoaderArray,
+    TwingLoaderChain,
+    TwingNodeModule,
+    TwingSource, TwingTokenStream
+} from 'twing';
+import {Visitor} from "./visitor";
 
 const sha256 = require('crypto-js/sha256');
 const hex = require('crypto-js/enc-hex');
-const process = require('process');
 const slash = require('slash');
 
 const validateOptions = require('schema-utils');
@@ -27,82 +32,71 @@ const optionsSchema = {
 };
 
 class PathSupportingArrayLoader extends TwingLoaderArray {
-    getSourceContext(name: string): TwingSource {
-        let source = super.getSourceContext(name);
+    getSourceContext(name: string, from: TwingSource): TwingSource {
+        let source = super.getSourceContext(name, from);
 
         return new TwingSource(source.getCode(), source.getName(), name);
     }
 }
 
 export default function (this: loader.LoaderContext, source: string) {
+    const getTemplateHash = (name: string) => {
+        return this.mode !== 'production' ? name : hex.stringify(sha256(name));
+    };
+
     const options = getOptions(this);
 
     validateOptions(optionsSchema, options, 'Twing loader');
 
     let resourcePath: string = slash(this.resourcePath);
-    let environmentModulePath: string = slash(options.environmentModulePath);
+    let environmentModulePath: string = options.environmentModulePath;
     let renderContext: any = options.renderContext;
 
-    this.addDependency(environmentModulePath);
-
-    // we don't want to reuse an eventual initialized environment
-    delete require.cache[require.resolve(environmentModulePath)];
+    this.addDependency(slash(environmentModulePath));
 
-    let environment: TwingEnvironment = require(environmentModulePath);
+    // require takes module name separated wicth forward slashes
+    let environment: TwingEnvironment = require(slash(environmentModulePath));
+    let loader = environment.getLoader();
 
     if (renderContext === undefined) {
-
         let parts: string[] = [
-            `const {cache, loader, getEnvironment} = require('${slash(require.resolve('./runtime'))}');`,
-            `const env = getEnvironment(require('${environmentModulePath}'));`
+            `const env = require('${slash(environmentModulePath)}');`
         ];
 
-        let nodeVisitor: NodeVisitor;
-
-        nodeVisitor = new NodeVisitor();
-        nodeVisitor.fromPath = resourcePath;
+        let key = getTemplateHash(resourcePath);
+        let sourceContext: TwingSource = new TwingSource(source, `${key}`);
+        let tokenStream: TwingTokenStream = environment.tokenize(sourceContext);
 
-        environment.addNodeVisitor(nodeVisitor);
+        let module: TwingNodeModule = environment.parse(tokenStream);
 
-        Reflect.set(environment, 'getTemplateClass', function (name: string, index: number = null, from: TwingSource = null) {
-            let hash: string;
+        let visitor = new Visitor(loader, resourcePath, getTemplateHash);
 
-            const HASH_PREFIX = '__HASHED__';
+        visitor.visit(module);
 
-            if (name.startsWith(HASH_PREFIX)) {
-                hash = name;
-            } else {
-                hash = `${HASH_PREFIX}${hex.stringify(sha256(name))}`;
-            }
+        let precompiledTemplate = environment.compile(module);
 
-            return hash + (index === null ? '' : '_' + index);
-        });
-
-        let className: string = environment.getTemplateClass(resourcePath);
-        let sourceContext: TwingSource = new TwingSource(source, className);
-        let precompiledTemplate = environment.compile(environment.parse(environment.tokenize(sourceContext)));
-
-        parts.push(`cache.write('${className}', (() => {let module = {
+        parts.push(`let templatesModule = (() => {
+let module = {
     exports: undefined
 };
 
 ${precompiledTemplate}
 
-return module.exports;})());
+    return module.exports;
+})();
 `);
-        parts.push(`loader.addTemplateKey('${className}', '${className}');`);
 
-        for (let foundTemplateName of nodeVisitor.foundTemplateNames) {
-            if (process.platform === 'win32') {
-                foundTemplateName = slash(foundTemplateName);
-            }
-            parts.push(`require('${foundTemplateName}');`);
+        for (let foundTemplateName of visitor.foundTemplateNames) {
+            // require takes module name separated with forward slashes
+            parts.push(`require('${slash(foundTemplateName)}');`);
         }
 
+        parts.push(`env.registerTemplatesModule(templatesModule, '${key}');`);
+
         parts.push(`
-let template = env.loadTemplate('${className}');
+let template = env.loadTemplate('${key}');
 
-module.exports = function(context = {}) {
+module.exports = (context = {}) => {
     return template.render(context);
 };`);
 
@@ -112,7 +106,7 @@ module.exports = function(context = {}) {
             new PathSupportingArrayLoader(new Map([
                 [resourcePath, source]
             ])),
-            environment.getLoader()
+            loader
         ]));
 
         environment.on('template', (name: string, from: TwingSource) => {