Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

fix(editor): keep typed start numbers on ordered lists (#9253)

Wolf Mermelsteinb242ccda101b
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.test.tsx b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.test.tsx
index 5c8730564a..87286357c8 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.test.tsx
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.test.tsx
@@ -311,3 +311,17 @@ describe('static markdown citations', () => {
rendered.unmount();
});
});
+
+describe('static markdown ordered lists', () => {
+ it('keeps a non-1 start on the rendered list', () => {
+ const rendered = render(() => (
+ <StaticMarkdownContext>
+ <StaticMarkdown markdown="6. Reply to item six" lazy={false} />
+ </StaticMarkdownContext>
+ ));
+ const list = rendered.container.querySelector('ol');
+ expect(list?.getAttribute('start')).toBe('6');
+ expect(list?.style.counterReset).toBe('static-md-counter-1 5');
+ rendered.unmount();
+ });
+});
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.tsx b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.tsx
index 34aa729796..cb6c35a51a 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.tsx
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/StaticMarkdown.tsx
@@ -735,6 +735,7 @@ const List: TypedRenderableElement<ListNode> = {
classList={{
['depth-' + depth]: true,
}}
+ start={start !== 1 ? start : undefined}
style={{ 'counter-reset': `static-md-counter-${depth} ${start - 1}` }}
>
{props.children}
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/README.md b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/README.md
index b5e1032062..43db14f851 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/README.md
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/README.md
@@ -33,6 +33,13 @@ the local fixture are intercepted. Run just this case by adding
Screenshots: [desktop](proof/autolinks-desktop.png) and
[phone](proof/autolinks-mobile.png).
+## Ordered list start
+
+`lists.browser.e2e.ts` types `6.` then Enter in the production channel
+composer. The list must start at 6 in the draft and after save.
+
+Screenshot: [desktop](proof/ordered-list-start.png).
+
## Message quotes
`quotes.browser.e2e.ts` selects three paragraphs backward and applies Quote
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/lists.browser.e2e.ts b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/lists.browser.e2e.ts
new file mode 100644
index 0000000000..41bf0e367d
--- /dev/null
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/lists.browser.e2e.ts
@@ -0,0 +1,49 @@
+import { expect, test } from '@playwright/test';
+
+async function openEmptyComposer(page: import('@playwright/test').Page) {
+ await page.context().route('**/*', async (route) => {
+ const url = new URL(route.request().url());
+ if (
+ url.hostname === 'localhost' &&
+ !url.pathname.includes('/__macro_dev/')
+ ) {
+ await route.continue();
+ } else {
+ await route.fulfill({ status: 401, body: '{}' });
+ }
+ });
+ await page.routeWebSocket('**/*', (socket) => socket.close());
+ await page.goto(
+ '/src/lib/core/component/LexicalMarkdown/component/core/browser-test/quotes.html?initial='
+ );
+ const editor = page.getByRole('textbox', { name: 'Message' });
+ await expect(editor).toBeVisible({ timeout: 60_000 });
+ return editor;
+}
+
+test('typing 6. then Enter starts an ordered list at 6', async ({
+ page,
+}, testInfo) => {
+ const errors: string[] = [];
+ page.on('pageerror', (error) => errors.push(error.message));
+ const editor = await openEmptyComposer(page);
+ await editor.click();
+ await page.keyboard.type('6.');
+ await page.keyboard.press('Enter');
+
+ const list = editor.locator('ol');
+ await expect(list).toHaveCount(1);
+ await expect(list).toHaveAttribute('start', '6');
+ await page.keyboard.type('Reply to item six');
+ await expect(list.locator('li').first()).toHaveText('Reply to item six');
+
+ await page.getByRole('button', { name: 'Save message' }).click();
+ const saved = page.getByTestId('saved').locator('ol');
+ await expect(saved).toHaveAttribute('start', '6');
+ await expect(saved).toHaveText('Reply to item six');
+ expect(errors).toEqual([]);
+ await page.screenshot({
+ path: testInfo.outputPath('ordered-list-start.png'),
+ fullPage: true,
+ });
+});
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/proof/ordered-list-start.png b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/proof/ordered-list-start.png
new file mode 100644
index 0000000000..a98a966697
Binary files /dev/null and b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/browser-test/proof/ordered-list-start.png differ
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/plugins/markdown-shortcuts/markdownShortcutsPlugin.test.ts b/apps/web/src/lib/core/component/LexicalMarkdown/plugins/markdown-shortcuts/markdownShortcutsPlugin.test.ts
new file mode 100644
index 0000000000..84173d99b0
--- /dev/null
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/plugins/markdown-shortcuts/markdownShortcutsPlugin.test.ts
@@ -0,0 +1,73 @@
+import { $isListNode, ListItemNode } from '@lexical/list';
+import { CODE } from '@lexical/markdown';
+import { registerRichText } from '@lexical/rich-text';
+import {
+ NodeReplacements,
+ ORDERED_LIST_ENTER,
+ SupportedNodeTypes,
+} from '@macro-inc/lexical-core';
+import { HR } from '@macro-inc/lexical-core/transformers/transformers';
+import {
+ $createParagraphNode,
+ $createTextNode,
+ $getRoot,
+ createEditor,
+ KEY_ENTER_COMMAND,
+ type LexicalEditor,
+} from 'lexical';
+import { describe, expect, it } from 'vitest';
+import { markdownShortcutsPlugin } from './markdownShortcutsPlugin';
+
+function createTestEditor(): LexicalEditor {
+ const editor = createEditor({
+ namespace: 'markdown-shortcuts-ordered-list-test',
+ nodes: [...SupportedNodeTypes, ...NodeReplacements],
+ onError: (error) => {
+ throw error;
+ },
+ });
+
+ const root = document.createElement('div');
+ root.contentEditable = 'true';
+ document.body.appendChild(root);
+ editor.setRootElement(root);
+ registerRichText(editor);
+ markdownShortcutsPlugin({
+ transformers: [ORDERED_LIST_ENTER],
+ triggerOnEnterTransformers: [HR, CODE, ORDERED_LIST_ENTER],
+ })(editor);
+
+ return editor;
+}
+
+describe('markdownShortcutsPlugin ordered lists', () => {
+ it('starts a numbered list at the typed marker on Enter', () => {
+ const editor = createTestEditor();
+
+ editor.update(
+ () => {
+ const text = $createTextNode('6.');
+ $getRoot().clear().append($createParagraphNode().append(text));
+ text.select(2, 2);
+ },
+ { discrete: true }
+ );
+
+ editor.dispatchCommand(
+ KEY_ENTER_COMMAND,
+ new KeyboardEvent('keydown', { key: 'Enter' })
+ );
+
+ editor.read(() => {
+ const [list] = $getRoot().getChildren();
+ expect($isListNode(list)).toBe(true);
+ if (!$isListNode(list)) {
+ throw new Error('Expected Enter on 6. to create an ordered list');
+ }
+ expect(list.getListType()).toBe('number');
+ expect(list.getStart()).toBe(6);
+ expect(list.getChildrenSize()).toBe(1);
+ expect(list.getFirstChild()?.getType()).toBe(ListItemNode.getType());
+ });
+ });
+});
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/plugins/pluginManager.ts b/apps/web/src/lib/core/component/LexicalMarkdown/plugins/pluginManager.ts
index 1b607aea8b..05639b48fa 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/plugins/pluginManager.ts
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/plugins/pluginManager.ts
@@ -4,7 +4,11 @@ import { CODE } from '@lexical/markdown';
import { registerPlainText } from '@lexical/plain-text';
import { registerRichText } from '@lexical/rich-text';
import type { LoroManager } from '@macro-inc/collaboration/collab/manager';
-import { ALL_TRANSFORMERS, type EditorType } from '@macro-inc/lexical-core';
+import {
+ ALL_TRANSFORMERS,
+ type EditorType,
+ ORDERED_LIST_ENTER,
+} from '@macro-inc/lexical-core';
import { HR } from '@macro-inc/lexical-core/transformers/transformers';
import type { EditorState, LexicalEditor, UpdateListener } from 'lexical';
import {
@@ -79,7 +83,7 @@ export function createPluginManager(editor: LexicalEditor, type: EditorType) {
cleanupFunctions.push(
markdownShortcutsPlugin({
transformers,
- triggerOnEnterTransformers: [HR, CODE],
+ triggerOnEnterTransformers: [HR, CODE, ORDERED_LIST_ENTER],
})(editor)
);
return pluginManager;
diff --git a/docs/agent-guide/channels.md b/docs/agent-guide/channels.md
index 8ace6c91d1..90e6ff9373 100644
--- a/docs/agent-guide/channels.md
+++ b/docs/agent-guide/channels.md
@@ -378,6 +378,8 @@ Shift+Enter adds a line to the draft; Enter sends. The composer spaces its
paragraphs the way the sent message does, so a multi-line draft reads as what
it will send. Check a multi-line message against the draft that wrote it: the
spacing must not change on send.
+Typing `6.` then Enter (or `6. `) starts an ordered list at 6; the marker is
+not rewritten to `1.`
Both the expanded and collapsed composers start with a `+` button (`Add`). It
opens a menu on desktop and a bottom drawer on mobile: `Mention` (opens the `@` typeahead), `Attach files` (the file
picker; the iOS media picker on iOS), `GIF` (the same picker as `/gif`), then under `Create` the same actions as
diff --git a/docs/agent-guide/documents.md b/docs/agent-guide/documents.md
index ee957baf1a..6f05418315 100644
--- a/docs/agent-guide/documents.md
+++ b/docs/agent-guide/documents.md
@@ -2426,7 +2426,8 @@ nodes — use the snapshot itself to verify content. For formatting checks, run
`evaluate_script` over `[contenteditable] strong` etc.
Body placeholder advertises: `/` for block commands, `@` to reference files, `;` for snippets.
-Markdown auto-format works while typing (`#` heading, `[]` checklist, `>` quote).
+Markdown auto-format works while typing (`#` heading, `[]` checklist, `>` quote,
+`6.` or `6. ` for an ordered list that starts at 6).
Pasting multiple paragraphs inside a quote keeps those paragraphs quoted;
see [block formatting](channels.md#block-formatting) for verification.
Imported Markdown recognizes bare URLs with the same shared matcher as messages;
diff --git a/packages/lexical-core/AGENTS.md b/packages/lexical-core/AGENTS.md
index 17ff48a6d1..a71a54f731 100644
--- a/packages/lexical-core/AGENTS.md
+++ b/packages/lexical-core/AGENTS.md
@@ -31,6 +31,8 @@ composer imports the URL matcher from this package; do not duplicate it.
Keep URLs protected from inline formatting during import; matching rendered
text is too late. Preserve code, mention payloads, existing links, and escaped
literal URLs. Keep unlink state through both Markdown and Lexical JSON saves.
+`NodeReplacements` must copy `ListNode` start when wrapping as `TaskListNode`;
+dropping it resets every typed `6.` marker to `1.`
An image under a list item is a child of that `ListItemNode`. Lexical runs
element transformers only on top-level nodes, so `listItemImage` exports it as
diff --git a/packages/lexical-core/node-list.ts b/packages/lexical-core/node-list.ts
index df27a8a02b..19de868894 100644
--- a/packages/lexical-core/node-list.ts
+++ b/packages/lexical-core/node-list.ts
@@ -138,7 +138,8 @@ export const NodeReplacements: LexicalNodeReplacement[] = [
},
{
replace: ListNode,
- with: (node: ListNode) => new TaskListNode(node.getListType()),
+ with: (node: ListNode) =>
+ new TaskListNode(node.getListType(), node.getStart()),
withKlass: TaskListNode,
},
];
diff --git a/packages/lexical-core/tests/list-transformers.test.ts b/packages/lexical-core/tests/list-transformers.test.ts
index 367f5a4171..fe8a5d2f18 100644
--- a/packages/lexical-core/tests/list-transformers.test.ts
+++ b/packages/lexical-core/tests/list-transformers.test.ts
@@ -12,12 +12,19 @@ import {
type LexicalEditor,
} from 'lexical';
import { describe, expect, it } from 'vitest';
-import { SupportedNodeTypes } from '../node-list';
-import { CUSTOM_TRANSFORMERS } from '../transformers/customTransformers';
+import { NodeReplacements, SupportedNodeTypes } from '../node-list';
+import {
+ CUSTOM_TRANSFORMERS,
+ ORDERED_LIST_ENTER,
+} from '../transformers/customTransformers';
+import {
+ markdownToSerializedEditorStateWithIds,
+ serializedEditorStateToMarkdown,
+} from '../utils/markdown-state';
function makeEditor() {
return createEditor({
- nodes: SupportedNodeTypes,
+ nodes: [...SupportedNodeTypes, ...NodeReplacements],
onError: console.error,
});
}
@@ -42,7 +49,83 @@ function getCustomOrderedListTransformer(): ElementTransformer {
return transformer;
}
+function readOrderedList(editor: LexicalEditor) {
+ return editor.getEditorState().read(() => {
+ const [list] = $getRoot().getChildren();
+ expect($isListNode(list)).toBe(true);
+ if (!$isListNode(list)) {
+ throw new Error('Expected converted node to be an ordered list');
+ }
+ return {
+ listType: list.getListType(),
+ start: list.getStart(),
+ items: list.getChildren().map((item) => item.getTextContent()),
+ };
+ });
+}
+
describe('custom ordered-list transformer', () => {
+ it('keeps a non-1 start when replacing ListNode with TaskListNode', async () => {
+ const editor = makeEditor();
+
+ await update(editor, () => {
+ $getRoot()
+ .clear()
+ .append($createListNode('number', 6).append($createListItemNode()));
+ });
+
+ expect(readOrderedList(editor)).toEqual({
+ listType: 'number',
+ start: 6,
+ items: [''],
+ });
+ });
+
+ it('starts a new list at the typed marker', async () => {
+ const editor = makeEditor();
+
+ await update(editor, () => {
+ const paragraph = $createParagraphNode();
+ const transformer = getCustomOrderedListTransformer();
+ const match = '6. '.match(transformer.regExp);
+
+ if (!match) {
+ throw new Error('Expected ordered list marker to match');
+ }
+
+ $getRoot().clear().append(paragraph);
+ transformer.replace(paragraph, [$createTextNode('Reply')], match, false);
+ });
+
+ expect(readOrderedList(editor)).toEqual({
+ listType: 'number',
+ start: 6,
+ items: ['Reply'],
+ });
+ });
+
+ it('starts a list at the typed marker on Enter without a trailing space', async () => {
+ const editor = makeEditor();
+
+ await update(editor, () => {
+ const paragraph = $createParagraphNode();
+ const match = '6.'.match(ORDERED_LIST_ENTER.regExp);
+
+ if (!match) {
+ throw new Error('Expected bare ordered list marker to match');
+ }
+
+ $getRoot().clear().append(paragraph);
+ ORDERED_LIST_ENTER.replace(paragraph, [], match, false);
+ });
+
+ expect(readOrderedList(editor)).toEqual({
+ listType: 'number',
+ start: 6,
+ items: [''],
+ });
+ });
+
it('uses the incoming marker as the start when inserting before an ordered list', async () => {
const editor = makeEditor();
@@ -71,20 +154,22 @@ describe('custom ordered-list transformer', () => {
);
});
- editor.getEditorState().read(() => {
- const [list] = $getRoot().getChildren();
+ expect(readOrderedList(editor)).toEqual({
+ listType: 'number',
+ start: 1,
+ items: ['Incoming', 'Existing'],
+ });
+ });
- expect($isListNode(list)).toBe(true);
- if (!$isListNode(list)) {
- throw new Error('Expected converted node to be an ordered list');
- }
+ it('imports and exports a markdown list that starts after 1', () => {
+ const state = markdownToSerializedEditorStateWithIds('6. Reply');
+ const [list] = state.root.children;
- expect(list.getListType()).toBe('number');
- expect(list.getStart()).toBe(1);
- expect(list.getChildren().map((item) => item.getTextContent())).toEqual([
- 'Incoming',
- 'Existing',
- ]);
+ expect(list).toMatchObject({
+ type: 'task-list',
+ listType: 'number',
+ start: 6,
});
+ expect(serializedEditorStateToMarkdown(state)).toBe('6. Reply');
});
});
diff --git a/packages/lexical-core/transformers/customTransformers.ts b/packages/lexical-core/transformers/customTransformers.ts
index 3bff6664e0..1827259639 100644
--- a/packages/lexical-core/transformers/customTransformers.ts
+++ b/packages/lexical-core/transformers/customTransformers.ts
@@ -46,12 +46,20 @@ const customTransformer = (
};
};
+const orderedListTransformer = customTransformer(ORDERED_LIST);
+
+/** Enter on `6.` (no trailing space) still starts an ordered list at 6. */
+export const ORDERED_LIST_ENTER: ElementTransformer = {
+ ...orderedListTransformer,
+ regExp: /^(\s*)(\d{1,})\.$/,
+};
+
export const CUSTOM_TRANSFORMERS: Transformer[] = [
...HTML_TEXT_FORMAT_TRANSFORMERS,
...TRANSFORMERS.filter((t) => {
return t !== CHECK_LIST && t !== ORDERED_LIST && t !== UNORDERED_LIST;
}),
- customTransformer(ORDERED_LIST),
+ orderedListTransformer,
customTransformer(CHECK_LIST),
customTransformer(UNORDERED_LIST),
];
diff --git a/packages/lexical-core/transformers/index.ts b/packages/lexical-core/transformers/index.ts
index be446e17e8..e61a745146 100644
--- a/packages/lexical-core/transformers/index.ts
+++ b/packages/lexical-core/transformers/index.ts
@@ -61,6 +61,7 @@ import { UNKNOWN_MENTION } from './unknownMention';
import { I_VIDEO, VIDEO_LINK } from './video';
import { E_WATERMARK, I_WATERMARK } from './watermark';
+export { ORDERED_LIST_ENTER } from './customTransformers';
export { isConversionOnlyTransformer, protectEmptyParagraphLines };
/**