mdx: add tableCellAlignToStyle option, to use align

wooorm · wooorm · commit 3a7f1947d1f5 · 2023-10-19T15:17:07.000+02:00
The default behavior remains fine: a CSS `textalign` prop is added
on `td`, `th`, instead of an `align` (which is the default for GFM).
That’s what React wants: otherwise it warns.

But if you use some other framework, there’s now a toggle for it.
diff --git a/packages/mdx/lib/core.js b/packages/mdx/lib/core.js
@@ -76,7 +76,9 @@ const removedOptions = [
  */
 export function createProcessor(options) {
   const {
+    SourceMapGenerator,
     development,
+    elementAttributeNameCase,
     jsx,
     format,
     outputFormat,
@@ -85,9 +87,8 @@ export function createProcessor(options) {
     rehypePlugins,
     remarkPlugins,
     remarkRehypeOptions,
-    elementAttributeNameCase,
     stylePropertyNameCase,
-    SourceMapGenerator,
+    tableCellAlignToStyle,
     ...rest
   } = options || {}
   let index = -1
@@ -136,7 +137,11 @@ export function createProcessor(options) {
   }
 
   pipeline
-    .use(rehypeRecma, {elementAttributeNameCase, stylePropertyNameCase})
+    .use(rehypeRecma, {
+      elementAttributeNameCase,
+      stylePropertyNameCase,
+      tableCellAlignToStyle
+    })
     .use(recmaDocument, {...rest, outputFormat})
     .use(recmaJsxRewrite, {
       development,
diff --git a/packages/mdx/lib/plugin/rehype-recma.js b/packages/mdx/lib/plugin/rehype-recma.js
@@ -22,6 +22,9 @@
  *
  *   This casing is used for hast elements, not for embedded MDX JSX nodes
  *   (components that someone authored manually).
+ * @property {boolean | null | undefined} [tableCellAlignToStyle=true]
+ *   Turn obsolete `align` props on `td` and `th` into CSS `style` props
+ *   (default: `true`).
  *
  * @typedef {'css' | 'dom'} StylePropertyNameCase
  *   Casing to use for property names in `style` objects.
diff --git a/packages/mdx/readme.md b/packages/mdx/readme.md
@@ -751,6 +751,11 @@ default: `'dom'`).
 This casing is used for hast elements, not for embedded MDX JSX nodes
 (components that someone authored manually).
 
+###### `options.tableCellAlignToStyle`
+
+Turn obsolete `align` props on `td` and `th` into CSS `style` props (default:
+`true`).
+
 ###### Returns
 
 `Promise<VFile>` — Promise that resolves to the compiled JS as a [vfile][].
diff --git a/packages/mdx/test/compile.js b/packages/mdx/test/compile.js
@@ -15,6 +15,7 @@ import {MDXProvider} from '@mdx-js/react'
 import React from 'react'
 import {renderToStaticMarkup} from 'react-dom/server'
 import rehypeRaw from 'rehype-raw'
+import remarkGfm from 'remark-gfm'
 import {SourceMapGenerator} from 'source-map'
 import {VFile} from 'vfile'
 import {run} from './context/run.js'
@@ -1302,6 +1303,30 @@ test('@mdx-js/mdx: compile (JSX)', async function (t) {
       }
     }
   )
+
+  await t.test('should support `tableCellAlignToStyle`', async function () {
+    assert.match(
+      String(
+        await compile('| a |\n| :- |', {
+          remarkPlugins: [remarkGfm],
+          tableCellAlignToStyle: true,
+          jsx: true
+        })
+      ),
+      /textAlign: "left"/
+    )
+
+    assert.match(
+      String(
+        await compile('| a |\n| :- |', {
+          remarkPlugins: [remarkGfm],
+          tableCellAlignToStyle: false,
+          jsx: true
+        })
+      ),
+      /align="left"/
+    )
+  })
 })
 
 test('@mdx-js/mdx: createProcessor', async function (t) {

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`	`*`
`23`	`23`	`* This casing is used for hast elements, not for embedded MDX JSX nodes`
`24`	`24`	`* (components that someone authored manually).`
	`25`	`+ * @property {boolean \| null \| undefined} [tableCellAlignToStyle=true]`
	`26`	+ * Turn obsolete `align` props on `td` and `th` into CSS `style` props
	`27`	+ * (default: `true`).
`25`	`28`	`*`
`26`	`29`	`* @typedef {'css' \| 'dom'} StylePropertyNameCase`
`27`	`30`	* Casing to use for property names in `style` objects.