Major clean up and improvements to vimwiki compatibility and documentation.

Reviewed-on: #1

crates/nuwiki-lsp/tests/commands_lists.rs

@@ -1,4 +1,4 @@
-//! §13.1 Cluster A — list rewriters: `removeDone`, `renumber`,
+//! Cluster A — list rewriters: `removeDone`, `renumber`,
 //! `changeSymbol`, `changeLevel`.
 
 use nuwiki_core::ast::ListSymbol;
@@ -86,10 +86,10 @@ fn remove_done_returns_none_when_no_lists() {
 }
 
 #[test]
-fn remove_done_scoped_by_position_to_one_item() {
-    // With `position` set, only items whose line range contains the
-    // cursor line are considered. So a done item on line 1 is removed
-    // by cursor on line 1, but a done item on line 3 is left alone.
+fn remove_done_scoped_by_position_to_current_list() {
+    // With `position` set, the scope is the contiguous list block the
+    // cursor sits in — every done item in that list is removed, not just
+    // the one under the cursor.
     let src = "- [X] done one\n- [ ] todo\n- [X] done two\n";
     let ast = parse(src);
     let pos = Some(LspPosition {
@@ -98,7 +98,37 @@ fn remove_done_scoped_by_position_to_one_item() {
     });
     let edit = ops::remove_done_edit(src, &ast, &uri(), pos, true).expect("edit");
     let edits = &edit.changes.unwrap()[&uri()];
-    assert_eq!(edits.len(), 1, "only the line-0 item should match");
+    assert_eq!(edits.len(), 2, "both done items in the current list match");
+}
+
+#[test]
+fn remove_done_position_leaves_other_lists_untouched() {
+    // Two separate list blocks split by a paragraph. Cursor in the first
+    // list removes only that list's done items; the second list's done
+    // item survives.
+    let src = "- [X] done a\n- [ ] todo a\n\nparagraph\n\n- [ ] todo b\n- [X] done b\n";
+    let ast = parse(src);
+    let pos = Some(LspPosition {
+        line: 0,
+        character: 0,
+    });
+    let edit = ops::remove_done_edit(src, &ast, &uri(), pos, true).expect("edit");
+    let edits = &edit.changes.unwrap()[&uri()];
+    assert_eq!(edits.len(), 1, "only the first list's done item is removed");
+}
+
+#[test]
+fn remove_done_position_cascades_into_sublists() {
+    // The current-list scope includes nested sublists of the block.
+    let src = "- [ ] parent\n  - [X] done child\n  - [ ] open child\n";
+    let ast = parse(src);
+    let pos = Some(LspPosition {
+        line: 0,
+        character: 0,
+    });
+    let edit = ops::remove_done_edit(src, &ast, &uri(), pos, true).expect("edit");
+    let edits = &edit.changes.unwrap()[&uri()];
+    assert_eq!(edits.len(), 1, "the nested done child is removed");
 }
 
 // ===== renumber =====