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(mdx): correctly recognize inline JSX #5783

Merged
merged 8 commits into from Jan 22, 2019
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGELOG.unreleased.md
Expand Up @@ -102,7 +102,27 @@ Examples:
}
```

- MDX: Correctly recognize inline JSX ([#5783] by [@ikatyang])

Previously, some inline JSXs are wrongly recognized as block HTML/JSX,
which causes unexpected behaviors. This issue is now fixed.

<!-- prettier-ignore -->
```md
<!-- Input -->
_foo <InlineJSX /> bar_

<!-- Output (Prettier stable) -->
_foo

<InlineJSX /> bar_

<!-- Output (Prettier master) -->
_foo <InlineJSX /> bar_
```

[@ikatyang]: https://github.com/ikatyang
[@simenb]: https://github.com/SimenB
[#5778]: https://github.com/prettier/prettier/pull/5778
[#5783]: https://github.com/prettier/prettier/pull/5783
[#5785]: https://github.com/prettier/prettier/pull/5785
7 changes: 2 additions & 5 deletions src/language-markdown/parser-markdown.js
Expand Up @@ -4,7 +4,7 @@ const remarkParse = require("remark-parse");
const unified = require("unified");
const pragma = require("./pragma");
const parseFrontMatter = require("../utils/front-matter");
const { mapAst } = require("./utils");
const { mapAst, INLINE_NODE_WRAPPER_TYPES } = require("./utils");
const mdx = require("./mdx");
const remarkMath = require("remark-math");

Expand Down Expand Up @@ -54,10 +54,7 @@ function htmlToJsx() {
if (
node.type !== "html" ||
/^<!--[\s\S]*-->$/.test(node.value) ||
// inline html
(parent.type === "paragraph" ||
parent.type === "tableCell" ||
parent.type === "heading")
INLINE_NODE_WRAPPER_TYPES.indexOf(parent.type) !== -1
) {
return node;
}
Expand Down
31 changes: 3 additions & 28 deletions src/language-markdown/printer-markdown.js
Expand Up @@ -25,41 +25,16 @@ const {
getFencedCodeBlockValue,
getOrderedListItemInfo,
splitText,
punctuationPattern
punctuationPattern,
INLINE_NODE_TYPES,
INLINE_NODE_WRAPPER_TYPES
} = require("./utils");
const { replaceEndOfLineWith } = require("../common/util");

const TRAILING_HARDLINE_NODES = ["importExport"];

const SINGLE_LINE_NODE_TYPES = ["heading", "tableCell", "link"];

const SIBLING_NODE_TYPES = ["listItem", "definition", "footnoteDefinition"];

const INLINE_NODE_TYPES = [
"liquidNode",
"inlineCode",
"emphasis",
"strong",
"delete",
"link",
"linkReference",
"image",
"imageReference",
"footnote",
"footnoteReference",
"sentence",
"whitespace",
"word",
"break",
"inlineMath"
];

const INLINE_NODE_WRAPPER_TYPES = INLINE_NODE_TYPES.concat([
"tableCell",
"paragraph",
"heading"
]);

function genericPrint(path, options, print) {
const node = path.getValue();

Expand Down
29 changes: 28 additions & 1 deletion src/language-markdown/utils.js
Expand Up @@ -7,6 +7,31 @@ const {
} = require("./constants.evaluate");
const { getLast } = require("../common/util");

const INLINE_NODE_TYPES = [
"liquidNode",
"inlineCode",
"emphasis",
"strong",
"delete",
"link",
"linkReference",
"image",
"imageReference",
"footnote",
"footnoteReference",
"sentence",
"whitespace",
"word",
"break",
"inlineMath"
];

const INLINE_NODE_WRAPPER_TYPES = INLINE_NODE_TYPES.concat([
"tableCell",
"paragraph",
"heading"
]);

const kRegex = new RegExp(kPattern);
const punctuationRegex = new RegExp(punctuationPattern);

Expand Down Expand Up @@ -193,5 +218,7 @@ module.exports = {
splitText,
punctuationPattern,
getFencedCodeBlockValue,
getOrderedListItemInfo
getOrderedListItemInfo,
INLINE_NODE_TYPES,
INLINE_NODE_WRAPPER_TYPES
};
57 changes: 57 additions & 0 deletions tests/mdx/__snapshots__/jsfmt.spec.js.snap
Expand Up @@ -173,6 +173,63 @@ export const b = 1
================================================================================
`;

exports[`inline-html.mdx 1`] = `
====================================options=====================================
parsers: ["mdx"]
printWidth: 80
| printWidth
=====================================input======================================
This is an example of a component _being used in some italic markdown with some <Bolded />,
and as you can see_ once you close the italics, it will break incorrectly when prettier formats it.

| Column 1 | Column 2 |
| -- | -- |
| **\`Row 1 Code\`** | Some text. |
| **<code>Row 2 Code</code>** | Some text. |
| **<InlineCode>Row 2 Code</InlineCode>** | Some text. |

=====================================output=====================================
This is an example of a component _being used in some italic markdown with some <Bolded />,
and as you can see_ once you close the italics, it will break incorrectly when prettier formats it.

| Column 1 | Column 2 |
| --------------------------------------- | ---------- |
| **\`Row 1 Code\`** | Some text. |
| **<code>Row 2 Code</code>** | Some text. |
| **<InlineCode>Row 2 Code</InlineCode>** | Some text. |

================================================================================
`;

exports[`inline-html.mdx 2`] = `
====================================options=====================================
parsers: ["mdx"]
printWidth: 80
semi: false
| printWidth
=====================================input======================================
This is an example of a component _being used in some italic markdown with some <Bolded />,
and as you can see_ once you close the italics, it will break incorrectly when prettier formats it.

| Column 1 | Column 2 |
| -- | -- |
| **\`Row 1 Code\`** | Some text. |
| **<code>Row 2 Code</code>** | Some text. |
| **<InlineCode>Row 2 Code</InlineCode>** | Some text. |

=====================================output=====================================
This is an example of a component _being used in some italic markdown with some <Bolded />,
and as you can see_ once you close the italics, it will break incorrectly when prettier formats it.

| Column 1 | Column 2 |
| --------------------------------------- | ---------- |
| **\`Row 1 Code\`** | Some text. |
| **<code>Row 2 Code</code>** | Some text. |
| **<InlineCode>Row 2 Code</InlineCode>** | Some text. |

================================================================================
`;

exports[`jsx.mdx 1`] = `
====================================options=====================================
parsers: ["mdx"]
Expand Down
8 changes: 8 additions & 0 deletions tests/mdx/inline-html.mdx
@@ -0,0 +1,8 @@
This is an example of a component _being used in some italic markdown with some <Bolded />,
and as you can see_ once you close the italics, it will break incorrectly when prettier formats it.

| Column 1 | Column 2 |
| -- | -- |
| **`Row 1 Code`** | Some text. |
| **<code>Row 2 Code</code>** | Some text. |
| **<InlineCode>Row 2 Code</InlineCode>** | Some text. |