Primitive functionality to display comment sections in outlines #571
Conversation
There was a problem hiding this comment.
Thanks for taking a look at this!
Regarding folding, see @juliasilge's comment in posit-dev/positron#4174 (comment). Have you looked at https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_foldingRange?
But I wonder if we can provide ranges both from the rules in our extension's json config, and from the LSP?
In any case, even without ranges it seems like a good progress on this issue.
crates/ark/src/lsp/symbols.rs
Outdated
| NodeType::BinaryOperator(BinaryOperatorType::LeftAssignment) | ||
| | NodeType::BinaryOperator(BinaryOperatorType::EqualsAssignment) | ||
| ) { | ||
| match index_assignment(node, contents, parent, symbols) { | ||
| Ok(handled) => { | ||
| if handled { | ||
| return Ok(true); | ||
| } | ||
| }, | ||
| } |
There was a problem hiding this comment.
Can you please make sure you're using +nightly for rustfmt? See
Line 8 in cac78eb
crates/ark/src/lsp/symbols.rs
Outdated
| } | ||
| } | ||
|
|
||
| // Existing code for indexing assignments or other nodes... |
There was a problem hiding this comment.
| // Existing code for indexing assignments or other nodes... |
| @@ -120,29 +120,73 @@ fn is_indexable(node: &Node) -> bool { | |||
| true | |||
| } | |||
|
|
|||
| // Function to parse a comment and return the section level and title | |||
| fn parse_comment_as_section(comment: &str) -> Option<(usize, String)> { | |||
There was a problem hiding this comment.
Can you please add some tests for this function?
|
|
||
| None | ||
| } | ||
|
|
||
| fn index_node( |
There was a problem hiding this comment.
Some tests are needed for this function too. You can do this to get a Rope and node:
let code = "my_code";
let document = Document::new(code, None);
let node = ast.root_node();
|
Hi @lionel-, thank you so much for the suggestions!! I have removed the line as per your suggestion and reformatted the code using +nightly. However, I'm really inexperienced with Rust (this is actually my first time writing Rust and I extensively used ChatGPT for this). I'm a bit struggling with the other suggestions. I'm not sure where do add the tests and how to add the the folding functionality. I have allowed edits by maintainers and would really appreciate if you can help/guide me through this because I personally really want this outline/folding functionality to work in Positron :) |
|
@kv9898 No worries, I've added a couple tests, feel free to add more from these examples. |
|
@lionel- Thank you so much for helping me out! I'm pretty happy with how it looks now! |
|
|
||
| None | ||
| } | ||
|
|
||
| fn index_node( | ||
| node: &Node, | ||
| contents: &Rope, |
There was a problem hiding this comment.
Meta comment
Looks like our indexer, which watches the whole "workspace" (i.e. multiple folders of files), also does something similar. i.e. see index_comment() there.
That indexer powers symbols() in this file, which powers workspace symbols. i.e. when you hit CMD + T then it pops up all the symbols in the workspace - even in closed files.
What we are changing here powers document symbols, i.e. symbols within a single document. This powers the Outline editor view we have been talking about, and it powers this Outline quick pick
It will eventually probably be good to merge all the infrastructure here. Ideally we'd have one set of code that we can run on a file that returns all its symbols, and then we map them into either a workspace symbol or document symbol (its essentially indexer::index_file() i think, but it doesn't know how to create nested outlines, which is important).
I don't think this should block anything, but we should keep this in mind and open an issue to merge all of this code
There was a problem hiding this comment.
That sounds very desirable! I would really appreciate the nested outline and foldable comment functionalities. Sadly, as a student primarily working on R-based data analysis projects, I'm new to Rust and unfamiliar with the ark and LSP architecture, I'm struggling to carry this out.
There was a problem hiding this comment.
We can take care of it!
|
|
||
| let symbol = DocumentSymbol { | ||
| name: title, // Use the title without the trailing '####' or '----' | ||
| kind: SymbolKind::STRING, // Treat it as a string section |
There was a problem hiding this comment.
I noticed that at the top of this file in symbols() we represent Sections with SymbolKind::MODULE.
I do think SymbolKind::STRING looks a little better, so could you please change MODULE to STRING to keep them in sync?
| fn parse_comment_as_section(comment: &str) -> Option<(usize, String)> { | ||
| // Match lines starting with one or more '#' followed by some non-empty content and must end with 4 or more '-', '#', or `=` | ||
| // Ensure that there's actual content between the start and the trailing symbols. | ||
| if let Some(caps) = indexer::RE_COMMENT_SECTION.captures(comment) { | ||
| let hashes = caps.get(1)?.as_str().len(); // Count the number of '#' | ||
| let title = caps.get(2)?.as_str().trim().to_string(); // Extract the title text without trailing punctuations | ||
| return Some((hashes, title)); // Return the level based on the number of '#' and the title | ||
| } | ||
|
|
||
| None | ||
| } |
There was a problem hiding this comment.
Here the function does return the number of hashes (level of comment). I wanted this to help with the foldable comments/nested outlines. But I struggled to get this to work.
|
Thanks a lot @kv9898! |
Attempt to (partly) fix posit-dev/positron#3822
I've managed to make comments which are in the shape of "## Title ####/----/====" appear in the outline with the changes in this pull request, but I struggled to make them appear in a hierarchical form/foldable.