🐛 mdast lists need to be in paragraphs (#2241)

Author: rowanc1

.changeset/smart-feet-jump.md

@@ -0,0 +1,5 @@
+---
+"myst-parser": patch
+---
+
+Transform lists that have non-block content (text, italic, inlineCode, etc.) to ensure they are in paragraphs.

packages/myst-parser/package.json

@@ -31,7 +31,7 @@
     "clean": "rimraf dist",
     "test": "vitest run",
     "test:watch": "vitest watch",
-    "lint": "eslint \"src/**/*.ts\" -c .eslintrc.cjs",
+    "lint": "eslint \"src/**/!(*.spec).ts\" -c ./.eslintrc.cjs",
     "lint:format": "prettier --check src/*.ts src/**/*.ts",
     "build:bundle:browser": "esbuild bundle/myst.ts --bundle --outfile=dist/myst.min.js --platform=browser --minify",
     "build:esm": "tsc --project ./src/tsconfig.json",

packages/myst-parser/src/fromMarkdown.ts

@@ -24,6 +24,7 @@ const UNHIDDEN_TOKENS = new Set([
 export type MdastOptions = {
   handlers?: Record<string, TokenHandlerSpec>;
   hoistSingleImagesOutofParagraphs?: boolean;
+  listItemParagraphs?: boolean;
   nestBlocks?: boolean;
 };
 

packages/myst-parser/src/tokensToMyst.ts

@@ -8,6 +8,7 @@ import { selectAll } from 'unist-util-select';
 import { u } from 'unist-builder';
 import { MarkdownParseState, withoutTrailingNewline } from './fromMarkdown.js';
 import type { MdastOptions, TokenHandlerSpec } from './fromMarkdown.js';
+import { listItemParagraphsTransform } from './transforms/index.js';
 
 export function computeAmsmathTightness(
   src: string,
@@ -519,6 +520,7 @@ function nestSingleImagesIntoParagraphs(tree: GenericParent) {
 const defaultOptions: MdastOptions = {
   handlers: defaultMdast,
   hoistSingleImagesOutofParagraphs: true,
+  listItemParagraphs: true,
   nestBlocks: true,
 };
 
@@ -571,6 +573,11 @@ export function tokensToMyst(
     }
   });
 
+  if (opts.listItemParagraphs) {
+    // Ensure that listItems that are not paragraphs are wrapped in paragraphs
+    listItemParagraphsTransform(tree);
+  }
+
   // Move crossReference text value to children
   visit(tree, 'crossReference', (node: GenericNode) => {
     delete node.children;

packages/myst-parser/src/transforms/index.ts

@@ -0,0 +1 @@
+export { listItemParagraphsTransform } from './listItemParagraphs.js';