Merge pull request #13 from 11ty/pug

Initial pug plugin code from https://github.com/Zearin/eleventy-plugin-pug

Author: zachleat

README.md

@@ -4,3 +4,4 @@
 - [`@11ty/eleventy-plugin-handlebars` in `handlebars/`](./handlebars/README.md)
 - [`@11ty/eleventy-plugin-mustache` in `mustache/`](./mustache/README.md)
 - [`@11ty/eleventy-plugin-haml` in `haml/`](./haml/README.md)
+- [`@11ty/eleventy-plugin-pug` in `pug/`](./pug/README.md)

ejs/test/ejs-test.mjs

@@ -60,7 +60,7 @@ name: Zach
 });
 
 describe("EJS Includes", () => {
-	test("EJS Render Absolute Include, Fxn no Data", async function () {
+	test("Render Absolute Include, Fxn no Data", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("filename.ejs", "<p><%- include('/included') %></p>", {
 				name: "Zach",
@@ -70,7 +70,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Absolute Include, Fxn with Data", async function () {
+	test("Render Absolute Include, Fxn with Data", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -83,7 +83,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an Bill.</p>`);
 	});
 
-	test("EJS Render Relative Include (no leading dot-slash for current dir)", async function () {
+	test("Render Relative Include (no leading dot-slash for current dir)", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -96,7 +96,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Relative Include Current dir to Subdir", async function () {
+	test("Render Relative Include Current dir to Subdir", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -109,7 +109,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Relative Include Parent dir to Subdir", async function () {
+	test("Render Relative Include Parent dir to Subdir", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -122,7 +122,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Relative Include Parent dir to Subdir", async function () {
+	test("Render Relative Include Parent dir to Subdir", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -135,7 +135,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Relative Include, Fxn no Data", async function () {
+	test("Render Relative Include, Fxn no Data", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -148,7 +148,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Relative Include current dir to subdir, Fxn no Data", async function () {
+	test("Render Relative Include current dir to subdir, Fxn no Data", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(
@@ -161,7 +161,7 @@ describe("EJS Includes", () => {
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("EJS Render Relative Include, Fxn with Data", async function () {
+	test("Render Relative Include, Fxn with Data", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			// includes require a full filename passed in
 			eleventyConfig.addTemplate(

handlebars/test/hbs-test.mjs

@@ -44,9 +44,9 @@ test("Handlebars permalink", async function () {
 	strictEqual(result.url, `/this-is-a-url/`);
 });
 
-describe("Escaped and unescaped output", () => {
+describe("Handlebars Escaped and unescaped output", () => {
 
-	test("Handlebars unescaped output (no HTML)", async function () {
+	test("Unescaped output (no HTML)", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{{name}}}</p>", {
 				name: "Zach",
@@ -56,7 +56,7 @@ describe("Escaped and unescaped output", () => {
 		strictEqual(result.content, `<p>Zach</p>`);
 	});
 
-	test("Handlebars escaped output (HTML)", async function () {
+	test("Escaped output (HTML)", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{name}}</p>", {
 				name: "<b>Zach</b>",
@@ -66,7 +66,7 @@ describe("Escaped and unescaped output", () => {
 		strictEqual(result.content, `<p>&lt;b&gt;Zach&lt;/b&gt;</p>`);
 	});
 
-	test("Handlebars Unescaped Output (HTML)", async function () {
+	test("Unescaped Output (HTML)", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{{name}}}</p>", {
 				name: "<b>Zach</b>",
@@ -78,31 +78,31 @@ describe("Escaped and unescaped output", () => {
 });
 
 describe("Handlebars Partials", () => {
-	test("Handlebars Partial", async function () {
+	test("Partial", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{> included}}</p>", {});
 		});
 
 		strictEqual(result.content, `<p>This is an include.</p>`);
 	});
 
-	test("Handlebars Render Partial (Subdirectory)", async () => {
+	test("Render Partial (Subdirectory)", async () => {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{> subfolder/included-subfolder}}</p>", {});
 		});
 
 		strictEqual(result.content, `<p>This is a subfolder include.</p>`);
 	});
 
-	test("Handlebars Partial with variable", async () => {
+	test("Partial with variable", async () => {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{> includedvar}}</p>", { name: "Zach" });
 		});
 
 		strictEqual(result.content, "<p>This is a Zach.</p>");
 	});
 
-	test("Handlebars Partial with parameter", async () => {
+	test("Partial with parameter", async () => {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.hbs", "<p>{{> myPartial parameter=name }}</p>", { name: "Zach" });
 		});

mustache/test/mustache-test.mjs

@@ -44,7 +44,7 @@ test("Mustache permalink", async function () {
 	strictEqual(result.url, `/this-is-a-url/`);
 });
 
-describe("Partials", () => {
+describe("Mustache Partials", () => {
 	test("Partial raw text", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.mustache", "<p>{{> include}}</p>");
@@ -70,7 +70,7 @@ describe("Partials", () => {
 	});
 });
 
-test("Library override", async function () {
+test("Mustache Library override", async function () {
 	let [result] = await getTestResults((eleventyConfig) => {
 		eleventyConfig.addTemplate("sample.mustache", "<p>{{name}}</p>", { name: "Zach" });
 	}, {
@@ -80,7 +80,7 @@ test("Library override", async function () {
 	strictEqual(result.content, `<p>Zach</p>`);
 });
 
-describe("Escaped/unescaped output", () => {
+describe("Mustache Escaped/unescaped output", () => {
 	test("Escaped output (no HTML)", async function () {
 		let [result] = await getTestResults((eleventyConfig) => {
 			eleventyConfig.addTemplate("sample.mustache", "<p>{{{name}}}</p>", { name: "Zach" });

package.json

@@ -4,7 +4,8 @@
 		"ejs",
 		"handlebars",
 		"mustache",
-		"haml"
+		"haml",
+		"pug"
 	],
 	"type": "module",
 	"scripts": {

pug/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zearin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pug/README.md

@@ -0,0 +1,2 @@
+# eleventy-plugin-pug
+Pug templates for Eleventy 3!

pug/defaults.js

@@ -0,0 +1,111 @@
+/**
+ *	@fileoverview Pug default options.
+ */
+
+export const DEFAULT_PUG_OPTIONS = {
+	/**
+	 *	The name of the file being compiled. Used in exceptions, and required for
+	 *	relative `include`\s and `extend`\s.
+	 *	@type {String}
+	 *	@default 'Pug'
+	 */
+	filename: 'Pug',
+
+	/**
+	 *	The root directory of all absolute inclusion.
+	 *	@type {String}
+	 */
+	basedir: '.',
+
+	/**
+	 *	If the doctype is not specified as part of the template, you can specify it here.
+	 *	It is sometimes useful to get self-closing tags and remove mirroring of boolean attributes.
+	 *	See doctype documentation for more information.
+	 *	@type {String|undefined}
+	 *	@default undefined
+	 */
+	doctype: undefined,
+
+	/**
+	 *	[Deprecated.] Adds whitespace to the resulting HTML to make it easier for a human to read
+	 *	using '  ' as indentation. If a string is specified, that will be used as indentation instead
+	 *	(e.g. '\t').
+	 *
+	 *	We strongly recommend against using this option. Too often, it creates subtle bugs in your
+	 *	templates because of the way it alters the interpretation and rendering of whitespace, and
+	 *	so this feature is going to be removed. Defaults to `false`.
+	 *
+	 *	@type {Boolean|String}
+	 *	@default false
+	 */
+	pretty: false,
+
+	/**
+	 *	Hash table of custom filters. Defaults to `undefined`.
+	 *	@type {Object|undefined}
+	 *	@default undefined
+	 */
+	filters: undefined,
+
+	/**
+	 *	Use a self namespace to hold the locals. It will speed up the compilation, but
+	 *	instead of writing `variable` you will have to write `self.variable` to access
+	 *	a property of the `locals` object. Defaults to `false`.
+	 *	@type {Boolean}
+	 *	@default false
+	 */
+	self: false,
+
+	/**
+	 *	If set to `true`, the tokens and function body are logged to stdout.
+	 *	@type {Boolean}
+	 *	@default false
+	 */
+	debug: false,
+
+	/**
+	 *	If set to `true`, the function source will be included in the compiled template for
+	 *	better error messages (sometimes useful in development).
+	 *	It is enabled by default, unless used with Express in production mode.
+	 *	@type {Boolean}
+	 *	@default true
+	 */
+	compileDebug: true,
+
+	/**
+	 *	Add a list of global names to make accessible in templates.
+	 *	@type {Array<String>}
+	 *	@default []
+	 */
+	globals: [],
+
+	/**
+	 *	(Only applies to `render*` functions.) If set to `true`, compiled functions
+	 *	are cached. `filename` must be set as the cache key. Defaults to `false`.
+	 *	@type {Boolean}
+	 *	@default false
+	 */
+	cache: false,
+
+	/**
+	 *	Inline runtime functions instead of require-ing them from a shared version.
+	 *
+	 * 	For `compileClient*` functions, the default is `true` (so that one does not
+	 * 	have to include the runtime).
+	 *
+	 *	For all other compilation or rendering types, the default is `false`.
+	 *	@type {Boolean}
+	 *	@default false
+	 */
+	inlineRuntimeFunctions: false,
+
+	/**
+	 *	(Only applies to `compileClient*` functions.) The name of the template function.
+	 *	Defaults to 'template'.
+	 *	@type {String}
+	 *	@default 'template'
+	 */
+	name: 'template'
+}
+
+export default DEFAULT_PUG_OPTIONS