Skip to content

[Fix] Non-standard formatted tasklist items are not identified as tasklist items #3972

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

Merged
merged 7 commits into from
Nov 28, 2023
Merged

[Fix] Non-standard formatted tasklist items are not identified as tasklist items #3972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
66dd4ea
identify multiple spaces in tasklist items
iulia-b Nov 24, 2023
2e20461
Merge branch 'main' into iunia/misspaced-checkboxes
iulia-b Nov 24, 2023
ad9c47f
parity for whitespace support with classic experience
iulia-b Nov 28, 2023
8d676b5
Merge branch 'iunia/misspaced-checkboxes' of https://github.com/prime…
iulia-b Nov 28, 2023
10c0f45
Remove extra space
iulia-b Nov 28, 2023
5d8cc89
chore: add changeset
joshblack Nov 28, 2023
1aad0c1
Merge branch 'main' into iunia/misspaced-checkboxes
joshblack Nov 28, 2023
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/strong-swans-repeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Update MarkdownEditor to correctly identify non-standard formatted tasklist items
10 changes: 6 additions & 4 deletions src/drafts/MarkdownEditor/_useListEditing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ const calculateNextListItemStarter = ({leadingWhitespace = '', delimeter, taskBo
* 3. Task box (optional)
* 4. Everything following
*/
export const listItemRegex = /^(\s*)([*-]|(\d+)\.)\s(?:(\[[\sx]\])\s)?(.*)/i
export const listItemRegex = /^(\s*)([*-]|(\d+)\.)(\s{1,4})(?:(\[[\sx]\])\s)?(.*)/i

export type ListItem = {
leadingWhitespace: string
middleWhitespace: string
text: string
delimeter: '-' | '*' | number
taskBox: '[ ]' | '[x]' | null
Expand All @@ -45,22 +46,23 @@ const isNumericListItem = (item: ListItem | null): item is NumericListItem => ty
export const parseListItem = (line: string): ListItem | null => {
const result = listItemRegex.exec(line)
if (!result) return null
const [, leadingWhitespace = '', fullDelimeter, itemNumberStr = '', taskBox = null, text] = result
const [, leadingWhitespace = '', fullDelimeter, itemNumberStr = '', middleWhitespace, taskBox = null, text] = result
const itemNumber = Number.parseInt(itemNumberStr, 10)
const delimeter = Number.isNaN(itemNumber) ? (fullDelimeter as '*' | '-') : itemNumber

return {
leadingWhitespace,
text,
delimeter,
middleWhitespace,
taskBox: taskBox as '[ ]' | '[x]' | null,
}
}

export const listItemToString = (item: ListItem) =>
`${item.leadingWhitespace}${typeof item.delimeter === 'number' ? `${item.delimeter}.` : item.delimeter}${
item.taskBox ? ` ${item.taskBox}` : ''
} ${item.text}`
item.middleWhitespace
}${item.taskBox || ''} ${item.text}`

/**
* Provides support for list editing in the Markdown editor. This includes inserting new
Expand Down