Merge pull request #8187 from RubenSlabbert/master

Nunjucks

nunjucks/nunjucks-tests.ts

@@ -0,0 +1,47 @@
+/// <reference path="nunjucks.d.ts" />
+
+import nunjucks = require("nunjucks");
+
+
+nunjucks.configure({ autoescape: false });
+
+let rendered = nunjucks.render("./noexists.html");
+
+let ctx = { items: ["Hello", "this", "is", "for", "testing"] };
+let src = "{% for item in items %}{{item}}{% endfor %}";
+
+rendered = nunjucks.renderString(src, ctx);
+
+let compiled = nunjucks.compile(src);
+rendered = compiled.render(ctx);
+
+rendered = nunjucks.precompileString(src, {
+    name: "TestyWesty"
+});
+
+let template = new nunjucks.Template(src);
+rendered = template.render(ctx);
+
+let env = nunjucks.configure({ autoescape: false });
+rendered = env.renderString(src, ctx);
+
+env.addExtension("SpawnGlitter", {
+    tags: ["glitter", "star wars", "Age of Empires"],
+    parse(parser, nodes, lexer) {
+        return "The parser api is complicated";
+    }
+});
+
+nunjucks.installJinjaCompat();
+
+class MyLoader extends nunjucks.Loader implements nunjucks.ILoader {
+    getSource(name: string): nunjucks.LoaderSource {
+        return {
+            src: "Amadala",
+            path: "The Right One",
+            noCache: false
+        };
+    }
+}
+
+env = new nunjucks.Environment(new MyLoader());

nunjucks/nunjucks.d.ts

@@ -0,0 +1,133 @@
+// Type definitions for nunjucks
+// Project: http://mozilla.github.io/nunjucks/
+// Definitions by: Ruben Slabbert <https://github.com/RubenSlabbert/>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+declare module "nunjucks" {
+    namespace Nunjucks {
+        function render(name: string, context?: Object): string;
+        function render(name: string, context?: Object, callback?: (err: any, res: string) => any): void;
+
+        function renderString(src: string, context: Object): string;
+        function renderString(src: string, context: Object, callback?: (err: any, res: string) => any): void;
+
+        function compile(src: string, env?: Environment): Template;
+        function compile(src: string, env?: Environment, callback?: (err: any, res: Template) => any): Template;
+
+        function precompile(path: string, opts?: PrecompileOptions): string;
+        function precompileString(src: string, opts?: PrecompileOptions): string;
+
+        interface PrecompileOptions {
+            name?: string;
+            asFunction?: boolean;
+            force?: boolean;
+            env?: Environment;
+            include?: string[];
+            exclude?: string[];
+            wrapper?(templates: { name: string, template: string }, opts: PrecompileOptions): string;
+        }
+
+        class Template {
+            constructor(src: string, env?: Environment, eagerCompile?: boolean);
+            render(context?: Object): string;
+            render(context?: Object, callback?: (err: any, res: string) => any): void;
+        }
+
+        function configure(options: ConfigureOptions): Environment;
+        function configure(path: string, options?: ConfigureOptions): Environment;
+
+        interface ConfigureOptions {
+            autoescape?: boolean;
+            throwOnUndefined?: boolean;
+            trimBlocks?: boolean;
+            lstripBlocks?: boolean;
+            watch?: boolean;
+            noCache?: boolean;
+            web?: {
+                useCache?: boolean,
+                async?: boolean
+            };
+            express?: Object;
+            tags?: {
+                blockStart?: string,
+                blockEnd?: string,
+                variableStart?: string,
+                variableEnd?: string,
+                commentStart?: string,
+                commentEnd?: string
+            };
+        }
+
+        class Environment {
+            options: {
+                autoescape: boolean;
+            };
+
+            constructor(loader: ILoader, opts?: ConfigureOptions);
+            constructor(loaders: ILoader[], opts?: ConfigureOptions);
+
+            render(name: string, context?: Object): string;
+            render(name: string, context?: Object, callback?: (err: any, res: string) => any): void;
+
+            renderString(name: string, context: Object): string;
+            renderString(name: string, context: Object, callback?: (err: any, res: string) => any): void;
+
+            addFilter(name: string, func: (...args: any[]) => any, async?: boolean): void;
+            getFilter(name: string): void;
+
+            addExtension(name: string, ext: Extension): void;
+            removeExtension(name: string): void;
+            getExtension(name: string): Extension;
+            hasExtension(name: string): void;
+
+            addGlobal(name: string, value: any): void;
+
+            getTemplate(name: string, eagerCompile?: boolean): Template;
+            getTemplate(name: string, eagerCompile?: boolean, callback?: (err: any, templ: Template) => Template): void;
+
+            express(app: Object): void;
+        }
+
+        interface Extension {
+            tags: string[];
+            // Parser API is undocumented it is suggested to check the source: https://github.com/mozilla/nunjucks/blob/master/src/parser.js
+            parse(parser: any, nodes: any, lexer: any): any;
+        }
+
+        function installJinjaCompat(): void;
+
+        interface ILoader {
+            async?: boolean;
+            getSource(name: string): LoaderSource;
+            extend?(extender: ILoader): ILoader;
+        }
+
+        // Needs both Loader and ILoader since nunjucks uses a custom object system
+        // Object system is also responsible for the extend methods
+        class Loader {
+            on(name: string, func: (...args: any[]) => any): void;
+            emit(name: string, ...args: any[]): void;
+            resolve(from: string, to: string): string;
+            isRelative(filename: string): boolean;
+            extend(toExtend: ILoader): ILoader;
+        }
+
+        interface LoaderSource {
+            src: string;
+            path: string;
+            noCache: boolean;
+        }
+
+        class FileSystemLoader extends Loader implements ILoader {
+            init(searchPaths: string[], opts: any): void;
+            getSource(name: string): LoaderSource;
+        }
+
+        class PrecompiledLoader extends Loader implements ILoader {
+            init(searchPaths: string[], opts: any): void;
+            getSource(name: string): LoaderSource;
+        }
+    }
+
+    export = Nunjucks;
+}