Merge pull request #1318 from maizzle/events-posthtml

maizzle · Jul 30, 2024 · b62c762 · b62c762
2 parents 657cba3 + 50eb0ff
commit b62c762
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 38 deletions.
diff --git a/src/generators/render.js b/src/generators/render.js
@@ -60,16 +60,13 @@ export async function render(html = '', config = {}) {
    * @param {string} options.html - The HTML to be transformed
    * @param {Object} options.matter - The front matter data
    * @param {Object} options.config - The current template config
-   * @param {function} options.posthtml - The PostHTML compiler
-   * @param {Object} options.transform - The transformers object
    * @returns {string} - The transformed HTML, or the original one if nothing was returned
    */
   if (typeof templateConfig.beforeRender === 'function') {
     content = await templateConfig.beforeRender(({
       html: content,
       matter: matterData,
       config: templateConfig,
-      posthtml: compilePostHTML,
     })) ?? content
   }
 
@@ -83,16 +80,13 @@ export async function render(html = '', config = {}) {
    * @param {string} options.html - The HTML to be transformed
    * @param {Object} options.matter - The front matter data
    * @param {Object} options.config - The current template config
-   * @param {function} options.posthtml - The PostHTML compiler
-   * @param {Object} options.transform - The transformers object
    * @returns {string} - The transformed HTML, or the original one if nothing was returned
    */
   if (typeof templateConfig.afterRender === 'function') {
     compiled.html = await templateConfig.afterRender(({
       html: compiled.html,
       matter: matterData,
       config: templateConfig,
-      posthtml: compilePostHTML,
     })) ?? compiled.html
   }
 
@@ -118,16 +112,13 @@ export async function render(html = '', config = {}) {
    * @param {string} options.html - The HTML to be transformed
    * @param {Object} options.matter - The front matter data
    * @param {Object} options.config - The current template config
-   * @param {function} options.posthtml - The PostHTML compiler
-   * @param {Object} options.transform - The transformers object
    * @returns {string} - The transformed HTML, or the original one if nothing was returned
    */
   if (typeof templateConfig.afterTransformers === 'function') {
     compiled.html = await templateConfig.afterTransformers(({
       html: compiled.html,
       matter: matterData,
       config: templateConfig,
-      posthtml: compilePostHTML,
     })) ?? compiled.html
   }
 

diff --git a/test/render.test.js b/test/render.test.js
@@ -28,11 +28,11 @@ describe.concurrent('Render', () => {
 
   test('Runs the `beforeRender` event', async () => {
     const { html } = await render('<div class="inline">{{ page.foo }}</div>', {
-      beforeRender({ config, posthtml }) {
+      beforeRender({ config, matter }) {
         config.foo = 'bar'
 
         expect(config).toBeInstanceOf(Object)
-        expect(posthtml).toBeInstanceOf(Function)
+        expect(matter).toBeInstanceOf(Object)
       }
     })
 
@@ -41,13 +41,13 @@ describe.concurrent('Render', () => {
 
   test('Runs the `afterRender` event', async () => {
     const { html } = await render('<div class="inline">foo</div>', {
-      afterRender({ config, posthtml }) {
+      afterRender({ config, matter }) {
         config.replaceStrings = {
           foo: 'bar'
         }
 
         expect(config).toBeInstanceOf(Object)
-        expect(posthtml).toBeInstanceOf(Function)
+        expect(matter).toBeInstanceOf(Object)
       }
     })
 
@@ -59,9 +59,9 @@ describe.concurrent('Render', () => {
       replaceStrings: {
         foo: 'bar'
       },
-      afterTransformers({ html, config, posthtml }) {
+      afterTransformers({ html, matter, config }) {
         expect(config).toBeInstanceOf(Object)
-        expect(posthtml).toBeInstanceOf(Function)
+        expect(matter).toBeInstanceOf(Object)
 
         return html.replace('bar', 'baz')
       }

diff --git a/types/events.d.ts b/types/events.d.ts
@@ -1,7 +1,5 @@
 import type Config from "./config";
 
-type PostHTMLType = (html: string, config: Config) => { html: string; config: Config };
-
 export default interface Events {
   /**
   * Runs after the Environment config has been computed, but before Templates are processed.
@@ -57,13 +55,6 @@ export default interface Events {
      * This is the Environment config merged with the Template's Front Matter.
      */
     config: Config;
-    /**
-     * A function to process an HTML string with PostHTML.
-     *
-     * @param {string} html The HTML string to process.
-     * @param {Config} config The Maizzle config object.
-     */
-    posthtml: PostHTMLType;
   }) => string | Promise<string>;
 
   /**
@@ -98,13 +89,6 @@ export default interface Events {
      * This is the Environment config merged with the Template's Front Matter.
      */
     config: Config;
-    /**
-    * A function to process an HTML string with PostHTML.
-    *
-    * @param {string} html The HTML string to process.
-    * @param {Config} config The Maizzle config object.
-    */
-    posthtml: PostHTMLType;
   }) => string | Promise<string>;
 
   /**
@@ -139,13 +123,6 @@ export default interface Events {
      * This is the Environment config merged with the Template's Front Matter.
      */
     config: Config;
-    /**
-    * A function to process an HTML string with PostHTML.
-    *
-    * @param {string} html The HTML string to process.
-    * @param {Config} config The Maizzle config object.
-    */
-    posthtml: PostHTMLType;
   }) => string | Promise<string>;
 
   /**