Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix jsxDEV warning #435

Merged
merged 3 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/lovely-houses-rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"codehike": patch
---

Fix `jsxDEV` warning
2 changes: 2 additions & 0 deletions apps/web/content/blog/from-remark-to-rsc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ authors: [pomber]
draft: true
---

Content usually needs some kind of transformation before being rendered.

A remark plugin is a function that transforms pieces of a markdown file.
13 changes: 12 additions & 1 deletion apps/web/next.config.mjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
import createNextDocsMDX from "next-docs-mdx/config"
import { remarkCodeHike, recmaCodeHike } from "codehike/mdx"
// import fs from "node:fs"
// import { jsx, toJs } from "estree-util-to-js"
// function recmaPlugin() {
// return (tree) => {
// const result = toJs(tree, { handlers: jsx })
// // console.log("```js")
// // console.log(result.value)
// // console.log("```")
// fs.writeFileSync("recma.js", result.value)
// }
// }

/** @type {import('codehike/mdx').CodeHikeConfig} */
const chConfig = {
Expand All @@ -17,7 +28,7 @@ const withMDX = createNextDocsMDX({
mdxOptions: {
remarkPlugins: [[remarkCodeHike, chConfig]],
recmaPlugins: [[recmaCodeHike, chConfig]],
jsx: true,
// jsx: true,
},
})

Expand Down
1 change: 1 addition & 0 deletions apps/web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"codehike": "workspace:*",
"diff": "^5.1.0",
"dotenv": "^16.4.1",
"estree-util-to-js": "^2.0.0",
"lucide-react": "^0.303.0",
"next": "14.1.0",
"next-docs-mdx": "7.1.2",
Expand Down
16 changes: 13 additions & 3 deletions packages/codehike/src/mdx/3.transform-hike-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ function forEachHikeElementMoveChildrenToHikeProp(root: any, jsxOn: boolean) {
visit(root, (node: any) => {
if (isElementWithHikeAttribute(node, jsxOn)) {
if (jsxOn) {
moveChildrenToHikePropJSX(node, jsxOn)
moveChildrenToHikePropJSX(node)
} else {
moveChildrenToHikeProp(node)
}
Expand All @@ -157,7 +157,7 @@ function isElementWithHikeAttribute(node: any, jsxOn: boolean) {
)
}

function moveChildrenToHikePropJSX(node: any, jsxOn: boolean) {
function moveChildrenToHikePropJSX(node: any) {
// dictionary of children by path
const childrenByPath: any = {}
node.children.forEach((slot: any) => {
Expand Down Expand Up @@ -252,8 +252,8 @@ function moveChildrenToHikeProp(node: any) {
(p: any) => p.key.name !== "children",
)

// jsxs calls can only have arrays as children, so we turn any jsxs without array into jsx call
visit(node, function (node: any) {
// jsxs calls can only have arrays as children, so we turn any jsxs without array into jsx call
if (node.type === "CallExpression" && node.callee.name === "_jsxs") {
const childrenProp = node.arguments[1].properties.find(
(p: any) => p.key.value === "children",
Expand All @@ -262,6 +262,16 @@ function moveChildrenToHikeProp(node: any) {
node.callee.name = "_jsx"
}
}

// same, but in dev mode the name is _jsxDEV, and we should change the `isStaticChildren` argument
if (node.type === "CallExpression" && node.callee.name === "_jsxDEV") {
const childrenProp = node.arguments[1].properties.find(
(p: any) => p.key.value === "children",
)
if (childrenProp && childrenProp.value.type !== "ArrayExpression") {
node.arguments[3] = { type: "Literal", value: false }
}
}
})
}

Expand Down
4 changes: 4 additions & 0 deletions packages/codehike/tests/md-suite/basic.0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@ snapshots:
- before-recma-compiled-jsx
- before-recma-compiled-function
- before-recma-js
- before-recma-js-dev
- before-recma-jsx
- after-recma-js
- after-recma-js-dev
- after-recma-jsx
- compiled-js
- compiled-js-dev
- compiled-jsx
- compiled-function
- parsed-jsx
- rendered
- rendered-dev
---

# Lorem
Expand Down
Loading
Loading