eleventy-plugin-vento 1.1.0 → 1.1.2

package/.github/actions/setup/action.yml

@@ -1,5 +1,5 @@
-name: Handle pnpm dependencies
-description: Cache and restore the dependencies with pnpm
+name: Setup
+description: Setup project with pnpm
 
 outputs:
   cache-hit:
@@ -17,7 +17,6 @@ runs:
       uses: actions/setup-node@v4
       with:
         node-version-file: .node-version
-        registry-url: 'https://registry.npmjs.org'
         cache: pnpm
         cache-dependency-path: pnpm-lock.yaml
 

package/.github/workflows/{ci.yaml → ci.yml}

@@ -2,8 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [renovate/**, dev]
+    branches: [renovate/**]
   workflow_dispatch:
+  workflow_call:
 
 jobs:
   ci:

package/.github/workflows/release.yml

@@ -2,35 +2,40 @@ name: Release
 
 on:
   push:
-    tags:
-      - 'v*.*.*'
+    branches:
+      - main
+      - alpha
+      - beta
+      - next
+      - next-major
+      - v[0-9]+.[0-9]+.[0-9]+
+      - v[0-9]+.[0-9]+.[0-9]+-[a-z]+.[0-9]+
 
 jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
   release:
     runs-on: ubuntu-latest
     permissions:
-      id-token: write
-      contents: write
+      contents: write # to be able to publish a GitHub release
+      id-token: write # to enable use of OIDC for npm provenance
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+    needs: test
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Setup
         uses: ./.github/actions/setup
 
-      - name: Test
-        run: pnpm test
-
-      - name: Publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NPM_CONFIG_PROVENANCE: true
-        run: |
-          pnpm publish --no-git-checks --access public
-
-      - name: Write changelog
-        run: pnpm dlx changelogithub@latest --output CHANGELOG.md
+      - name: Verify provenance attestations and registry signatures
+        run: npm audit signatures
 
       - name: Release
-        uses: softprops/action-gh-release@v2
-        with:
-          body_path: CHANGELOG.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: pnpm exec semantic-release

package/VentoPlugin.js

@@ -57,6 +57,7 @@ export function VentoPlugin(eleventyConfig, options = {}) {
 	eleventyConfig.addTemplateFormats('vto');
 	eleventyConfig.addExtension('vto', {
 		outputFileExtension: 'html',
+
 		async compile(inputContent, inputPath) {
 			return async (data) => {
 				if (options.addHelpers) {
@@ -76,5 +77,12 @@ export function VentoPlugin(eleventyConfig, options = {}) {
 				return await env.runString(inputContent, data, inputPath).then((result) => result.content);
 			};
 		},
+
+		compileOptions: {
+			permalink(contents, inputPath) {
+				if (!contents) return contents;
+				return (data) => env.runString(contents, data, inputPath).then((result) => result.content);
+			},
+		},
 	});
 }

package/package.json

@@ -1,46 +1,49 @@
 {
-  "name": "eleventy-plugin-vento",
-  "version": "1.1.0",
-  "description": "Adds support for the Vento templating language to Eleventy.",
-  "type": "module",
-  "engines": {
-    "node": ">=16"
-  },
-  "main": "./VentoPlugin.js",
-  "repository": "git@github.com:noelforte/eleventy-plugin-vento.git",
-  "bugs": {
-    "url": "https://github.com/noelforte/eleventy-plugin-vento/issues"
-  },
-  "keywords": [
-    "eleventy",
-    "eleventy-plugin",
-    "ventojs",
-    "templating"
-  ],
-  "author": {
-    "name": "Noel Forte",
-    "email": "noel@forte.is",
-    "url": "https://forte.is/"
-  },
-  "license": "MIT",
-  "dependencies": {
-    "ventojs": "0.12.6"
-  },
-  "devDependencies": {
-    "eslint": "9.4.0",
-    "eslint-config-flat-gitignore": "0.1.5",
-    "eslint-config-prettier": "9.1.0",
-    "globals": "15.3.0",
-    "@11ty/eleventy": "3.0.0-alpha.10"
-  },
-  "prettier": {
-    "bracketSameLine": true,
-    "singleQuote": true,
-    "semi": true,
-    "trailingComma": "es5"
-  },
-  "scripts": {
-    "test": "rm -rf test/output; cd test/input; eleventy",
-    "test-serve": "rm -rf test/output; cd test/input; eleventy --serve"
-  }
-}
+	"name": "eleventy-plugin-vento",
+	"version": "1.1.2",
+	"description": "Adds support for the Vento templating language to Eleventy.",
+	"type": "module",
+	"packageManager": "pnpm@9.1.4",
+	"engines": {
+		"node": ">=16"
+	},
+	"scripts": {
+		"test": "rm -rf test/output; cd test/input; eleventy",
+		"test-serve": "rm -rf test/output; cd test/input; eleventy --serve"
+	},
+	"main": "./VentoPlugin.js",
+	"repository": "git@github.com:noelforte/eleventy-plugin-vento.git",
+	"bugs": {
+		"url": "https://github.com/noelforte/eleventy-plugin-vento/issues"
+	},
+	"keywords": [
+		"eleventy",
+		"eleventy-plugin",
+		"ventojs",
+		"templating"
+	],
+	"author": {
+		"name": "Noel Forte",
+		"email": "noel@forte.is",
+		"url": "https://forte.is/"
+	},
+	"license": "MIT",
+	"dependencies": {
+		"ventojs": "0.12.6"
+	},
+	"devDependencies": {
+		"@11ty/eleventy": "3.0.0-alpha.10",
+		"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",
+		"semantic-release": "24.0.0"
+	},
+	"prettier": {
+		"bracketSameLine": true,
+		"singleQuote": true,
+		"semi": true,
+		"trailingComma": "es5"
+	}
+}

package/readme.md

@@ -6,6 +6,7 @@ An [Eleventy](https://11ty.dev/) plugin that adds support for [Vento](https://ve
 [Usage](#usage)<br>
 [Plugin Options](#plugin-options)<br>
 [Vento Filters](#vento-filters)<br>
+[Vento Plugins](#vento-plugins)<br>
 [JavaScript Helpers](#javascript-helpers)<br>
 
 ## Installing
@@ -43,6 +44,9 @@ export default function (eleventyConfig) {
     // A set of filters to load into Vento
     filters: {},
 
+    // An array of Vento plugins to load
+    plugins: [],
+
     // Define whether Javascript Functions should be added
     // to page data. See below for usage notes on this.
     addHelpers: true
@@ -57,7 +61,7 @@ export default function (eleventyConfig) {
 }
 ```
 
-View the [full list of options](https://vento.js.org/configuration/#options/) to pass as a Vento Configuration object.
+View the [full list of options](https://vento.js.org/configuration/#options/) to pass as a Vento Configuration object (as `ventoOptions`).
 
 ## Vento Filters
 
@@ -66,12 +70,14 @@ Set the `filters` property to an object with methods, these will be loaded as fi
 Here's an example of defining an `italicize` filter like the example in the Vento documentation:
 
 ```js
-{
-  filters: {
-    italicize(text) {
-      return `<em>${text}</em>`
-    }
-  }
+export default function (eleventyConfig) {
+  eleventyConfig.addPlugin(VentoPlugin, {
+    filters: {
+      italicize(text) {
+        return `<em>${text}</em>`;
+      },
+    },
+  });
 }
 ```
 
@@ -83,6 +89,25 @@ And now we can use our filter in a template:
 
 See https://vento.js.org/configuration/#filters for more information about filters and how they work.
 
+## Vento Plugins
+
+If you'd like to extend the Vento library with any plugins, include them in an array passed to the `plugins` option. Here's an example loading the [auto trim](https://vento.js.org/plugins/auto-trim/) plugin:
+
+```js
+import { VentoPlugin } from 'eleventy-plugin-vento';
+import autoTrim, { defaultTags } from 'ventojs/plugins/autotrim_plugin.js';
+
+export default function (eleventyConfig) {
+  eleventyConfig.addPlugin(VentoPlugin, {
+    plugins: [
+      autoTrim({
+        tags: ['tag', ...defaultTags],
+      }),
+    ],
+  });
+}
+```
+
 ## JavaScript Helpers
 
 Vento can [run arbitrary JavaScript](https://vento.js.org/syntax/javascript/) in templates through its `{{> ...}}` operator, which evaluates at the time the template is run. However, you may want to use Eleventy Shortcodes and Filters in your templates as well.

package/release.config.js

@@ -0,0 +1,24 @@
+const presetConfig = {
+	types: [
+		{ type: 'feat', section: 'New Features' },
+		{ type: 'fix', section: 'Bug Fixes' },
+		{ type: 'refactor', section: 'Refactorings' },
+		{ type: 'docs', hidden: 'Documentation' },
+		{ type: 'chore', hidden: true },
+		{ type: 'perf', hidden: true },
+		{ type: 'style', hidden: true },
+		{ type: 'test', hidden: true },
+	],
+};
+
+/** @type {import('semantic-release').Options} */
+export default {
+	preset: 'conventionalcommits',
+	presetConfig,
+	plugins: [
+		['@semantic-release/commit-analyzer'],
+		'@semantic-release/release-notes-generator',
+		'@semantic-release/npm',
+		'@semantic-release/github',
+	],
+};

package/test/input/root.vto

@@ -0,0 +1,6 @@
+---
+permalink: /
+layout: page-layout.vto
+---
+
+This should render on the homepage.