eleventy-plugin-vento 1.0.4 → 1.1.1

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

@@ -0,0 +1,26 @@
+name: Handle pnpm dependencies
+description: Cache and restore the dependencies with pnpm
+
+outputs:
+  cache-hit:
+    description: 'Whether restoring the cache was successful or not'
+    value: ${{ steps.setup-node.outputs.cache-hit }}
+
+runs:
+  using: composite
+  steps:
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v4
+
+    - name: Setup node
+      id: setup-node
+      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
+
+    - name: Install dependencies
+      run: pnpm install --frozen-lockfile
+      shell: bash

package/.github/renovate.json

@@ -1,13 +1,3 @@
 {
-	"extends": ["github>noelforte/renovate-config", "group:allNonMajor"],
-	"customManagers": [
-		{
-			"customType": "regex",
-			"fileMatch": ["(^|\\/)\\.mise\\.toml$"],
-			"matchStrings": [
-				"#renovate: datasource=(?<datasource>\\S+)(\\s|\\sversioning=(?<versioning>\\S+)\\s)(?<depName>\\S+)\\s?=\\s?\"(?<currentValue>[^\\\"]+)\""
-			],
-			"versioningTemplate": "{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}"
-		}
-	]
+	"extends": ["github>noelforte/renovate-config", "group:allNonMajor"]
 }

package/.github/workflows/ci.yaml

@@ -2,47 +2,17 @@ name: CI
 
 on:
   push:
-    branches: [renovate/**]
+    branches: [renovate/**, dev]
   workflow_dispatch:
 
 jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
-      # ========== SETUP ========== #
-      - name: Check out repository
-        uses: actions/checkout@v4.1.6
+      - uses: actions/checkout@v4
 
-      # Setup node
-      - name: Setup tools
-        uses: jdx/mise-action@v2
+      - name: Setup
+        uses: ./.github/actions/setup
 
-      # Setup pnpm
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v4.0.0
-
-      # Get metadata
-      - name: Get pnpm store directory
-        id: get-pnpm-store
-        shell: bash
-        run: echo "path=$(pnpm store path --silent)" >> "$GITHUB_OUTPUT"
-
-      # Setup the cache
-      - uses: actions/cache@v4
-        name: Restore cache
-        id: cache-deps
-        with:
-          path: ${{ steps.get-pnpm-store.outputs.path }}
-          key:
-            deps_os-${{ runner.os }}_arch-${{ runner.arch }}_${{
-            hashFiles('./pnpm-lock.yaml') }}
-
-      # Install dependencies
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile --prefer-offline
-        shell: bash
-
-      # ========== CHECK ========== #
-      - name: Run checks
+      - name: Test
         run: pnpm test
-        shell: bash

package/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - 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: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: CHANGELOG.md

package/.node-version

@@ -0,0 +1 @@
+20.14.0

package/VentoPlugin.js

@@ -1,13 +1,14 @@
 /**
- * @file Adds Vento support to Eleventy.
+ * @file Adds support for the Vento templating language to Eleventy.
  *
  * @typedef VentoPluginOptions
  * @prop {Object<string,(...any) => any} [filters={}] An object containing methods that
  * will be loaded as filters into Vento.
+ * @prop {Function[]} [plugins=[]] An array of plugins to load into vento.
  * @prop {import('ventojs').Options} [ventoOptions] Vento engine configuration object
  * that will be merged with default options.
- * @prop {string|boolean} [addHelpers=true] Whether
- * [Javascript Functions](https://www.11ty.dev/docs/languages/javascript/#javascript-template-functions)
+ * @prop {string|boolean} [addHelpers=true]
+ * Whether [Javascript Functions](https://www.11ty.dev/docs/languages/javascript/#javascript-template-functions)
  * should be merged into data provided to templates. If a string, functions will be namespaced under
  * a property with this name.
  */
@@ -31,6 +32,7 @@ export function VentoPlugin(eleventyConfig, options = {}) {
 	options = {
 		addHelpers: true,
 		filters: {},
+		plugins: [],
 		ventoOptions: {
 			includes: path.join(dir.input, dir.includes),
 			autoescape: false,
@@ -44,6 +46,9 @@ export function VentoPlugin(eleventyConfig, options = {}) {
 	// Load user-defined filters into vento
 	for (const filter in options.filters) env.filters[filter] = options.filters[filter];
 
+	// Load user-defined plugins into vento
+	for (const plugin of options.plugins) env.use(plugin);
+
 	eleventyConfig.on('eleventy.before', () => {
 		env.cache.clear();
 	});

package/package.json

@@ -1,44 +1,46 @@
 {
-	"name": "eleventy-plugin-vento",
-	"version": "1.0.4",
-	"description": "Adds support for the Vento templating language to Eleventy",
-	"type": "module",
-	"packageManager": "pnpm@9.1.4",
-	"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": {
-		"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"
-	}
-}
+  "name": "eleventy-plugin-vento",
+  "version": "1.1.1",
+  "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"
+  }
+}

package/readme.md

@@ -43,6 +43,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 +60,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 +69,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 +88,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/test/input/eleventy.config.js

@@ -1,4 +1,5 @@
 import { VentoPlugin } from '../../VentoPlugin.js';
+import autoTrim from 'ventojs/plugins/auto_trim.js';
 
 export const config = {
 	dir: {
@@ -15,6 +16,7 @@ export default async function (eleventyConfig) {
 				return `<em>${content}</em>`;
 			},
 		},
+		plugins: [autoTrim()],
 	});
 
 	eleventyConfig.addShortcode('possumPosse', () => 'Release the possums!!!');

package/test/input/whitespace-control.vto

@@ -0,0 +1,5 @@
+{{ set name = "Bob" }}
+{{ if true }}
+  Hello, {{ name }}!
+  {{ set variable = 10 }}
+{{ /if }}

package/.mise.toml

@@ -1,3 +0,0 @@
-[tools]
-#renovate: datasource=node-version versioning=node
-node = "20.14.0"