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

Support ordered lists that don't start at 1 in fields.markdoc and fields.mdx #1278

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Support ordered lists that don't start at 1 in fields.markdoc and fields.mdx #1278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/honest-seahorses-whisper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@keystatic/core': patch
---

Support ordered lists that don't start at 1 in `fields.markdoc` and `fields.mdx`
6 changes: 4 additions & 2 deletions packages/keystatic/src/form/fields/markdoc/editor/inputrules/rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ export function inputRulesForSchema({ nodes, marks, config }: EditorSchema) {
}
if (nodes.ordered_list) {
rules.push({
pattern: /^\s*\d+(?:\.|\))\s$/,
handler: wrappingInputRuleHandler(nodes.ordered_list),
pattern: /^\s*(\d+)(?:\.|\))\s$/,
handler: wrappingInputRuleHandler(nodes.ordered_list, match => ({
start: parseInt(match[1], 10),
})),
});
}
if (nodes.unordered_list) {
Expand Down
8 changes: 7 additions & 1 deletion packages/keystatic/src/form/fields/markdoc/editor/markdoc/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,13 @@ function markdocNodeToProseMirrorNode(
? schema.nodes.ordered_list
: schema.nodes.unordered_list;
if (!listType) return notAllowed(node, parentType);
return createAndFill(node, listType, {});
return createAndFill(
node,
listType,
node.attributes.ordered && node.attributes.start !== undefined
? { start: node.attributes.start }
: {}
);
}
if (node.type === 'table') {
if (!schema.nodes.table) return notAllowed(node, parentType);
Expand Down
6 changes: 5 additions & 1 deletion packages/keystatic/src/form/fields/markdoc/editor/markdoc/serialize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,11 @@ export function proseMirrorToMarkdoc(
return new Ast.Node('item', {}, listItemContent);
}
if (node.type === schema.nodes.ordered_list) {
return new Ast.Node('list', { ordered: true }, blocks(node.content));
return new Ast.Node(
'list',
{ ordered: true, start: node.attrs.start },
blocks(node.content)
);
}
if (node.type === schema.nodes.unordered_list) {
return new Ast.Node('list', { ordered: false }, blocks(node.content));
Expand Down
6 changes: 5 additions & 1 deletion packages/keystatic/src/form/fields/markdoc/editor/mdx/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,11 @@ function markdocNodeToProseMirrorNode(
? schema.nodes.ordered_list
: schema.nodes.unordered_list;
if (!listType) return notAllowed(node, parentType);
return createAndFill(node, listType, {});
return createAndFill(
node,
listType,
node.ordered && node.start != null ? { start: node.start } : {}
);
}
if (node.type === 'table') {
if (!schema.nodes.table) return notAllowed(node, parentType);
Expand Down
1 change: 1 addition & 0 deletions packages/keystatic/src/form/fields/markdoc/editor/mdx/serialize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ function proseMirrorToMDX(
type: 'list',
ordered: true,
spread: false,
start: node.attrs.start,
children: mapContent(node, node => convertListItem(blocks(node.content))),
};
}
Expand Down
23 changes: 20 additions & 3 deletions packages/keystatic/src/form/fields/markdoc/editor/schema.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,26 @@ const nodeSpecs = {
ordered_list: {
content: 'list_item+',
group: 'block',
parseDOM: [{ tag: 'ol' }],
toDOM() {
return olDOM;
attrs: {
start: { default: 1 },
},
parseDOM: [
{
tag: 'ol',
getAttrs: node => {
if (typeof node === 'string') {
return false;
}
if (!(node instanceof HTMLOListElement) || node.start < 0) {
return { start: 1 };
}
return { start: node.start };
},
},
],
toDOM(node) {
if (node.attrs.start === 1) return olDOM;
return ['ol', { start: node.attrs.start }, 0];
},
insertMenu: {
label: 'Ordered list',
Expand Down
68 changes: 58 additions & 10 deletions packages/keystatic/src/form/fields/markdoc/editor/tests/lists.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,37 @@ test('ordered list shortcut', async () => {
await user.keyboard(' ');
expect(state()).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<cursor />
</paragraph>
</list_item>
</ordered_list>
</doc>
`);
});

test('ordered list shortcut with different start', async () => {
const { state, user } = renderEditor(
<doc>
<paragraph>
<text>
5.
<cursor />
</text>
</paragraph>
</doc>
);

await user.keyboard(' ');
expect(state()).toMatchInlineSnapshot(`
<doc>
<ordered_list
start={5}
>
<list_item>
<paragraph>
<cursor />
Expand Down Expand Up @@ -190,7 +220,9 @@ test('toggle list on empty line', async () => {

expect(state()).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<cursor />
Expand Down Expand Up @@ -219,7 +251,9 @@ test('toggle list on line with text', async () => {

expect(state()).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -252,7 +286,9 @@ test('toggle list on line with text with marks', async () => {

expect(state()).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -382,7 +418,9 @@ test('toggle ordered_list inside of multi-item ordered_list', async () => {

expect(state()).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand All @@ -397,7 +435,9 @@ test('toggle ordered_list inside of multi-item ordered_list', async () => {
<cursor />
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -572,7 +612,9 @@ test('backspace at start of list only unwraps the first item', async () => {
some text
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -788,7 +830,9 @@ test('changing the type of a nested list', async () => {
some text
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -846,14 +890,18 @@ test('changing the type of a nested list to something which it is nested inside'
top text
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
middle text
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down
17 changes: 16 additions & 1 deletion packages/keystatic/src/form/fields/markdoc/editor/tests/markdoc.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,9 @@ test('link in list', () => {
const editor = fromMarkdoc(markdoc);
expect(editor).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -690,3 +692,16 @@ test('undefined in conditional value', () => {
"
`);
});

test('ordered list with start', () => {
const markdoc = `5. a
1. b
1. c`;
const editor = fromMarkdoc(markdoc);
expect(toMarkdoc(editor)).toMatchInlineSnapshot(`
"5. a
1. b
1. c
"
`);
});
17 changes: 16 additions & 1 deletion packages/keystatic/src/form/fields/markdoc/editor/tests/mdx.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,9 @@ test('link in list', () => {
const editor = fromMDX(mdx);
expect(editor).toMatchInlineSnapshot(`
<doc>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -1032,3 +1034,16 @@ test('loose list', () => {
"
`);
});

test('ordered list with start', () => {
const mdx = `5. a
1. b
1. c`;
const editor = fromMDX(mdx);
expect(toMDX(editor)).toMatchInlineSnapshot(`
"5. a
6. b
7. c
"
`);
});
32 changes: 24 additions & 8 deletions packages/keystatic/src/form/fields/markdoc/editor/tests/pasting/from-other-editors.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,9 @@ test('confluence', async () => {
</unordered_list>
</list_item>
</unordered_list>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand All @@ -201,7 +203,9 @@ test('confluence', async () => {
item
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -435,7 +439,9 @@ there is a break before this</p>
</unordered_list>
</list_item>
</unordered_list>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand All @@ -449,7 +455,9 @@ there is a break before this</p>
item
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -604,7 +612,9 @@ test('dropbox paper', async () => {
</unordered_list>
</list_item>
</unordered_list>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand All @@ -618,7 +628,9 @@ test('dropbox paper', async () => {
item
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down Expand Up @@ -803,7 +815,9 @@ test('google docs', async () => {
</unordered_list>
</list_item>
</unordered_list>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand All @@ -817,7 +831,9 @@ test('google docs', async () => {
item
</text>
</paragraph>
<ordered_list>
<ordered_list
start={1}
>
<list_item>
<paragraph>
<text>
Expand Down
Loading
Loading