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.

Sign up for GitHub

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(richtext-lexical): combine 2 normalizeMarkdown implementations and fix code block regex #10470

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(richtext-lexical): combine 2 normalizeMarkdown implementations and fix code block regex #10470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50fe946
fix normalize markdown
GermanJablo Jan 9, 2025
5358ec5
delete redundant file
GermanJablo Jan 9, 2025
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
6 changes: 4 additions & 2 deletions packages/richtext-lexical/src/features/blocks/client/markdownTransformer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ import { createHeadlessEditor } from '@lexical/headless'
import type { Transformer } from '../../../packages/@lexical/markdown/index.js'
import type { MultilineElementTransformer } from '../../../packages/@lexical/markdown/MarkdownTransformers.js'

import { $convertToMarkdownString } from '../../../packages/@lexical/markdown/index.js'
import {
$convertFromMarkdownString,
$convertToMarkdownString,
} from '../../../packages/@lexical/markdown/index.js'
import { extractPropsFromJSXPropsString } from '../../../utilities/jsx/extractPropsFromJSXPropsString.js'
import { propsToJSXString } from '../../../utilities/jsx/jsx.js'
import { $convertFromMarkdownString } from '../../../utilities/jsx/lexicalMarkdownCopy.js'
import { $createBlockNode, $isBlockNode, BlockNode } from './nodes/BlocksNode.js'

function createTagRegexes(tagName: string) {
Expand Down
2 changes: 1 addition & 1 deletion packages/richtext-lexical/src/features/blocks/server/markdownTransformer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ import type { NodeWithHooks } from '../../typesServer.js'

import { getEnabledNodesFromServerNodes } from '../../../lexical/nodes/index.js'
import {
$convertFromMarkdownString,
$convertToMarkdownString,
type MultilineElementTransformer,
type TextMatchTransformer,
type Transformer,
} from '../../../packages/@lexical/markdown/index.js'
import { extractPropsFromJSXPropsString } from '../../../utilities/jsx/extractPropsFromJSXPropsString.js'
import { propsToJSXString } from '../../../utilities/jsx/jsx.js'
import { $convertFromMarkdownString } from '../../../utilities/jsx/lexicalMarkdownCopy.js'
import { linesFromStartToContentAndPropsString } from './linesFromMatchToContentAndPropsString.js'
import { $createServerBlockNode, $isServerBlockNode, ServerBlockNode } from './nodes/BlocksNode.js'
import {
Expand Down
2 changes: 1 addition & 1 deletion packages/richtext-lexical/src/features/experimental_table/markdownTransformer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ import {
import { $isParagraphNode, $isTextNode } from 'lexical'

import {
$convertFromMarkdownString,
$convertToMarkdownString,
type ElementTransformer,
type Transformer,
} from '../../packages/@lexical/markdown/index.js'
import { $convertFromMarkdownString } from '../../utilities/jsx/lexicalMarkdownCopy.js'

// Very primitive table setup
const TABLE_ROW_REG_EXP = /^\|(.+)\|\s?$/
Expand Down
6 changes: 3 additions & 3 deletions packages/richtext-lexical/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1010,20 +1010,20 @@ export { sanitizeUrl, validateUrl } from './lexical/utils/url.js'

export type * from './nodeTypes.js'

export { defaultRichTextValue } from './populateGraphQL/defaultValue.js'
export { $convertFromMarkdownString } from './packages/@lexical/markdown/index.js'

export { defaultRichTextValue } from './populateGraphQL/defaultValue.js'
export { populate } from './populateGraphQL/populate.js'
export type { LexicalEditorProps, LexicalRichTextAdapter } from './types.js'

export { createServerFeature } from './utilities/createServerFeature.js'

export type { FieldsDrawerProps } from './utilities/fieldsDrawer/Drawer.js'

export { extractPropsFromJSXPropsString } from './utilities/jsx/extractPropsFromJSXPropsString.js'
export {
extractFrontmatter,
frontmatterToObject,
objectToFrontmatter,
propsToJSXString,
} from './utilities/jsx/jsx.js'
export { $convertFromMarkdownString } from './utilities/jsx/lexicalMarkdownCopy.js'
export { upgradeLexicalData } from './utilities/upgradeLexicalData/index.js'
25 changes: 16 additions & 9 deletions packages/richtext-lexical/src/packages/@lexical/markdown/MarkdownTransformers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,16 +185,19 @@ export type TextMatchTransformer = Readonly<{
type: 'text-match'
}>

const EMPTY_OR_WHITESPACE_ONLY = /^[\t ]*$/
const ORDERED_LIST_REGEX = /^(\s*)(\d+)\.\s/
const UNORDERED_LIST_REGEX = /^(\s*)[-*+]\s/
const CHECK_LIST_REGEX = /^(\s*)(?:-\s)?\s?(\[(\s|x)?\])\s/i
const HEADING_REGEX = /^(#{1,6})\s/
const QUOTE_REGEX = /^>\s/
const CODE_START_REGEX = /^[ \t]*```(\w+)?/
const CODE_END_REGEX = /[ \t]*```$/
// Match start of ``` or escaped \`\`\` code blocks
const CODE_START_OR_END_REGEX = /^[ \t]*(\\`\\`\\`|```)(\w+)?/
const CODE_SINGLE_LINE_REGEX = /^[ \t]*```[^`]+(?:(?:`{1,2}|`{4,})[^`]+)*```(?:[^`]|$)/
const TABLE_ROW_REG_EXP = /^\|(.+)\|\s?$/
const TABLE_ROW_DIVIDER_REG_EXP = /^(\| ?:?-*:? ?)+\|\s?$/
const TAG_START_REGEX = /^[ \t]*<[a-z_][\w-]*(?:\s[^<>]*)?\/?>/i
const TAG_END_REGEX = /^[ \t]*<\/[a-z_][\w-]*\s*>/i

const createBlockNode = (
createNode: (match: Array<string>) => ElementNode,
Expand Down Expand Up @@ -433,7 +436,7 @@ export const ITALIC_UNDERSCORE: TextFormatTransformer = {
tag: '_',
}

export function normalizeMarkdown(input: string, shouldMergeAdjacentLines = false): string {
export function normalizeMarkdown(input: string, shouldMergeAdjacentLines: boolean): string {
const lines = input.split('\n')
let inCodeBlock = false
const sanitizedLines: string[] = []
Expand All @@ -448,8 +451,8 @@ export function normalizeMarkdown(input: string, shouldMergeAdjacentLines = fals
continue
}

// Detect the start or end of a code block
if (CODE_START_REGEX.test(line) || CODE_END_REGEX.test(line)) {
// Toggle inCodeBlock state when encountering start or end of a code block
if (CODE_START_OR_END_REGEX.test(line)) {
inCodeBlock = !inCodeBlock
sanitizedLines.push(line)
continue
Expand All @@ -464,8 +467,8 @@ export function normalizeMarkdown(input: string, shouldMergeAdjacentLines = fals
// In markdown the concept of "empty paragraphs" does not exist.
// Blocks must be separated by an empty line. Non-empty adjacent lines must be merged.
if (
line === '' ||
lastLine === '' ||
EMPTY_OR_WHITESPACE_ONLY.test(line) ||
EMPTY_OR_WHITESPACE_ONLY.test(lastLine) ||
!lastLine ||
HEADING_REGEX.test(lastLine) ||
HEADING_REGEX.test(line) ||
Expand All @@ -475,11 +478,15 @@ export function normalizeMarkdown(input: string, shouldMergeAdjacentLines = fals
CHECK_LIST_REGEX.test(line) ||
TABLE_ROW_REG_EXP.test(line) ||
TABLE_ROW_DIVIDER_REG_EXP.test(line) ||
!shouldMergeAdjacentLines
!shouldMergeAdjacentLines ||
TAG_START_REGEX.test(line) ||
TAG_END_REGEX.test(line) ||
TAG_START_REGEX.test(lastLine) ||
TAG_END_REGEX.test(lastLine)
) {
sanitizedLines.push(line)
} else {
sanitizedLines[sanitizedLines.length - 1] = lastLine + line
sanitizedLines[sanitizedLines.length - 1] = lastLine + ' ' + line.trim()
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/richtext-lexical/src/packages/@lexical/markdown/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ function $convertFromMarkdownString(
transformers: Array<Transformer> = TRANSFORMERS,
node?: ElementNode,
shouldPreserveNewLines = false,
shouldMergeAdjacentLines = false,
shouldMergeAdjacentLines = true,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This classifies as a bug fix rather than a breaking change. It is standard behavior and what most people will expect.

): void {
const sanitizedMarkdown = shouldPreserveNewLines
? markdown
Expand Down
112 changes: 0 additions & 112 deletions packages/richtext-lexical/src/utilities/jsx/lexicalMarkdownCopy.ts
View file
Open in desktop

This file was deleted.

Loading