🔧 Tests/docs on jats-to-myst transforms

packages/jats-to-myst/src/transforms/admonitions.spec.ts

@@ -0,0 +1,104 @@
+import { VFile } from 'vfile';
+import { describe, expect, test } from 'vitest';
+import { admonitionTransform } from './admonitions';
+
+describe('admonitionTransform', () => {
+  test('caption title is moved to admonition title', () => {
+    const vfile = new VFile();
+    const tree = {
+      type: 'root',
+      children: [
+        {
+          type: 'boxed-text',
+          children: [
+            {
+              type: 'caption',
+              children: [
+                {
+                  type: 'title',
+                  children: [
+                    {
+                      type: 'text',
+                      value: 'My Title',
+                    },
+                  ],
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    const result = {
+      type: 'root',
+      children: [
+        {
+          type: 'boxed-text',
+          children: [
+            {
+              type: 'admonitionTitle',
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Title',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    admonitionTransform(tree, vfile);
+    expect(tree).toEqual(result);
+  });
+  test('caption with no title is lost', () => {
+    const vfile = new VFile();
+    const tree = {
+      type: 'root',
+      children: [
+        {
+          type: 'boxed-text',
+          children: [
+            {
+              type: 'caption',
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Title',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    const result = {
+      type: 'root',
+      children: [
+        {
+          type: 'boxed-text',
+          children: [
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    admonitionTransform(tree, vfile);
+    expect(tree).toEqual(result);
+  });
+});

packages/jats-to-myst/src/transforms/admonitions.ts

@@ -9,6 +9,13 @@ import type { VFile } from 'vfile';
 
 export type Section = Omit<Heading, 'type'> & { type: 'section' };
 
+/**
+ * Convert boxed-text caption to admonitionTitle (with content from caption > title)
+ *
+ * If boxed-text caption does not have a title, warn.
+ *
+ * After converting, delete any remaining boxed-text captions.
+ */
 export function admonitionTransform(tree: GenericParent, file: VFile) {
   const captions = selectAll(`${Tags.boxedText} > ${Tags.caption}`, tree) as GenericParent[];
   captions.forEach((caption) => {

packages/jats-to-myst/src/transforms/sections.spec.ts

@@ -0,0 +1,188 @@
+import { describe, expect, test } from 'vitest';
+import { sectionTransform } from './sections';
+
+describe('sectionTransform', () => {
+  test('section title becomes heading with depth', () => {
+    const tree = {
+      type: 'root',
+      children: [
+        {
+          type: 'sec',
+          children: [
+            {
+              type: 'title',
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Title',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    const result = {
+      type: 'root',
+      children: [
+        {
+          type: 'block',
+          children: [
+            {
+              type: 'heading',
+              depth: 1,
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Title',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    sectionTransform(tree);
+    expect(tree).toEqual(result);
+  });
+  test('section without title remains', () => {
+    const tree = {
+      type: 'root',
+      children: [
+        {
+          type: 'sec',
+          children: [
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    const result = {
+      type: 'root',
+      children: [
+        {
+          type: 'block',
+          children: [
+            {
+              type: 'text',
+              value: 'My content',
+            },
+          ],
+        },
+      ],
+    };
+    sectionTransform(tree);
+    expect(tree).toEqual(result);
+  });
+  test('nested sections flatten', () => {
+    const tree = {
+      type: 'root',
+      children: [
+        {
+          type: 'sec',
+          children: [
+            {
+              type: 'title',
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Title',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+            {
+              type: 'sec',
+              children: [
+                {
+                  type: 'title',
+                  children: [
+                    {
+                      type: 'text',
+                      value: 'My Subitle',
+                    },
+                  ],
+                },
+                {
+                  type: 'sec',
+                  children: [
+                    {
+                      type: 'title',
+                      children: [
+                        {
+                          type: 'text',
+                          value: 'Another title',
+                        },
+                      ],
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    };
+    const result = {
+      type: 'root',
+      children: [
+        {
+          type: 'block',
+          children: [
+            {
+              type: 'heading',
+              depth: 1,
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Title',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: 'My content',
+            },
+
+            {
+              type: 'heading',
+              depth: 2,
+              children: [
+                {
+                  type: 'text',
+                  value: 'My Subitle',
+                },
+              ],
+            },
+            {
+              type: 'heading',
+              depth: 3,
+              children: [
+                {
+                  type: 'text',
+                  value: 'Another title',
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    };
+    sectionTransform(tree);
+    expect(tree).toEqual(result);
+  });
+});

packages/jats-to-myst/src/transforms/sections.ts

@@ -19,6 +19,14 @@ function recurseSections(tree: GenericNode, depth = 1): void {
   });
 }
 
+/**
+ * Clean up nested sections
+ *
+ * - Identify sections with titles
+ * - Convert those titles to headings
+ * - Give headings depth value based on nesting
+ * - Flatten the sections
+ */
 export function sectionTransform(tree: GenericParent) {
   recurseSections(tree);
   const topSections = tree.children?.filter((n) => n.type === 'sec');