ℹ Improve formatting of myst-to-md

Author: rowanc1

.changeset/cool-ducks-sing.md

@@ -0,0 +1,5 @@
+---
+"myst-parser": patch
+---
+
+Add body/options to the mystDirective and mystRole nodes

.changeset/tender-pianos-cheat.md

@@ -0,0 +1,5 @@
+---
+"myst-to-md": patch
+---
+
+Improve formatting of raw myst-directives

package-lock.json

@@ -11,7 +11,7 @@ describe('card directive', () => {
         {
           type: 'mystDirective',
           name: 'card',
-          args: 'Card Title',
+          args: [{ type: 'text', value: 'Card Title' }],
           value: 'Header\n^^^\n\nCard content\n+++\nFooter',
           position: {
             start: {
@@ -142,7 +142,7 @@ describe('card directive', () => {
     const output = mystParse(content, {
       directives: [cardDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
   it('card directive parses with options', async () => {
     const content =
@@ -153,11 +153,11 @@ describe('card directive', () => {
         {
           type: 'mystDirective',
           name: 'card',
-          args: 'Card Title',
+          args: [{ type: 'text', value: 'Card Title' }],
           options: {
-            header: 'Header',
-            footer: 'Footer',
-            link: 'my-url',
+            header: [{ type: 'text', value: 'Header' }],
+            footer: [{ type: 'text', value: 'Footer' }],
+            url: 'my-url',
           },
           value: 'Card\n^^^\ncontent',
           position: {
@@ -280,7 +280,7 @@ describe('card directive', () => {
     const output = mystParse(content, {
       directives: [cardDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
   it('card directive parses with minimal content', async () => {
     const content = '```{card}\nCard content\n```';
@@ -343,7 +343,7 @@ describe('card directive', () => {
     const output = mystParse(content, {
       directives: [cardDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
 });
 

packages/myst-ext-card/tests/card.spec.ts

@@ -22,7 +22,7 @@ describe('exercise directive', () => {
           options: {
             label: 'ex-1',
           },
-          args: 'Exercise Title',
+          args: [{ type: 'text', value: 'Exercise Title' }],
           value: 'Exercise content',
           children: [
             {
@@ -58,7 +58,7 @@ describe('exercise directive', () => {
     const output = mystParse(content, {
       directives: [exerciseDirective],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
   it('nonumber is prioritized over enumerated', async () => {
     const content =
@@ -74,7 +74,7 @@ describe('exercise directive', () => {
             enumerated: true,
             nonumber: true,
           },
-          args: 'Exercise Title',
+          args: [{ type: 'text', value: 'Exercise Title' }],
           value: 'Exercise content',
           children: [
             {
@@ -110,7 +110,7 @@ describe('exercise directive', () => {
     const output = mystParse(content, {
       directives: [exerciseDirective],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
   it('exercises are enumerated with labels by default', async () => {
     const content = '```{exercise} Exercise Title\nExercise content\n```';
@@ -125,7 +125,7 @@ describe('exercise directive', () => {
         {
           type: 'mystDirective',
           name: 'exercise',
-          args: 'Exercise Title',
+          args: [{ type: 'text', value: 'Exercise Title' }],
           value: 'Exercise content',
           children: [
             {
@@ -158,6 +158,6 @@ describe('exercise directive', () => {
         },
       ],
     };
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
 });

packages/myst-ext-exercise/tests/exercise.spec.ts

@@ -87,6 +87,6 @@ describe('grid directive', () => {
     const output = mystParse(content, {
       directives: [gridDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
 });

packages/myst-ext-grid/tests/grid.spec.ts

@@ -44,7 +44,7 @@ describe('icon role', () => {
       const output = mystParse(markup, {
         roles: [iconRole],
       });
-      expect(deletePositions(output)).toEqual(expected);
+      expect(deletePositions(output)).toMatchObject(expected);
     },
   );
   it.each(Object.entries(LEGACY_ICON_ALIASES))(
@@ -79,7 +79,7 @@ describe('icon role', () => {
       const output = mystParse(markup, {
         roles: [iconRole],
       });
-      expect(deletePositions(output)).toEqual(expected);
+      expect(deletePositions(output)).toMatchObject(expected);
     },
   );
 });

packages/myst-ext-icon/tests/icon.spec.ts

@@ -11,7 +11,7 @@ describe('proof directive', () => {
         {
           type: 'mystDirective',
           name: 'prf:proof',
-          args: 'Proof Title',
+          args: [{ type: 'text', value: 'Proof Title' }],
           value: 'Proof content',
           position: {
             start: {
@@ -86,6 +86,6 @@ describe('proof directive', () => {
     const output = mystParse(content, {
       directives: [proofDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
 });

packages/myst-ext-proof/tests/proof.spec.ts

@@ -41,7 +41,7 @@ describe('reactive tests', () => {
       roles: [reactiveRole],
       directives: [reactiveDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
   it('r:dynamic role parses', async () => {
     const content = '{r:dynamic}`rValue="visitors", rChange="{visitors: value}", value="5"`';
@@ -92,6 +92,6 @@ describe('reactive tests', () => {
       roles: [reactiveRole],
       directives: [reactiveDirective],
     });
-    expect(output).toEqual(expected);
+    expect(output).toMatchObject(expected);
   });
 });

packages/myst-ext-reactive/tests/reactive.spec.ts

@@ -31,7 +31,7 @@ describe('tab directives', () => {
     const output = mystParse(content, {
       directives: [...tabDirectives],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
   it('tabSet class option parses', async () => {
     const content = '```{tab-set}\n:class: my-class\n```';
@@ -57,7 +57,7 @@ describe('tab directives', () => {
     const output = mystParse(content, {
       directives: [...tabDirectives],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
   it.each(['tab-item', 'tabItem'])('%s with title parses', async (name: string) => {
     const content = `\`\`\`{${name}} Tab One\n\`\`\``;
@@ -81,7 +81,7 @@ describe('tab directives', () => {
     const output = mystParse(content, {
       directives: [...tabDirectives],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
   it('tabItem sync and selected options parse', async () => {
     const content = '```{tab-item} Tab One\n:sync: tab1\n:selected:\n```';
@@ -111,7 +111,7 @@ describe('tab directives', () => {
     const output = mystParse(content, {
       directives: [...tabDirectives],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
   // TODO: enable when we have a better required/fallback/default pattern
   it.skip('tabItem without title errors', async () => {
@@ -202,6 +202,6 @@ describe('tab directives', () => {
     const output = mystParse(content, {
       directives: [...tabDirectives],
     });
-    expect(deletePositions(output)).toEqual(expected);
+    expect(deletePositions(output)).toMatchObject(expected);
   });
 });