feat: support generator unwrap

README.md

@@ -20,21 +20,25 @@ Your automated markdown maintainer!
 
 ## Contribution
 
+<!-- automd:fetch url="gh:unjs/.github/main/snippets/readme-contrib-pnpm.md" -->
+
 <details>
   <summary>Local development</summary>
 
 - Clone this repository
 - Install the latest LTS version of [Node.js](https://nodejs.org/en/)
 - Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
 - Install dependencies using `pnpm install`
-- Run unit tests using `pnpm dev`
-- Run playground test using `pnpm play`
+- Run tests using `pnpm dev` or `pnpm test`
 
 </details>
 
+
+<!-- /automd -->
+
 ## License
 
-Made with 💛 Published under [MIT License](./LICENSE).
+Made with 💛 Published under the [MIT License](./LICENSE).
 
 <!-- automd:with-automd -->
 

src/_parse.ts

@@ -1,18 +1,20 @@
 import { destr } from "destr";
 
-const AUTOMD_RE =
-  /^(?<open><!--\s*automd:(?<generator>.+?)\s+(?<args>.*?)\s*-->)(?<contents>.+?)(?<close>^<!--\s*\/automd\s*-->)/gims;
-
 export interface Block {
   generator: string;
   rawArgs: string;
   contents: string;
   loc: { start: number; end: number };
+  _loc: { start: number; end: number };
 }
 
 export function findBlocks(md: string): Block[] {
   const blocks: Block[] = [];
 
+  // Regex is stateful, so we need to reset it
+  const AUTOMD_RE =
+    /^(?<open><!--\s*automd:(?<generator>.+?)\s+(?<args>.*?)\s*-->)(?<contents>.+?)(?<close>^<!--\s*\/automd\s*-->)/gims;
+
   for (const match of md.matchAll(AUTOMD_RE)) {
     if (match.index === undefined || !match.groups) {
       continue;
@@ -26,12 +28,17 @@ export function findBlocks(md: string): Block[] {
       rawArgs: match.groups.args,
       contents: match.groups.contents,
       loc: { start, end },
+      _loc: { start: match.index, end: match.index + match[0].length },
     });
   }
 
   return blocks;
 }
 
+export function containsAutomd(md: string) {
+  return /^<!--\s*automd:/gims.test(md);
+}
+
 export function parseRawArgs(rawArgs: string) {
   const args = Object.create(null);
 

src/generator.ts

@@ -11,6 +11,7 @@ export interface GenerateContext {
 export interface GenerateResult {
   contents: string;
   issues?: string[];
+  unwrap?: boolean;
 }
 
 export interface Generator {

src/transform.ts

@@ -1,7 +1,7 @@
 import MagicString from "magic-string";
 import builtinGenerators from "./generators";
 import { GenerateContext, GenerateResult } from "./generator";
-import { Block, findBlocks, parseRawArgs } from "./_parse";
+import { Block, containsAutomd, findBlocks, parseRawArgs } from "./_parse";
 import { Config, ResolvedConfig, resolveConfig } from "./config";
 
 export interface TransformResult {
@@ -32,12 +32,16 @@ export async function transform(
 
   for (const block of blocks) {
     const result = await _transformBlock(block, config, generators);
+    if (result.unwrap) {
+      editor.overwrite(block._loc.start, block._loc.end, `${result.contents}`);
+    } else {
+      editor.overwrite(
+        block.loc.start,
+        block.loc.end,
+        `\n\n${result.contents}\n\n`,
+      );
+    }
     updates.push({ block, result });
-    editor.overwrite(
-      block.loc.start,
-      block.loc.end,
-      `\n\n${result.contents}\n\n`,
-    );
   }
 
   const hasChanged = editor.hasChanged();
@@ -80,6 +84,22 @@ async function _transformBlock(
 
   try {
     const result = (await generator.generate(context)) as GenerateResult;
+
+    if (!result.unwrap && containsAutomd(result.contents)) {
+      result.unwrap = true;
+    }
+    if (result.unwrap) {
+      const nestedRes = await transform(result.contents, config);
+      result.contents = nestedRes.contents.trim();
+      // TODO: inherit time, issues, etc.
+      if (nestedRes.hasIssues) {
+        result.issues = [
+          ...(result.issues || []),
+          ...nestedRes.updates.flatMap((u) => u.result.issues || []),
+        ];
+      }
+    }
+
     return result;
   } catch (_error: any) {
     const error = `(${block.generator}) ${_error.message || _error}`;

test/transform.test.ts

@@ -3,10 +3,7 @@ import { transform } from "../src";
 
 describe("transform", () => {
   it("basic transform works", async () => {
-    const input = `
-<!-- automd:test foo=bar -->
-<!-- /automd -->
-    `.trim();
+    const input = `<!-- automd:test foo=bar -->\n\n<!-- /automd -->`;
 
     const result = await transform(input, {
       generators: {
@@ -31,15 +28,74 @@ describe("transform", () => {
     expect(result.updates).toHaveLength(1);
     expect(result.updates[0].block).toMatchInlineSnapshot(`
       {
+        "_loc": {
+          "end": 46,
+          "start": 0,
+        },
         "contents": "
+
       ",
         "generator": "test",
         "loc": {
-          "end": 29,
+          "end": 30,
           "start": 28,
         },
         "rawArgs": "foo=bar",
       }
     `);
   });
+
+  describe("unwrap", () => {
+    it("manual unwrap", async () => {
+      const input = `foo\n<!-- automd:test -->\n<!-- /automd -->\nbaz`;
+
+      const result = await transform(input, {
+        generators: {
+          test: {
+            name: "test",
+            generate() {
+              return {
+                contents: `bar`,
+                unwrap: true,
+              };
+            },
+          },
+        },
+      });
+
+      expect(result.contents).toMatchInlineSnapshot(`
+        "foo
+        bar
+        baz"
+      `);
+    });
+    it("auto unwrap", async () => {
+      const input = `a\n<!-- automd:test -->\n<!-- /automd -->\nd`;
+
+      const result = await transform(input, {
+        generators: {
+          test: {
+            name: "test",
+            generate() {
+              return {
+                contents: `b\n<!-- automd:with-automd lastUpdate=now -->\n<!-- /automd -->\nc`,
+              };
+            },
+          },
+        },
+      });
+
+      expect(result.contents).toMatchInlineSnapshot(`
+        "a
+        b
+        <!-- automd:with-automd lastUpdate=now -->
+
+        _🤖 docs are auto updated with [automd](https:/automd.unjs.io) (last updated: now)_
+
+        <!-- /automd -->
+        c
+        d"
+      `);
+    });
+  });
 });