🧮 Trim all math to ensure no new lines in latex output (#1728)

Fixes #1704
jupyter-book · Jan 6, 2025 · 3b05051 · 3b05051
1 parent 7afc691
commit 3b05051
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 4 deletions.
diff --git a/.changeset/tricky-moles-enjoy.md b/.changeset/tricky-moles-enjoy.md
@@ -0,0 +1,5 @@
+---
+"myst-parser": patch
+---
+
+Explicitly trim math strings
diff --git a/packages/myst-parser/src/tokensToMyst.ts b/packages/myst-parser/src/tokensToMyst.ts
@@ -280,20 +280,22 @@ const defaultMdast: Record<string, TokenHandlerSpec> = {
   math_inline_double: {
     type: 'math',
     noCloseToken: true,
-    isText: true,
+    isLeaf: true,
     getAttrs(t) {
       return {
+        value: t.content.trim(),
         enumerated: t.meta?.enumerated,
       };
     },
   },
   math_block: {
     type: 'math',
     noCloseToken: true,
-    isText: true,
+    isLeaf: true,
     getAttrs(t) {
       const name = t.info || undefined;
       return {
+        value: t.content.trim(),
         ...normalizeLabel(name),
         enumerated: t.meta?.enumerated,
       };
@@ -302,10 +304,11 @@ const defaultMdast: Record<string, TokenHandlerSpec> = {
   math_block_label: {
     type: 'math',
     noCloseToken: true,
-    isText: true,
+    isLeaf: true,
     getAttrs(t) {
       const name = t.info || undefined;
       return {
+        value: t.content.trim(),
         ...normalizeLabel(name),
         enumerated: t.meta?.enumerated,
       };
@@ -314,10 +317,11 @@ const defaultMdast: Record<string, TokenHandlerSpec> = {
   amsmath: {
     type: 'math',
     noCloseToken: true,
-    isText: true,
+    isLeaf: true,
     getAttrs(t, tokens, index, state) {
       const tight = computeAmsmathTightness(state.src, t.map);
       const attrs = {
+        value: t.content.trim(),
         enumerated: t.meta?.enumerated,
       } as Record<string, any>;
       if (tight) attrs.tight = tight;

diff --git a/packages/myst-parser/tests/math.spec.ts b/packages/myst-parser/tests/math.spec.ts
@@ -8,6 +8,7 @@ import type { Math } from 'myst-spec-ext';
 describe('Test math tightness', () => {
   test.each([
     [true, 'p\n$$Ax=b$$\np'],
+    [true, 'p\n$$\nAx=b\n$$\np'],
     [undefined, 'p\n\n$$Ax=b$$\n\np'],
     ['before', 'p\n$$Ax=b$$\n\np'],
     // ['after', 'p\n\n$$Ax=b$$\np'], // TODO: this is (maybe) a bug in the dollar-math parser
@@ -18,6 +19,7 @@ describe('Test math tightness', () => {
     expect((select('math', tree) as Math).tight).toBe(undefined);
     mathNestingTransform(tree, file);
     expect((select('math', tree) as Math).tight).toBe(tight);
+    expect((select('math', tree) as Math).value).toBe('Ax=b');
   });
   test.each([
     [true, 'p\n:::{math}\nAx=b\n:::\np'],

diff --git a/packages/mystmd/tests/basic-tex-math/input.md b/packages/mystmd/tests/basic-tex-math/input.md
@@ -4,6 +4,12 @@ Paragraph
 $$Ax=b$$
 Paragraph
 
+Paragraph around dollar math
+$$
+Ax=b
+$$
+Paragraph
+
 Paragraph
 \begin{equation}
 Ax=b

diff --git a/packages/mystmd/tests/outputs/basic-tex-math.tex b/packages/mystmd/tests/outputs/basic-tex-math.tex
@@ -4,6 +4,12 @@
 \end{equation}
 Paragraph
 
+Paragraph around dollar math
+\begin{equation}
+Ax=b
+\end{equation}
+Paragraph
+
 Paragraph
 \begin{equation}
 Ax=b