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

Jump to bottom

"Unexpected failure to create a list item from line" warning when parsing "1)" style numbered list #3401

Closed
4 of 8 tasks
billga opened this issue Mar 30, 2025 · 11 comments · Fixed by #3402
Closed
4 of 8 tasks

"Unexpected failure to create a list item from line" warning when parsing "1)" style numbered list #3401

billga opened this issue Mar 30, 2025 · 11 comments · Fixed by #3402
Labels
priority: high A high priority/important request scope: parsing markdown See also 'scope: global filter' type: bug Something isn't working

Comments

@billga
Copy link

billga commented Mar 30, 2025

⚠️ Check issue is valid.

⚠️ Check that this issue hasn't been reported before.

Steps to reproduce

Obsidian Version 1.8.9 (Installer 1.7.7)
Tasks v7.18.4
other plug-ins that may interact: dataview, card-board

Steps:

  1. Obsidian and plug-ins loaded, dev console open
  2. Create a new note
  3. Type "1) " to trigger a numbered list
  4. See warning in the console "Unexpected failure to create a list item from line: 1) in file: Untitled.md
  5. Delete the "1) ", now type "1. " and see no warning

Expected Behavior

Probably shouldn't warn, but not sure what this is trying to tell us. Do lists with the "1)" format not get treated the same as "1." lists? Does it matter?

Current behaviour

Throws warning.

Which Operating Systems are you using?

  • Android
  • iPhone/iPad
  • Linux
  • macOS
  • Windows

Obsidian Version

1.8.9

Tasks Plugin Version

7.18.4

Checks

  • I have tried it with all other plugins disabled and the error still occurs

Possible solution

No response
@billga billga added the type: bug Something isn't working label Mar 30, 2025
@claremacrae
Copy link
Collaborator

claremacrae commented Mar 30, 2025 •
edited
Loading

The supported formats for Ordered lists are shown here:

https://help.obsidian.md/syntax#Lists

Valid:

1. x

Not valid documented:

1) x

@claremacrae
Copy link
Collaborator

I can reproduce the behaviour.

@claremacrae
Copy link
Collaborator

This is the relevant code:

obsidian-tasks/src/Obsidian/FileParser.ts

Lines 160 to 171 in 7f23e6c

private createListItem(listItem: ListItemCache, line: string, lineNumber: number, taskLocation: TaskLocation) {
const parentListItem = this.line2ListItem.get(listItem.parent) ?? null;
const newListItem = ListItem.fromListItemLine(line, parentListItem, taskLocation);
if (newListItem === null) {
// This should be unreachable.
this.logger.warn(
'Unexpected failure to create a list item from line: ' + line + ' in file: ' + this.filePath,
);
return;
}
this.line2ListItem.set(lineNumber, newListItem);
}

@claremacrae
Copy link
Collaborator

And yet it seems that Obsidian does actually recognise 1) as a list item, and even a checklist item:

Image

@claremacrae
Copy link
Collaborator

claremacrae commented Mar 30, 2025 •
edited
Loading

So the warning is because:

  1. The Obsidian cache has said 'There is a list item in the file, at a line beginning '1)`
  2. So the Tasks plugin tries reading the line, using a regular expression of known list item formats - which does not match 1)
  3. So the Tasks code is confused and writes a warning.

@claremacrae claremacrae added the scope: parsing markdown See also 'scope: global filter' label Mar 30, 2025
@claremacrae
Copy link
Collaborator

I've asked on Discord and learned:

  1. According to CommonMark spec both . and ) are valid markers
  2. According to Obsidian Flavored Markdown, Obsidian supports CommonMark

Therefore, the Tasks plugin needs to be adjusted to also support ordered list markers with ).

Many thanks for reporting this, @billga.

@claremacrae claremacrae moved this to 🏗 In progress in Tasks (Obsidian plugin) Roadmap Mar 30, 2025
@claremacrae claremacrae mentioned this issue Mar 30, 2025
Open
@claremacrae claremacrae added the priority: high A high priority/important request label Mar 30, 2025
claremacrae added a commit that referenced this issue Mar 30, 2025
@claremacrae
test: Add test data for #3401 - parsing 1) as list item
9cc77a0
claremacrae added a commit that referenced this issue Mar 30, 2025
@claremacrae
test: Add failing test for #3401 - parsing 1) as list item
1f23b95
claremacrae added a commit that referenced this issue Mar 30, 2025
@claremacrae
fix: Recognise '1) ' as a numbered list item.
a661bbb 
Fixes #3401
@claremacrae claremacrae mentioned this issue Mar 30, 2025
Merged
10 tasks
claremacrae added a commit that referenced this issue Mar 30, 2025
@claremacrae
Merge pull request #3402 from obsidian-tasks-group/fix-numbered-list-…
7a4ccaf 
…with-paren

fix: Support Check boxes and List Items in "1)"-style numbered lists

Fixes #3401
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Tasks (Obsidian plugin) Roadmap Mar 30, 2025
@claremacrae
Copy link
Collaborator

Hi @billga, many thanks for logging this. I learned something about CommonMark today...

I've pushed a fix, but won't be able to release it just yet, as we have a work-in-progress performance improvement that I don't feel is yet quite ready for release.

I'll add a note here when this is released.

@claremacrae
Copy link
Collaborator

In working on this, I found that any nested, numbered tasks or list items are ignored by Obsidian's list parsing, unless the first item starts at 0.

I logged it here:
https://forum.obsidian.md/t/incorrect-parsing-of-numbered-list-items-when-first-nested-item-number-is-not-1/98997

@billga
Copy link
Author

billga commented Mar 30, 2025

Thanks! I love the tasks plugin and appreciate you looking at this on a weekend

@claremacrae
Copy link
Collaborator

In working on this, I found that any nested, numbered tasks or list items are ignored by Obsidian's list parsing, unless the first item starts at 0.

I logged it here: https://forum.obsidian.md/t/incorrect-parsing-of-numbered-list-items-when-first-nested-item-number-is-not-1/98997

It's been moved to:

@claremacrae claremacrae marked this as a duplicate of #3404 Mar 31, 2025
@claremacrae claremacrae mentioned this issue Mar 31, 2025
Closed
8 tasks
@claremacrae claremacrae moved this from ✅ Done to 🎉 Released in Tasks (Obsidian plugin) Roadmap Apr 1, 2025
@claremacrae
Copy link
Collaborator

Just released:
https://github.com/obsidian-tasks-group/obsidian-tasks/releases/tag/7.18.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority: high A high priority/important request scope: parsing markdown See also 'scope: global filter' type: bug Something isn't working
Projects
Tasks (Obsidian plugin) Roadmap
Status: 🎉 Released
Milestone
No milestone
2 participants
@claremacrae @billga