-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add live preview support for nunjucks dependencies
- Loading branch information
Showing
8 changed files
with
241 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /** | ||
| Patch for nunjucks to emit the 'load' event, even if the template is accessed from its internal cache. | ||
| https://mozilla.github.io/nunjucks/api.html#load-event | ||
| This allows page dependencies to be properly collected for live preview in {@link VariableRenderer}. | ||
| Patch is written against nunjucks v3.2.2 | ||
| Changes are delimited with a // CHANGE HERE comment | ||
| */ | ||
|
|
||
| const { Environment, Template, lib } = require('nunjucks'); | ||
|
|
||
| /* eslint-disable */ | ||
|
|
||
| var noopTmplSrc = { | ||
| type: 'code', | ||
| obj: { | ||
| root: function root(env, context, frame, runtime, cb) { | ||
| try { | ||
| cb(null, ''); | ||
| } catch (e) { | ||
| cb(handleError(e, null, null)); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| Environment.prototype.getTemplate = function getTemplate(name, eagerCompile, parentName, ignoreMissing, cb) { | ||
| var _this3 = this; | ||
|
|
||
| var that = this; | ||
| var tmpl = null; | ||
|
|
||
| if (name && name.raw) { | ||
| // this fixes autoescape for templates referenced in symbols | ||
| name = name.raw; | ||
| } | ||
|
|
||
| if (lib.isFunction(parentName)) { | ||
| cb = parentName; | ||
| parentName = null; | ||
| eagerCompile = eagerCompile || false; | ||
| } | ||
|
|
||
| if (lib.isFunction(eagerCompile)) { | ||
| cb = eagerCompile; | ||
| eagerCompile = false; | ||
| } | ||
|
|
||
| if (name instanceof Template) { | ||
| tmpl = name; | ||
| } else if (typeof name !== 'string') { | ||
| throw new Error('template names must be a string: ' + name); | ||
| } else { | ||
| for (var i = 0; i < this.loaders.length; i++) { | ||
| var loader = this.loaders[i]; | ||
| tmpl = loader.cache[this.resolveTemplate(loader, parentName, name)]; | ||
|
|
||
| if (tmpl) { | ||
| // CHANGE HERE | ||
|
|
||
| // pathsToNames in nunjucks.loaders.FileSystemLoader maintains a reverse mapping of fullPath: name | ||
| Object.entries(loader.pathsToNames).forEach(([fullPath, templateName]) => { | ||
| if (name === templateName) { | ||
| // Emit the load event | ||
| this.emit('load', name, { | ||
| src: tmpl, | ||
| path: fullPath, // we only need this | ||
| noCache: loader.noCache | ||
| }, loader) | ||
| } | ||
| }); | ||
|
|
||
| break; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (tmpl) { | ||
| if (eagerCompile) { | ||
| tmpl.compile(); | ||
| } | ||
|
|
||
| if (cb) { | ||
| cb(null, tmpl); | ||
| return undefined; | ||
| } else { | ||
| return tmpl; | ||
| } | ||
| } | ||
|
|
||
| var syncResult; | ||
|
|
||
| var createTemplate = function createTemplate(err, info) { | ||
| if (!info && !err && !ignoreMissing) { | ||
| err = new Error('template not found: ' + name); | ||
| } | ||
|
|
||
| if (err) { | ||
| if (cb) { | ||
| cb(err); | ||
| return; | ||
| } else { | ||
| throw err; | ||
| } | ||
| } | ||
|
|
||
| var newTmpl; | ||
|
|
||
| if (!info) { | ||
| newTmpl = new Template(noopTmplSrc, _this3, '', eagerCompile); | ||
| } else { | ||
| newTmpl = new Template(info.src, _this3, info.path, eagerCompile); | ||
|
|
||
| if (!info.noCache) { | ||
| info.loader.cache[name] = newTmpl; | ||
| } | ||
| } | ||
|
|
||
| if (cb) { | ||
| cb(null, newTmpl); | ||
| } else { | ||
| syncResult = newTmpl; | ||
| } | ||
| }; | ||
|
|
||
| lib.asyncIter(this.loaders, function (loader, i, next, done) { | ||
| function handle(err, src) { | ||
| if (err) { | ||
| done(err); | ||
| } else if (src) { | ||
| src.loader = loader; | ||
| done(null, src); | ||
| } else { | ||
| next(); | ||
| } | ||
| } // Resolve name relative to parentName | ||
|
|
||
|
|
||
| name = that.resolveTemplate(loader, parentName, name); | ||
|
|
||
| if (loader.async) { | ||
| loader.getSource(name, handle); | ||
| } else { | ||
| handle(null, loader.getSource(name)); | ||
| } | ||
| }, createTemplate); | ||
| return syncResult; | ||
| } |
Oops, something went wrong.