eleventy-plugin-vento 2.1.0 → 2.3.0

package/.github/workflows/ci.yml

@@ -2,8 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [main, dev, alpha, beta, next, renovate/**]
-  workflow_dispatch:
+    branches-ignore: [main, alpha, beta, next]
   workflow_call:
 
 jobs:

package/.github/workflows/release.yml

@@ -1,16 +1,14 @@
-# Run releases every monday and wednesday
-# at 12:33 UTC (or manually)
-
 name: Release
 
 on:
-  schedule:
-    - cron: '33 12 * * 1,3'
+  push:
+    branches: [main, alpha, beta, next]
   workflow_dispatch:
 
 jobs:
   test:
     uses: ./.github/workflows/ci.yml
+
   release:
     runs-on: ubuntu-latest
     needs: test
@@ -34,4 +32,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: pnpm exec semantic-release
+        run: pnpm exec semantic-release --dryrun

package/VentoPlugin.js

@@ -14,6 +14,7 @@
  */
 
 import VentoJs from 'ventojs';
+import { ssr } from '#lib/ssr.js';
 
 // Expose autotrim plugin defaults
 import {
@@ -69,17 +70,21 @@ export function VentoPlugin(eleventyConfig, options = {}) {
 	// Load user-defined plugins into vento
 	for (const plugin of options.plugins) env.use(plugin);
 
+	// Load ssr plugin
+	env.use(ssr);
+
 	// Add autotrim plugin if enabled
 	if (options.trimTags === true) env.use(autoTrim());
 	else if (options.trimTags) env.use(autoTrim({ tags: options.trimTags }));
 
+	eleventyConfig.on('eleventy.before', () => env.cache.clear());
+
 	// Add vto as a template format and create a custom template for it
 	eleventyConfig.addTemplateFormats('vto');
 	eleventyConfig.addExtension('vto', {
 		outputFileExtension: 'html',
 
 		async compile(inputContent, inputPath) {
-			env.cache.clear();
 			return async (data) => {
 				if (options.addHelpers) {
 					// Extract a possible namespace from the addHelpers option
@@ -113,10 +118,10 @@ export function VentoPlugin(eleventyConfig, options = {}) {
 		},
 
 		compileOptions: {
-			permalink(linkContents, inputPath) {
+			permalink(linkContents) {
 				if (typeof linkContents !== 'string') return linkContents;
 				return async (data) => {
-					const result = await env.runString(linkContents, data, inputPath);
+					const result = await env.runString(linkContents, data);
 					return result.content;
 				};
 			},

package/eslint.config.js

@@ -17,7 +17,7 @@ export default [
 
 	// Configure ignores
 	{
-		ignores: ['**/.cache', '**/_site', '**/node_modules', '**/functions'],
+		ignores: ['**/node_modules'],
 	},
 
 	// Configure defaults

package/jsconfig.json

@@ -2,6 +2,9 @@
 	"compilerOptions": {
 		"module": "NodeNext",
 		"moduleResolution": "NodeNext",
-		"baseUrl": "."
+		"baseUrl": ".",
+		"paths": {
+			"#lib/*": ["./lib/*"]
+		}
 	}
 }

package/lib/ssr.js

@@ -0,0 +1,23 @@
+/**
+ * @typedef {import('ventojs/src/tokenizer.js').Token} Token
+ * @typedef {import('ventojs/src/environment.js').Environment} Environment
+ */
+
+/** @param {Environment} env */
+export function ssr(env) {
+	env.tags.push(ssrTag);
+}
+
+/**
+ * @param {string} code
+ * @param {Environment} env
+ * @param {string} output
+ * @param {Token[]} tokens
+ */
+function ssrTag(env, code, output, _tokens) {
+	if (!code.startsWith('!')) return;
+
+	const compiled = `{{${code.replace(/!(>?)\s+/, '$1 ')} }}`;
+
+	return `${output} += "${compiled}";`;
+}

package/package.json

@@ -1,9 +1,9 @@
 {
 	"name": "eleventy-plugin-vento",
-	"version": "2.1.0",
+	"version": "2.3.0",
 	"description": "Adds support for the Vento templating language to Eleventy.",
 	"type": "module",
-	"packageManager": "pnpm@9.2.0",
+	"packageManager": "pnpm@9.3.0",
 	"engines": {
 		"node": ">=16"
 	},
@@ -12,6 +12,9 @@
 		"lint": "eslint **/*.js --config ./eslint.config.js"
 	},
 	"main": "./VentoPlugin.js",
+	"imports": {
+		"#lib/*": "./lib/*"
+	},
 	"exports": {
 		".": "./VentoPlugin.js"
 	},
@@ -32,15 +35,15 @@
 	},
 	"license": "MIT",
 	"dependencies": {
-		"ventojs": "0.12.6"
+		"ventojs": "0.12.7"
 	},
 	"devDependencies": {
-		"@11ty/eleventy": "3.0.0-alpha.10",
+		"@11ty/eleventy": "3.0.0-alpha.11",
 		"conventional-changelog-conventionalcommits": "^8.0.0",
-		"eslint": "9.4.0",
 		"eslint-config-flat-gitignore": "0.1.5",
 		"eslint-config-prettier": "9.1.0",
-		"globals": "15.3.0",
+		"eslint": "9.4.0",
+		"globals": "15.4.0",
 		"semantic-release": "24.0.0",
 		"vitest": "1.6.0"
 	},

package/release.config.js

@@ -3,7 +3,7 @@ const presetConfig = {
 		{ type: 'feat', section: 'New Features' },
 		{ type: 'fix', section: 'Bug Fixes' },
 		{ type: 'refactor', section: 'Refactorings' },
-		{ type: 'docs', hidden: 'Documentation' },
+		{ type: 'docs', section: 'Documentation' },
 		{ type: 'chore', hidden: true },
 		{ type: 'perf', hidden: true },
 		{ type: 'style', hidden: true },

package/{test → tests}/includes/includes.test.js

@@ -1,20 +1,14 @@
 import { expect, test } from 'vitest';
 import { runBuild } from '../get-instance.js';
 
-console.log(import.meta.dirname);
-
 const results = await runBuild(import.meta.dirname);
 
 test('include a page', async () => {
 	const page = results.find(({ url }) => url === '/basic/');
-	await expect(page.content).toMatchFileSnapshot(
-		'./__snapshots__/includes-basic.html'
-	);
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/includes-basic.html');
 });
 
 test('include a page with data passing', async () => {
 	const page = results.find(({ url }) => url === '/with-data/');
-	await expect(page.content).toMatchFileSnapshot(
-		'./__snapshots__/includes-data.html'
-	);
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/includes-data.html');
 });

package/tests/permalinks/dynamic-js/dynamic-js.11tydata.js

@@ -0,0 +1,5 @@
+export default {
+	permalink({ title }) {
+		return `${this.slugify(title)}.html`;
+	},
+};

package/tests/permalinks/dynamic-js/dynamic-permalink-js.vto

@@ -0,0 +1,6 @@
+---
+title: Directory data test page (js)
+layout: layout.vto
+---
+
+This page has directory data set with dynamic permalinks

package/{test → tests}/permalinks/permalinks.test.js

@@ -5,27 +5,21 @@ const results = await runBuild(import.meta.dirname);
 
 test('render a page at a nested permalink', async () => {
 	const page = results.find(({ url }) => url === '/page/at/nested/permalink/');
-	await expect(page.content).toMatchFileSnapshot(
-		'./__snapshots__/permalink-nested.html'
-	);
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/permalink-nested.html');
 });
 
 test('render a page at root url', async () => {
 	const page = results.find(({ url }) => url === '/');
-	expect(page.content).toMatchFileSnapshot(
-		'./__snapshots__/permalink-root.html'
-	);
+	expect(page.content).toMatchFileSnapshot('./__snapshots__/permalink-root.html');
 });
 
 test('render a page at a dynamic permalink', async () => {
-	const page = results.find(
-		({ url }) => url === '/directory-data-test-page.html'
-	);
+	const page = results.find(({ url }) => url === '/directory-data-test-page.html');
 
 	expect(page).toBeDefined();
 });
 
 test('skips rendering a file', () => {
 	const writtenTemplates = results.filter(({ url }) => Boolean(url));
-	expect(writtenTemplates.length).toBe(3);
+	expect(writtenTemplates.length).toBe(4);
 });

package/{test → tests}/shortcodes/shortcodes.test.js

@@ -1,24 +1,19 @@
-import { test } from 'vitest';
+import { expect, test } from 'vitest';
 import { runBuild } from '../get-instance.js';
 
 const results = await runBuild(import.meta.dirname, {
 	eleventy(configApi) {
 		configApi.addShortcode('helloWorld', () => 'Hello world!');
-		configApi.addShortcode(
-			'possumPosse',
-			(number = 'the') => `Release ${number} possums!!!`
-		);
+		configApi.addShortcode('possumPosse', (number = 'the') => `Release ${number} possums!!!`);
 	},
 });
 
-test.concurrent('shortcode without argument', ({ expect }) => {
+test('shortcode without argument', () => {
 	const page = results.find(({ url }) => url === '/basic/');
 	expect(page.content).toBe('Hello world!\n');
 });
 
-test.concurrent('shortcode with arguments', async ({ expect }) => {
+test('shortcode with arguments', async () => {
 	const page = results.find(({ url }) => url === '/with-arguments/');
-	await expect(page.content).toMatchFileSnapshot(
-		'./__snapshots__/shortcode-with-arguments.html'
-	);
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/shortcode-with-arguments.html');
 });

package/tests/ssr/__snapshots__/ssr-data.html

@@ -0,0 +1 @@
+<p>{{ dynamicValue }}</p>

package/tests/ssr/__snapshots__/ssr-echo.html

@@ -0,0 +1,7 @@
+{{ echo }}
+
+{{ dataValue }}
+
+<p>Some more {{ dataValue }}</p>
+
+{{ /echo }}

package/tests/ssr/__snapshots__/ssr-exec.html

@@ -0,0 +1 @@
+{{> console.log('hello world!') }}

package/tests/ssr/__snapshots__/ssr-for.html

@@ -0,0 +1,3 @@
+{{ for value of [1,2,3] }}
+	{{ value }}
+{{ /for }}

package/tests/ssr/__snapshots__/ssr-if.html

@@ -0,0 +1,5 @@
+{{ if true }}
+
+<p>Some content</p>
+
+{{ /if }}

package/tests/ssr/data.vto

@@ -0,0 +1 @@
+<p>{{! dynamicValue }}</p>

package/tests/ssr/echo.vto

@@ -0,0 +1,7 @@
+{{! echo }}
+
+{{! dataValue }}
+
+<p>Some more {{! dataValue }}</p>
+
+{{! /echo }}

package/tests/ssr/exec.vto

@@ -0,0 +1 @@
+{{!> console.log('hello world!') }}

package/tests/ssr/for.vto

@@ -0,0 +1,3 @@
+{{! for value of [1,2,3] }}
+	{{! value }}
+{{! /for }}

package/tests/ssr/if.vto

@@ -0,0 +1,5 @@
+{{! if true }}
+
+<p>Some content</p>
+
+{{! /if }}

package/tests/ssr/ssr.test.js

@@ -0,0 +1,29 @@
+import { expect, test } from 'vitest';
+import { runBuild } from '../get-instance.js';
+
+const results = await runBuild(import.meta.dirname);
+
+test('render if', async () => {
+	const page = results.find(({ url }) => url === '/if/');
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/ssr-if.html');
+});
+
+test('render data', async () => {
+	const page = results.find(({ url }) => url === '/data/');
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/ssr-data.html');
+});
+
+test('render for', async () => {
+	const page = results.find(({ url }) => url === '/for/');
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/ssr-for.html');
+});
+
+test('render echo', async () => {
+	const page = results.find(({ url }) => url === '/echo/');
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/ssr-echo.html');
+});
+
+test('render exec', async () => {
+	const page = results.find(({ url }) => url === '/exec/');
+	await expect(page.content).toMatchFileSnapshot('./__snapshots__/ssr-exec.html');
+});