mikel-frontmatter 0.32.0 → 0.33.1

package/README.md

@@ -34,7 +34,7 @@ const m = mikel.create();
 m.use(mikelFrontmatter({ ... }));
 ```
 
-In your template, the `{{#frontmatter}}` helper allows you to define metadata at the beginning of your templates, similar to frontmatter in Markdown files. The parsed data is stored as a variable accessible via `@frontmatter` (or a custom variable name, see below).
+In your template, the `{{#frontmatter}}` helper allows you to define metadata at the beginning of your templates, similar to frontmatter in Markdown files. The parsed data is stored as a state variable accessible via `@frontmatter` (or a custom variable name, see below).
 
 Example:
 
@@ -64,7 +64,7 @@ The `{{#frontmatter}}` helper accepts the following arguments:
 
 #### as
 
-Custom variable name to save parsed metadata. If not provided, parsed metadata will be saved in `@frontmatter`. Example:
+Custom state variable name to save parsed metadata. If not provided, parsed metadata will be saved in `@frontmatter`. Example:
 
 ```html
 {{#frontmatter as="meta"}}

package/index.d.ts

@@ -33,12 +33,11 @@ declare function mikelFrontmatter(options?: MikelFrontmatterOptions): {
     helpers: {
         frontmatter: (params: {
             args: any[];
-            opt?: Record<string, any>;
             options: Record<string, any>;
             tokens: string[];
             data: Record<string, any>;
-            variables: Record<string, any>;
-            fn: (blockData?: Record<string, any>, blockVars?: Record<string, any>, blockOutput?: string[]) => string;
+            state: Record<string, any>;
+            fn: (blockData?: Record<string, any>, blockState?: Record<string, any>, blockOutput?: string[]) => string;
         }) => string;
     };
 };

package/index.js

@@ -211,22 +211,20 @@ const parseFrontmatterBlock = (content = "", format = "yaml", parser = null) =>
 // @description plugin to register a #frontmatter helper
 // @param {Object} options - plugin options
 // @param {Function} options.parser - custom YAML parser function
-const mikelFrontmatter = (options = {}) => {
-    return {
-        helpers: {
-            frontmatter: params => {
-                const variableName = params.options.as || "frontmatter";
-                const format = params.options.format || "yaml";
-                // register the variable (overwrite if it already exists)
-                Object.assign(params.variables, {
-                    [variableName]: parseFrontmatterBlock(params.fn(params.data) || "", format, options.parser),
-                });
-                // don't render anything
-                return "";
-            },
+const mikelFrontmatter = (options = {}) => ({
+    helpers: {
+        frontmatter: params => {
+            const variableName = params.options.as || "frontmatter";
+            const format = params.options.format || "yaml";
+            // register the variable (overwrite if it already exists)
+            Object.assign(params.state, {
+                [variableName]: parseFrontmatterBlock(params.fn(params.data) || "", format, options.parser),
+            });
+            // don't render anything
+            return "";
         },
-    };
-};
+    },
+});
 
 // assign additional metadata to the plugin function
 mikelFrontmatter.yamlParser = parseYaml;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel-frontmatter",
     "description": "A mikel plugin to define new data inside templates using a frontmatter-like syntax.",
-    "version": "0.32.0",
+    "version": "0.33.1",
     "type": "module",
     "license": "MIT",
     "author": "Josemi Juanes",