💬 Preserve quotes in inline expressions upon request (#1812)

.changeset/shy-spoons-exist.md

@@ -0,0 +1,5 @@
+---
+"myst-cli": patch
+---
+
+Add support for `strip-quotes` metadata

packages/myst-cli/src/transforms/inlineExpression.spec.ts

@@ -3,8 +3,8 @@ import { transformRenderInlineExpressions } from './inlineExpressions';
 import { VFile } from 'vfile';
 import type { InlineExpression } from 'myst-spec-ext';
 
-describe('fileFromRelativePath', () => {
-  it('inline text is not quoted', async () => {
+describe('transformRenderInlineExpressions', () => {
+  it('inline text is not quoted by default', async () => {
     const vfile = new VFile();
     const expr = {
       type: 'inlineExpression',
@@ -23,4 +23,25 @@ describe('fileFromRelativePath', () => {
     // Children are added and quotes are removed
     expect(expr.children).toEqual([{ type: 'text', value: 'hello there' }]);
   });
+  it('inline text is quoted when requested', async () => {
+    const vfile = new VFile();
+    const expr = {
+      type: 'inlineExpression',
+      value: '"hello " + "there"',
+      result: {
+        status: 'ok',
+        data: {
+          // Note the wrapping quotes!
+          'text/plain': "'hello there'",
+        },
+        metadata: {
+          'strip-quotes': false,
+        },
+      },
+    } as InlineExpression;
+    const tree = { type: 'root', children: [expr] };
+    transformRenderInlineExpressions(tree, vfile);
+    // Children are added and quotes are preserved
+    expect(expr.children).toEqual([{ type: 'text', value: "'hello there'" }]);
+  });
 });

packages/myst-cli/src/transforms/inlineExpressions.ts

@@ -33,7 +33,7 @@ function processLatex(value: string) {
     .trim();
 }
 
-function processPlainText(content: string) {
+function stripTextQuotes(content: string) {
   return content.replace(/^(["'])(.*)\1$/, '$2');
 }
 
@@ -57,7 +57,14 @@ function renderExpression(node: InlineExpression, file: VFile): StaticPhrasingCo
       } else if (mimeType === 'text/html') {
         content = [{ type: 'html', value: value as string }];
       } else if (mimeType === 'text/plain') {
-        content = [{ type: 'text', value: processPlainText(value as string) }];
+        // Allow the user / libraries to explicitly indicate that quotes should be preserved
+        const stripQuotes = result.metadata?.['strip-quotes'] ?? true;
+        content = [
+          {
+            type: 'text',
+            value: stripQuotes ? stripTextQuotes(value as string) : (value as string),
+          },
+        ];
       }
     });
     if (content) return content;